App Service Environments - List App Service Plans

  • リファレンス
Service:
App Service
API Version:
2023-12-01

「App Service Environment内のすべてのApp Serviceプランを取得する」の説明。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms?api-version=2023-12-01

URI パラメーター

名前 / 必須 型 説明
name
 path True

string

App Service Environmentの名前。
resourceGroupName
 path True

string

リソースが属しているリソース グループの名前。

Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId
 path True

string

Azure のサブスクリプション ID。 これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-00000000000000)。
api-version
 query True

string

API バージョン

応答

名前 型 説明
200 OK

AppServicePlanCollection

OK
Other Status Codes

DefaultErrorResponse

エラー応答をApp Serviceします。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

Get all App Service plans in an App Service Environment.

Sample Request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/serverfarms?api-version=2023-12-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/serverfarms/test-asp",
      "name": "test-asp",
      "type": "Microsoft.Web/serverfarms",
      "kind": "app",
      "location": "Central US EUAP",
      "tags": {},
      "properties": {
        "workerTierName": null,
        "status": "Ready",
        "subscription": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
        "hostingEnvironmentProfile": {
          "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
          "name": "test-ase",
          "type": "Microsoft.Web/hostingEnvironments"
        },
        "maximumNumberOfWorkers": 100,
        "geoRegion": "Central US EUAP",
        "perSiteScaling": false,
        "elasticScaleEnabled": false,
        "maximumElasticWorkerCount": 0,
        "numberOfSites": 0,
        "isSpot": false,
        "spotExpirationTime": null,
        "freeOfferExpirationTime": null,
        "resourceGroup": "test-rg",
        "reserved": false,
        "isXenon": false,
        "hyperV": false,
        "targetWorkerCount": 1,
        "targetWorkerSizeId": 0,
        "provisioningState": null,
        "kubeEnvironmentProfile": null,
        "zoneRedundant": false
      },
      "sku": {
        "name": "I1",
        "tier": "Isolated",
        "size": "I1",
        "family": "I",
        "capacity": 0
      }
    }
  ],
  "nextLink": null
}

定義

名前 説明
AppServicePlan

App Service プラン。
AppServicePlanCollection

App Serviceプランのコレクション。
Capability

特定の SKU で許可される機能について説明します。
DefaultErrorResponse

エラー応答をApp Serviceします。
Details
Error

エラー モデル。
ExtendedLocation

拡張された場所。
HostingEnvironmentProfile

このリソースに使用するApp Service Environmentの仕様。
KubeEnvironmentProfile

このリソースに使用する Kubernetes 環境の仕様。
ProvisioningState

App Service Environmentのプロビジョニング状態。
SkuCapacity

App Serviceプランのスケール オプションの説明。
SkuDescription

スケーラブルなリソースの SKU の説明。
StatusOptions

プランの状態をApp Serviceします。

AppServicePlan

App Service プラン。

名前 型 既定値 説明
extendedLocation

ExtendedLocation

拡張された場所。
id

string

リソース ID。
kind

string

リソースの種類。
location

string

リソースの場所。
name

string

リソース名。
properties.elasticScaleEnabled

boolean

ServerFarm では ElasticScale がサポートされています。 このプランのアプリは、ServerFarm が ElasticPremium SKU であるかのようにスケーリングされます
properties.freeOfferExpirationTime

string

サーバー ファームの空きプランの有効期限が切れる時刻。
properties.geoRegion

string

App Service プランの地理的な場所。
properties.hostingEnvironmentProfile

HostingEnvironmentProfile

App Service プランに使用するApp Service Environmentの仕様。
properties.hyperV

boolean

False

Hyper-V コンテナー アプリ サービスプラン trueの場合は 。 false それ以外の場合は 。
properties.isSpot

boolean

の場合true、このApp Serviceプランはスポット インスタンスを所有します。
properties.isXenon

boolean

False

現在は使用されていません: Hyper-V コンテナー アプリ サービス プラン trueの場合は 。 false それ以外の場合は 。
properties.kubeEnvironmentProfile

KubeEnvironmentProfile

App Service プランに使用する Kubernetes Environment の仕様。
properties.maximumElasticWorkerCount

integer

この ElasticScaleEnabled App Service プランで許可されるワーカーの合計数の最大数
properties.maximumNumberOfWorkers

integer

このApp Service プランに割り当てることができるインスタンスの最大数。
properties.numberOfSites

integer

このApp Serviceプランに割り当てられているアプリの数。
properties.numberOfWorkers

