App Service Plans - Get
「App Service プランを取得する」の説明。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}?api-version=2023-12-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
name
|
path | True |
string |
App Service プランの名前です。 |
resource
|
path | True |
string |
リソースが属しているリソース グループの名前。 正規表現パターン: |
subscription
|
path | True |
string |
Azure のサブスクリプション ID。 これは GUID 形式の文字列です (たとえば、000000000-0000-0000-0000-000000000000000000000000000000000000000000000000000000000000、 |
api-version
|
query | True |
string |
API バージョン |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK です。 |
|
404 Not Found |
見つかりません。 |
|
Other Status Codes |
エラー応答をApp Serviceします。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Get App Service plan
要求のサンプル
応答のサンプル
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141",
"name": "testsf6141",
"type": "Microsoft.Web/serverfarms",
"kind": "app",
"location": "East US",
"properties": {
"status": "Ready",
"maximumNumberOfWorkers": 20,
"numberOfWorkers": 19,
"geoRegion": "East US",
"numberOfSites": 4,
"isSpot": false,
"reserved": false,
"targetWorkerCount": 0,
"targetWorkerSizeId": 0,
"provisioningState": "Succeeded"
},
"sku": {
"name": "P1",
"tier": "Premium",
"size": "P1",
"family": "P",
"capacity": 1
}
}
定義
名前 | 説明 |
---|---|
App |
App Service プラン。 |
Capability |
特定の SKU で許可される機能について説明します。 |
Default |
エラー応答をApp Serviceします。 |
Details | |
Error |
エラー モデル。 |
Extended |
拡張された場所。 |
Hosting |
このリソースに使用するApp Service Environmentの仕様。 |
Kube |
このリソースに使用する Kubernetes Environment の仕様。 |
Provisioning |
App Service プランのプロビジョニング状態。 |
Sku |
App Serviceプランスケールオプションの説明。 |
Sku |
スケーラブルなリソースの SKU の説明。 |
Status |
プランの状態をApp Serviceします。 |
AppServicePlan
App Service プラン。
名前 | 型 | 規定値 | 説明 |
---|---|---|---|
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 |
App Serviceプランに使用するApp Service Environmentの仕様。 |
||
properties.hyperV |
boolean |
False |
Hyper-V コンテナー アプリ サービスプラン |
properties.isSpot |
boolean |
の場合 |
|
properties.isXenon |
boolean |
False |
現在は使用されていません。Hyper-V コンテナー アプリ サービスプラン |
properties.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 |
の場合 |
properties.provisioningState |
App Service プランのプロビジョニング状態。 |
||
properties.reserved |
boolean |
False |
Linux App Service プラン |
properties.resourceGroup |
string |
App Service プランのリソース グループ。 |
|
properties.spotExpirationTime |
string |
サーバー ファームの有効期限が切れる時刻。 スポット サーバー ファームの場合にのみ有効です。 |
|
properties.status |
プランの状態をApp Serviceします。 |
||
properties.subscription |
string |
プラン サブスクリプションApp Serviceします。 |
|
properties.targetWorkerCount |
integer |
ワーカー数のスケーリング。 |
|
properties.targetWorkerSizeId |
integer |
ワーカー サイズ ID のスケーリング。 |
|
properties.workerTierName |
string |
App Service プランに割り当てられたターゲット ワーカー層。 |
|
properties.zoneRedundant |
boolean |
False |
の場合 |
sku |
スケーラブルなリソースの SKU の説明。 |
||
tags |
object |
リソース タグ。 |
|
type |
string |
リソースの種類。 |
Capability
特定の SKU で許可される機能について説明します。
名前 | 型 | 説明 |
---|---|---|
name |
string |
SKU 機能の名前。 |
reason |
string |
SKU 機能の理由。 |
value |
string |
SKU 機能の値。 |
DefaultErrorResponse
エラー応答をApp Serviceします。
名前 | 型 | 説明 |
---|---|---|
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 Environment の仕様。
名前 | 型 | 説明 |
---|---|---|
id |
string |
Kubernetes Environment のリソース ID。 |
name |
string |
Kubernetes 環境の名前。 |
type |
string |
Kubernetes Environment のリソースの種類。 |
ProvisioningState
App Service プランのプロビジョニング状態。
名前 | 型 | 説明 |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
SkuCapacity
App Serviceプランスケールオプションの説明。
名前 | 型 | 説明 |
---|---|---|
default |
integer |
このApp Serviceプラン SKU の既定のワーカー数。 |
elasticMaximum |
integer |
このApp Serviceプラン SKU のエラスティック ワーカーの最大数。 |
maximum |
integer |
このApp Serviceプラン SKU のワーカーの最大数。 |
minimum |
integer |
このApp Serviceプラン SKU のワーカーの最小数。 |
scaleType |
string |
App Service プランで使用可能なスケール構成。 |
SkuDescription
スケーラブルなリソースの SKU の説明。
名前 | 型 | 説明 |
---|---|---|
capabilities |
SKU の機能 (たとえば、トラフィック マネージャーは有効ですか? |
|
capacity |
integer |
リソースに割り当てられているインスタンスの現在の数。 |
family |
string |
リソース SKU のファミリ コード。 |
locations |
string[] |
SKU の場所。 |
name |
string |
リソース SKU の名前。 |
size |
string |
リソース SKU のサイズ指定子。 |
skuCapacity |
SKU の最小、最大、および既定のスケール値。 |
|
tier |
string |
リソース SKU のサービス レベル。 |
StatusOptions
プランの状態をApp Serviceします。
名前 | 型 | 説明 |
---|---|---|
Creating |
string |
|
Pending |
string |
|
Ready |
string |