App Service Plans - Get

참조

Service:: App Service

API Version:: 2023-12-01

App Service 계획 가져오기에 대한 설명입니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
name	path	True	string	App Service 플랜의 이름입니다.
resourceGroupName	path	True	string	리소스가 속한 리소스 그룹의 이름입니다. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Azure 구독 ID. GUID 형식 문자열입니다(예: 000000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	API 버전

응답

Name	형식	Description
200 OK	AppServicePlan	OK.
404 Not Found		찾을 수 없음
Other Status Codes	DefaultErrorResponse	오류 응답을 App Service.

보안

azure_auth

Azure Active Directory OAuth2 Flow

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

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

Get App Service plan

Sample Request

HTTP

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

Sample Response

Status code:: 200

{
  "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
  }
}

Status code:: 404

정의

Name	Description
AppServicePlan	App Service 계획
Capability	특정 SKU에 허용되는 기능/기능에 대해 설명합니다.
DefaultErrorResponse	오류 응답을 App Service.
Details
Error	오류 모델.
ExtendedLocation	확장된 위치입니다.
HostingEnvironmentProfile	이 리소스에 사용할 App Service Environment 대한 사양입니다.
KubeEnvironmentProfile	이 리소스에 사용할 Kubernetes 환경의 사양입니다.
ProvisioningState	App Service 계획의 프로비전 상태입니다.
SkuCapacity	App Service 계획 확장 옵션에 대한 설명입니다.
SkuDescription	확장 가능한 리소스에 대한 SKU에 대한 설명입니다.
StatusOptions	계획 상태 App Service.

AppServicePlan

App Service 계획

Name	형식	기본값	Description
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 컨테이너 앱 서비스 계획 `truefalse` 인 경우 이고, 그렇지 않으면 입니다.
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 앱 서비스 계획 `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 계획에 할당된 대상 작업자 계층입니다.
properties.zoneRedundant	boolean	False	이면 `true`이 App Service 계획은 가용성 영역 분산을 수행합니다. 이면 `false`이 App Service 계획은 가용성 영역 분산을 수행하지 않습니다.
sku	SkuDescription		확장 가능한 리소스에 대한 SKU에 대한 설명입니다.
tags	object		리소스 태그.
type	string		리소스 종류.

Capability

특정 SKU에 허용되는 기능/기능에 대해 설명합니다.

Name	형식	Description
name	string	SKU 기능의 이름입니다.
reason	string	SKU 기능의 이유입니다.
value	string	SKU 기능의 값입니다.

DefaultErrorResponse

오류 응답을 App Service.

Name	형식	Description
error	Error	오류 모델.

Details

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.

Error

오류 모델.

Name	형식	Description
code	string	프로그래밍 방식으로 오류를 식별하는 표준화된 문자열입니다.
details	Details[]	자세한 오류입니다.
innererror	string	디버그 오류에 대한 자세한 정보입니다.
message	string	자세한 오류 설명 및 디버깅 정보입니다.
target	string	자세한 오류 설명 및 디버깅 정보입니다.

ExtendedLocation

확장된 위치입니다.

Name	형식	Description
name	string	확장된 위치의 이름입니다.
type	string	확장된 위치의 유형입니다.

HostingEnvironmentProfile

이 리소스에 사용할 App Service Environment 대한 사양입니다.

Name	형식	Description
id	string	App Service Environment 리소스 ID입니다.
name	string	App Service Environment 이름입니다.
type	string	App Service Environment 리소스 종류입니다.

KubeEnvironmentProfile

이 리소스에 사용할 Kubernetes 환경의 사양입니다.

Name	형식	Description
id	string	Kubernetes Environment의 리소스 ID입니다.
name	string	Kubernetes Environment의 이름입니다.
type	string	Kubernetes Environment의 리소스 종류입니다.

ProvisioningState

App Service 계획의 프로비전 상태입니다.

Name	형식	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

SkuCapacity

App Service 계획 확장 옵션에 대한 설명입니다.

Name	형식	Description
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에 대한 설명입니다.

Name	형식	Description
capabilities	Capability[]	SKU의 기능(예: Traffic Manager가 사용하도록 설정되어 있나요?
capacity	integer	리소스에 할당된 현재 인스턴스 수입니다.
family	string	리소스 SKU의 패밀리 코드입니다.
locations	string[]	SKU의 위치입니다.
name	string	리소스 SKU의 이름입니다.
size	string	리소스 SKU의 크기 지정자입니다.
skuCapacity	SkuCapacity	SKU의 최소, 최대 및 기본 크기 조정 값입니다.
tier	string	리소스 SKU의 서비스 계층입니다.

StatusOptions

계획 상태 App Service.

Name	형식	Description
Creating	string
Pending	string
Ready	string