App Service Plans - Get

Служба:: App Service

Версия API:: 2025-05-01

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

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Название плана App Service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string (uuid)	Идентификатор целевой подписки. Значение должно быть Универсальным Уникальным Идентификатором (UUID).
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

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

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

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get App Service plan

Образец запроса

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


/**
 * Samples for AppServicePlans GetByResourceGroup.
 */
public final class Main {
    /*
     * x-ms-original-file: 2025-05-01/GetAppServicePlan.json
     */
    /**
     * Sample code: Get App Service plan.
     * 
     * @param manager Entry point to AppServiceManager.
     */
    public static void getAppServicePlan(com.azure.resourcemanager.appservice.AppServiceManager manager) {
        manager.serviceClient().getAppServicePlans().getByResourceGroupWithResponse("testrg123", "testsf6141",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v6"
)

// Generated from example definition: 2025-05-01/GetAppServicePlan.json
func ExamplePlansClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewPlansClient().Get(ctx, "testrg123", "testsf6141", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res = armappservice.PlansClientGetResponse{
	// 	Plan: &armappservice.Plan{
	// 		Name: to.Ptr("testsf6141"),
	// 		Type: to.Ptr("Microsoft.Web/serverfarms"),
	// 		ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141"),
	// 		Kind: to.Ptr("app"),
	// 		Location: to.Ptr("East US"),
	// 		Properties: &armappservice.PlanProperties{
	// 			GeoRegion: to.Ptr("East US"),
	// 			IsSpot: to.Ptr(false),
	// 			MaximumNumberOfWorkers: to.Ptr[int32](20),
	// 			NumberOfSites: to.Ptr[int32](4),
	// 			NumberOfWorkers: to.Ptr[int32](19),
	// 			ProvisioningState: to.Ptr(armappservice.ProvisioningStateSucceeded),
	// 			Reserved: to.Ptr(false),
	// 			Status: to.Ptr(armappservice.StatusOptionsReady),
	// 			TargetWorkerCount: to.Ptr[int32](0),
	// 			TargetWorkerSizeID: to.Ptr[int32](0),
	// 		},
	// 		SKU: &armappservice.SKUDescription{
	// 			Name: to.Ptr("P1"),
	// 			Capacity: to.Ptr[int32](1),
	// 			Family: to.Ptr("P"),
	// 			Size: to.Ptr("P1"),
	// 			Tier: to.Ptr("Premium"),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Пример ответа

Код состояния:: 200

{
  "name": "testsf6141",
  "type": "Microsoft.Web/serverfarms",
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141",
  "kind": "app",
  "location": "East US",
  "properties": {
    "geoRegion": "East US",
    "isSpot": false,
    "maximumNumberOfWorkers": 20,
    "numberOfSites": 4,
    "numberOfWorkers": 19,
    "provisioningState": "Succeeded",
    "reserved": false,
    "status": "Ready",
    "targetWorkerCount": 0,
    "targetWorkerSizeId": 0
  },
  "sku": {
    "name": "P1",
    "capacity": 1,
    "family": "P",
    "size": "P1",
    "tier": "Premium"
  }
}

Код состояния:: 404

Определения

Имя	Описание
AppServicePlan	плана службы приложений.
Capability	Описывает возможности и функции, разрешенные для определенного номера SKU.
createdByType	Тип удостоверения, создавшего ресурс.
DefaultErrorResponse	Ответ об ошибке службы приложений.
DefaultErrorResponseError	Модель ошибок.
DefaultErrorResponseErrorDetailsItem	Подробные ошибки.
DefaultIdentity
ExtendedLocation	Расширенное расположение.
HostingEnvironmentProfile	Спецификация среды службы приложений, используемой для этого ресурса.
InstallScript	Настройка скрипта установки фермы серверов.
InstallScriptSource	Объект для хранения ссылки на скрипт установки.
InstallScriptType	Тип скрипта установки.
KeyVaultReferenceWithStatus	Объект для хранения ссылки на хранилище ключей и состояние разрешения
KubeEnvironmentProfile	Спецификация среды Kubernetes, используемой для этого ресурса.
ManagedServiceIdentity	Управляемое удостоверение службы.
ManagedServiceIdentityType	Тип управляемого удостоверения службы.
ProvisioningState	Состояние подготовки плана службы приложений.
RegistryAdapter	Конфигурация адаптера реестра фермы серверов.
RegistryAdapterType	Тип адаптера реестра.
ServerFarmNetworkSettings	Параметры сети для плана службы приложений.
SkuCapacity	Описание вариантов масштабирования плана службы приложений.
SkuDescription	Описание номера SKU для масштабируемого ресурса.
StatusOptions	Состояние плана службы приложений.
StorageMount	Конфигурация подключения хранилища фермы серверов.
StorageMountType	Тип крепления для накопителя.
systemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
UserAssignedIdentity	Удостоверение, назначенное пользователем.

AppServicePlan

Объект

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

Имя	Тип	Описание
extendedLocation	ExtendedLocation	Расширенное расположение.
id	string (arm-id)	Полный идентификатор ресурса для ресурса. Например, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
identity	ManagedServiceIdentity	Управляемое удостоверение службы.
kind	string	Тип ресурса. Если ресурс является приложением, можно обратиться к https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference подробные поддерживаемые значения для типа.
location	string	Географическое расположение, в котором находится ресурс
name	string	Имя ресурса
properties.asyncScalingEnabled	boolean	В случае `true`, этот план службы приложений попытается асинхронно масштабироваться, если для синхронного масштабирования недостаточно рабочих ролей. В случае `false`, этот план службы приложений будет только пытаться масштабирования синхронизации.
properties.elasticScaleEnabled	boolean	ServerFarm поддерживает ElasticScale. Приложения в этом плане масштабируются, как если бы серверНый Фарм был SKU ElasticPremium
properties.freeOfferExpirationTime	string (date-time)	Время истечения срока действия бесплатного предложения фермы серверов.
properties.geoRegion	string	Географическое расположение для плана службы приложений.
properties.hostingEnvironmentProfile	HostingEnvironmentProfile	Спецификация среды службы приложений, используемая для плана службы приложений.
properties.hyperV	boolean	Если Hyper-V контейнерное приложение, план `true`службы, `false` в противном случае.
properties.installScripts	InstallScript[]	Установите скрипты, связанные с этим планом службы приложений.
properties.isCustomMode	boolean	Находится ли данная ферма серверов в пользовательском режиме.
properties.isSpot	boolean	Если `true`, этот план службы приложений владеет спотовыми экземплярами.
properties.isXenon	boolean	Устарело: если Hyper-V план `true`службы контейнерного приложения, `false` в противном случае.
properties.kubeEnvironmentProfile	KubeEnvironmentProfile	Спецификация среды Kubernetes, используемой для плана службы приложений.
properties.maximumElasticWorkerCount	integer (int32)	Максимальное количество рабочих ролей, разрешенных для этого плана службы приложений ElasticScaleEnabled
properties.maximumNumberOfWorkers	integer (int32)	Максимальное количество экземпляров, которые могут быть назначены этому плану службы приложений.
properties.network	ServerFarmNetworkSettings	Все сетевые настройки для фермы серверов.
properties.numberOfSites	integer (int32)	Количество приложений, назначенных этому плану службы приложений.
properties.numberOfWorkers	integer (int32)	Количество экземпляров, назначенных этому плану службы приложений.
properties.perSiteScaling	boolean	Если `true`, приложения, назначенные этому плану службы приложений, можно масштабировать независимо. Если `false`, приложения, назначенные этому плану службы приложений, будут масштабироваться для всех экземпляров плана.
properties.planDefaultIdentity	DefaultIdentity	Идентификация для использования платформой для различных функций и интеграций с помощью управляемой идентификации.
properties.provisioningState	ProvisioningState	Состояние подготовки плана службы приложений.
properties.rdpEnabled	boolean	Если `true`, доступ к RDP включен для этого плана службы приложений. Применимо только для ASP IsCustomMode. Если `false`, доступ к RDP отключен.
properties.registryAdapters	RegistryAdapter[]	Адаптеры реестра, связанные с этим планом службы приложений.
properties.reserved	boolean	Если план `true`обслуживания приложения Linux, `false` в противном случае.
properties.resourceGroup	string	Группа ресурсов плана службы приложений.
properties.spotExpirationTime	string (date-time)	Время истечения срока действия фермы серверов. Допустимо только в том случае, если это точечный ферма серверов.
properties.status	StatusOptions	Состояние плана службы приложений.
properties.storageMounts	StorageMount[]	Подключения к хранилищу, связанные с этим планом службы приложений.
properties.subscription	string	Подписка на план службы приложений.
properties.targetWorkerCount	integer (int32)	Масштабирование числа рабочих ролей.
properties.targetWorkerSizeId	integer (int32)	Масштабирование идентификатора размера рабочей роли.
properties.workerTierName	string	Целевой рабочий уровень, назначенный плану службы приложений.
properties.zoneRedundant	boolean	Если `true`, этот план службы приложений будет выполнять балансировку зоны доступности. В случае `false`, этот план службы приложений не будет выполнять балансировку зоны доступности.
sku	SkuDescription	Описание номера SKU для масштабируемого ресурса.
systemData	systemData	Метаданные Azure Resource Manager, содержащие данные createdBy и modifiedBy.
tags	object	Теги ресурсов.
type	string	Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

Capability

Объект

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

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

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DefaultErrorResponse

Объект

Ответ об ошибке службы приложений.

Имя	Тип	Описание
error	DefaultErrorResponseError	Модель ошибок.

DefaultErrorResponseError

Объект

Модель ошибок.

Имя	Тип	Описание
code	string	Стандартизированная строка для программной идентификации ошибки.
details	DefaultErrorResponseErrorDetailsItem[]	Подробные ошибки.
innererror	string	Дополнительная информация об ошибке отладки.
message	string	Подробное описание ошибки и информация об отладке.
target	string	Подробное описание ошибки и информация об отладке.

DefaultErrorResponseErrorDetailsItem

Объект

Подробные ошибки.

Имя	Тип	Описание
code	string	Стандартизированная строка для программной идентификации ошибки.
message	string	Подробное описание ошибки и информация об отладке.
target	string	Подробное описание ошибки и информация об отладке.

DefaultIdentity

Объект

Имя	Тип	Описание
identityType	ManagedServiceIdentityType	Тип управляемого удостоверения службы.
userAssignedIdentityResourceId	string

ExtendedLocation

Объект

Расширенное расположение.

Имя	Тип	Описание
name	string	Имя расширенного расположения.
type	string	Тип расширенной локации.

HostingEnvironmentProfile

Объект

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

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

InstallScript

Объект

Настройка скрипта установки фермы серверов.

Имя	Тип	Описание
name	string	Имя скрипта установки.
source	InstallScriptSource	Исходный код скрипта установки.

InstallScriptSource

Объект

Объект для хранения ссылки на скрипт установки.

Имя	Тип	Описание
sourceUri	string	Исходный URI сценария установки, из которого будет получен файл сценария установки.
type	InstallScriptType	Тип скрипта установки.

InstallScriptType

Перечисление

Тип скрипта установки.

Значение	Описание
RemoteAzureBlob
PlatformStorage

KeyVaultReferenceWithStatus

Объект

Объект для хранения ссылки на хранилище ключей и состояние разрешения

Имя	Тип	Описание
referenceStatus	string	Ссылочный статус секрета хранилища ключей.
secretUri	string	URI секрета хранилища ключей.

KubeEnvironmentProfile

Объект

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

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

ManagedServiceIdentity

Объект

Управляемое удостоверение службы.

Имя	Тип	Описание
principalId	string	Идентификатор участника удостоверения управляемой службы.
tenantId	string	Клиент удостоверения управляемой службы.
type	ManagedServiceIdentityType	Тип управляемого удостоверения службы.
userAssignedIdentities	<string, UserAssignedIdentity>	Список назначенных пользователем удостоверений, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

Перечисление

Тип управляемого удостоверения службы.

Значение	Описание
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned
None

ProvisioningState

Перечисление

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

Значение	Описание
Succeeded
Failed
Canceled
InProgress
Deleting

RegistryAdapter

Объект

Конфигурация адаптера реестра фермы серверов.

Имя	Тип	Описание
keyVaultSecretReference	KeyVaultReferenceWithStatus	Ссылка Key Vault на значение, которое будет размещено в расположении реестра
registryKey	string	Раздел реестра для адаптера.
type	RegistryAdapterType	Тип адаптера реестра.

RegistryAdapterType

Перечисление

Тип адаптера реестра.

Значение	Описание
Binary
String
Expand_String
Multi_String
DWord
QWord

ServerFarmNetworkSettings

Объект

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

Имя	Тип	Описание
virtualNetworkSubnetId	string	Идентификатор Azure Resource Manager виртуальной сети и подсети для присоединения к региональной виртуальной сети. Это должно иметь форму /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

SkuCapacity

Объект

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

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

SkuDescription

Объект

Описание номера SKU для масштабируемого ресурса.

Имя	Тип	Описание
capabilities	Capability[]	Возможности номера SKU, например, включен ли диспетчер трафика?
capacity	integer (int32)	Текущее число экземпляров, назначенных ресурсу.
family	string	Семейный код номера SKU ресурса.
locations	string[]	Расположения номера SKU.
name	string	Имя SKU ресурса.
size	string	Описатель размера номера SKU ресурса.
skuCapacity	SkuCapacity	Минимальное, максимальное и стандартное значения масштабирования номера SKU.
tier	string	Уровень служб SKU ресурса.

StatusOptions

Перечисление

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

Значение	Описание
Ready
Pending
Creating

StorageMount

Объект

Конфигурация подключения хранилища фермы серверов.

Имя	Тип	Описание
credentialsKeyVaultReference	KeyVaultReferenceWithStatus	KV ссылается на учетные данные для подключения к общей папке.
destinationPath	string	Путь к воркеру, куда будет смонтировано хранилище.
name	string	Имя крепления для накопителя.
source	string	Источник файлового ресурса/хранилища.
type	StorageMountType	Тип крепления для накопителя.

StorageMountType

Перечисление

Тип крепления для накопителя.

Значение	Описание
AzureFiles
LocalStorage
FileShare

systemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

UserAssignedIdentity

Объект

Удостоверение, назначенное пользователем.

Имя	Тип	Описание
clientId	string	Идентификатор клиента назначаемого пользователем удостоверения
principalId	string	Идентификатор участника назначаемого пользователем удостоверения

Поделиться через

App Service Plans - Get

Параметры URI

Ответы

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

azure_auth

Области

Примеры

Get App Service plan

Образец запроса

Пример ответа

Определения

AppServicePlan

Capability

createdByType

DefaultErrorResponse

DefaultErrorResponseError

DefaultErrorResponseErrorDetailsItem

DefaultIdentity

ExtendedLocation

HostingEnvironmentProfile

InstallScript

InstallScriptSource

InstallScriptType

KeyVaultReferenceWithStatus

KubeEnvironmentProfile

ManagedServiceIdentity

ManagedServiceIdentityType

ProvisioningState

RegistryAdapter

RegistryAdapterType

ServerFarmNetworkSettings

SkuCapacity

SkuDescription

StatusOptions

StorageMount

StorageMountType

systemData

UserAssignedIdentity