App Service Plans - Get

Ссылка

Service:: App Service

API Version:: 2023-12-01

Описание для получения плана Служба приложений.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя плана службы приложений.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой принадлежит ресурс. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	Идентификатор вашей подписки Azure. Это строка в формате GUID (например, 0000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Версия API

Ответы

Имя	Тип	Описание
200 OK	AppServicePlan	Все в порядке.
404 Not Found		Не найдено.
Other Status Codes	DefaultErrorResponse	Служба приложений ответ об ошибке.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory

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

Scopes

Имя	Описание
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

Определения

Имя	Описание
AppServicePlan	План службы приложений.
Capability	Описание возможностей и функций, разрешенных для определенного номера SKU.
DefaultErrorResponse	Служба приложений ответ об ошибке.
Details
Error	Модель ошибок.
ExtendedLocation	Расширенное расположение.
HostingEnvironmentProfile	Спецификация для Среда службы приложений, используемого для этого ресурса.
KubeEnvironmentProfile	Спецификация среды Kubernetes, используемой для этого ресурса.
ProvisioningState	Состояние подготовки плана Служба приложений.
SkuCapacity	Описание параметров масштабирования плана Служба приложений.
SkuDescription	Описание номера SKU для масштабируемого ресурса.
StatusOptions	Служба приложений состояние плана.

AppServicePlan

План службы приложений.

Имя	Тип	Значение по умолчанию	Описание
extendedLocation	ExtendedLocation		Расширенное расположение.
id	string		Идентификатор ресурса.
kind	string		Тип ресурса.
location	string		Расположение ресурса.
name	string		Имя ресурса.
properties.elasticScaleEnabled	boolean		ServerFarm поддерживает ElasticScale. Приложения в этом плане будут масштабироваться так, как если бы serverFarm был SKU ElasticPremium
properties.freeOfferExpirationTime	string		Время истечения срока действия бесплатного предложения фермы серверов.
properties.geoRegion	string		Географическое расположение плана Служба приложений.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile		Спецификация Среда службы приложений, используемая для плана Служба приложений.
properties.hyperV	boolean	False	Значение , если план `true`службы приложений контейнера Hyper-V , в `false` противном случае — значение .
properties.isSpot	boolean		Если `true`задано значение , этому Служба приложений Plan принадлежат точечные экземпляры.
properties.isXenon	boolean	False	Устарело: значение , если план `true`службы приложений контейнера Hyper-V , в `false` противном случае — значение .
properties.kubeEnvironmentProfile	KubeEnvironmentProfile		Спецификация среды Kubernetes, используемой для плана Служба приложений.
properties.maximumElasticWorkerCount	integer		Максимальное количество рабочих ролей, разрешенных для этого плана Служба приложений ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer		Максимальное число экземпляров, которые можно назначить этому Служба приложений плану.
properties.numberOfSites	integer		Количество приложений, назначенных этому плану Служба приложений.
properties.numberOfWorkers	integer		Количество экземпляров, назначенных этому Служба приложений плану.
properties.perSiteScaling	boolean	False	Если `true`задано значение , приложения, назначенные этому плану Служба приложений, можно масштабировать независимо друг от друга. Если `false`задано значение , приложения, назначенные этому Служба приложений плану, будут масштабироваться до всех экземпляров плана.
properties.provisioningState	ProvisioningState		Состояние подготовки плана Служба приложений.
properties.reserved	boolean	False	Значение , если план `true`службы приложений Linux , в `false` противном случае — значение .
properties.resourceGroup	string		Группа ресурсов плана Служба приложений.
properties.spotExpirationTime	string		Время истечения срока действия фермы серверов. Допустимо только в том случае, если это ферма точечного сервера.
properties.status	StatusOptions		Служба приложений состояние плана.
properties.subscription	string		Служба приложений подписку на план.
properties.targetWorkerCount	integer		Количество рабочих ролей масштабирования.
properties.targetWorkerSizeId	integer		Идентификатор размера рабочей роли масштабирования.
properties.workerTierName	string		Целевой уровень рабочей роли, назначенный плану Служба приложений.
properties.zoneRedundant	boolean	False	Если `true`задано значение , этот план Служба приложений выполнит балансировку зоны доступности. Если `false`задано значение , этот план Служба приложений не будет выполнять балансировку зоны доступности.
sku	SkuDescription		Описание номера SKU для масштабируемого ресурса.
tags	object		Теги ресурсов.
type	string		Тип ресурса.

Capability

Описание возможностей и функций, разрешенных для определенного номера SKU.

Имя	Тип	Описание
name	string	Имя возможности SKU.
reason	string	Причина возможности SKU.
value	string	Значение возможности SKU.

DefaultErrorResponse

Служба приложений ответ об ошибке.

Имя	Тип	Описание
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

Спецификация для Среда службы приложений, используемого для этого ресурса.

Имя	Тип	Описание
id	string	Идентификатор ресурса Среда службы приложений.
name	string	Имя Среда службы приложений.
type	string	Тип ресурса Среда службы приложений.

KubeEnvironmentProfile

Спецификация среды Kubernetes, используемой для этого ресурса.

Имя	Тип	Описание
id	string	Идентификатор ресурса среды Kubernetes.
name	string	Имя среды Kubernetes.
type	string	Тип ресурса среды Kubernetes.

ProvisioningState

Состояние подготовки плана Служба приложений.

Имя	Тип	Описание
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

SkuCapacity

Описание параметров масштабирования плана Служба приложений.

Имя	Тип	Описание
default	integer	Число рабочих ролей по умолчанию для этого Служба приложений SKU плана.
elasticMaximum	integer	Максимальное количество эластичных рабочих ролей для этого номера SKU плана Служба приложений.
maximum	integer	Максимальное число рабочих ролей для этого Служба приложений SKU плана.
minimum	integer	Минимальное количество рабочих ролей для этого Служба приложений SKU плана.
scaleType	string	Доступные конфигурации масштабирования для плана Служба приложений.

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

Служба приложений состояние плана.

Имя	Тип	Описание
Creating	string
Pending	string
Ready	string