integer

このApp Serviceプランに割り当てられているインスタンスの数。
properties.perSiteScaling

boolean

False

の場合true、このApp Serviceプランに割り当てられたアプリを個別にスケーリングできます。 の場合false、このApp Serviceプランに割り当てられたアプリは、プランのすべてのインスタンスにスケーリングされます。
properties.provisioningState

ProvisioningState

App Service プランのプロビジョニング状態。
properties.reserved

boolean

False

Linux App Service プラン trueの場合は 。 false それ以外の場合は 。
properties.resourceGroup

string

App Service プランのリソース グループ。
properties.spotExpirationTime

string

サーバー ファームの有効期限が切れる時刻。 スポット サーバー ファームの場合にのみ有効です。
properties.status

StatusOptions

プランの状態をApp Serviceします。
properties.subscription

string

プラン サブスクリプションApp Service。
properties.targetWorkerCount

integer

ワーカー数のスケーリング。
properties.targetWorkerSizeId

integer

ワーカー サイズ ID のスケーリング。
properties.workerTierName

string

App Service プランに割り当てられているターゲット worker レベル。
properties.zoneRedundant

boolean

False

の場合true、このApp Service プランは可用性ゾーンの分散を実行します。 の場合false、このApp Service プランは可用性ゾーンの分散を実行しません。
sku

SkuDescription

スケーラブルなリソースの SKU の説明。
tags

object

リソース タグ。
type

string

リソースの種類。

AppServicePlanCollection

App Serviceプランのコレクション。

名前 型 説明
nextLink

string

リソースの次のページへのリンク。
value

AppServicePlan[]

リソースのコレクション。

Capability

特定の SKU で許可される機能について説明します。

名前 型 説明
name

string

SKU 機能の名前。
reason

string

SKU 機能の理由。
value

string

SKU 機能の値。

DefaultErrorResponse

エラー応答をApp Serviceします。

名前 型 説明
error

Error

エラー モデル。

Details

名前 型 説明
code

string

プログラムによってエラーを識別するための標準化された文字列。
message

string

エラーの詳細な説明とデバッグ情報。
target

string

エラーの詳細な説明とデバッグ情報。

Error

エラー モデル。

名前 型 説明
code

string

プログラムによってエラーを識別するための標準化された文字列。
details

Details[]

詳細なエラー。
innererror

string

デバッグ エラーの詳細。
message

string

エラーの詳細な説明とデバッグ情報。
target

string

エラーの詳細な説明とデバッグ情報。

ExtendedLocation

拡張された場所。

名前 型 説明
name

string

拡張場所の名前。
type

string

拡張された場所の種類。

HostingEnvironmentProfile

このリソースに使用するApp Service Environmentの仕様。

名前 型 説明
id

string

App Service Environmentのリソース ID。
name

string

App Service Environmentの名前。
type

string

App Service Environmentのリソースの種類。

KubeEnvironmentProfile

このリソースに使用する Kubernetes 環境の仕様。

名前 型 説明
id

string

Kubernetes 環境のリソース ID。
name

string

Kubernetes 環境の名前。
type

string

Kubernetes 環境のリソースの種類。

ProvisioningState

App Service Environmentのプロビジョニング状態。

名前 型 説明
Canceled

string

Deleting

string

Failed

string

InProgress

string

Succeeded

string

SkuCapacity

App Serviceプランのスケール オプションの説明。

名前 型 説明
default

integer

このApp Serviceプラン SKU の既定のワーカー数。
elasticMaximum

integer

このApp Serviceプラン SKU の Elastic worker の最大数。
maximum

integer

このApp Serviceプラン SKU のワーカーの最大数。
minimum

integer

このApp Serviceプラン SKU の最小ワーカー数。
scaleType

string

App Service プランで使用できるスケール構成。

SkuDescription

スケーラブルなリソースの SKU の説明。

名前 型 説明
capabilities

Capability[]

SKU の機能 (たとえば、トラフィック マネージャーは有効ですか?
capacity

integer

リソースに割り当てられているインスタンスの現在の数。
family

string

リソース SKU のファミリ コード。
locations

string[]

SKU の場所。
name

string

リソース SKU の名前。
size

string

リソース SKU のサイズ指定子。
skuCapacity

SkuCapacity

SKU の最小、最大、および既定のスケール値。
tier

string

リソース SKU のサービス レベル。

StatusOptions

プランの状態をApp Serviceします。

名前 型 説明
Creating

string

Pending

string

Ready

string