Cloud Service Roles - Get

Служба:

Compute

Версия API:

2024-11-04

Получает роль из облачного сервиса.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}/roles/{roleName}?api-version=2024-11-04

Параметры URI

Имя	В	Обязательно	Тип	Описание
cloudServiceName	path	True	string	Имя облачной службы.
resourceGroupName	path	True	string	Имя группы ресурсов.
roleName	path	True	string	Имя роли.
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно определяют подписку Microsoft Azure. Идентификатор подписки входит в состав URI для каждого вызова службы.
api-version	query	True	string	Версия клиентского API.

Ответы

Имя	Тип	Описание
200 OK	CloudServiceRole	ХОРОШО
Other Status Codes	CloudError	Ошибка

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

azure_auth

Azure Active Directory OAuth2 Flow.

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

Области

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

Примеры

Get Cloud Service Role

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

HTTP

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roles/{role-name}?api-version=2024-11-04

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

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

200

{
  "name": "{role-name}",
  "id": "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Compute/cloudServices/{cs-name}/roles/{role-name}",
  "type": "Microsoft.Compute/cloudServices/roles",
  "location": "eastus2euap",
  "sku": {
    "name": "Standard_D1_v2",
    "tier": "Standard",
    "capacity": 2
  },
  "properties": {
    "uniqueId": "b03bc269-766b-4921-b91a-7dffaae4d03b:{role-name}"
  }
}

Определения

Имя	Описание
ApiError	Ошибка API.
ApiErrorBase	База ошибок API.
CloudError	Ответ об ошибке от службы вычислений.
CloudServiceRole	Описывает роль облачной службы.
CloudServiceRoleProperties	Свойства роли облачной службы.
CloudServiceRoleSku	Описывает номер SKU роли облачной службы.
InnerError	Сведения о внутренней ошибке.

ApiError

Объект

Ошибка API.

Имя	Тип	Описание
code	string	Код ошибки.
details	ApiErrorBase[]	Сведения об ошибке Api
innererror	InnerError	Внутренняя ошибка Api
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

ApiErrorBase

Объект

База ошибок API.

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сообщение об ошибке.
target	string	Целевой объект конкретной ошибки.

CloudError

Объект

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

Имя	Тип	Описание
error	ApiError	Ошибка API.

CloudServiceRole

Объект

Описывает роль облачной службы.

Имя	Тип	Описание
id	string	Идентификатор ресурса
location	string	Расположение ресурса
name	string	Имя ресурса
properties	CloudServiceRoleProperties	Свойства роли облачной службы.
sku	CloudServiceRoleSku	Описывает номер SKU роли облачной службы.
type	string	Тип ресурса

CloudServiceRoleProperties

Объект

Свойства роли облачной службы.

Имя	Тип	Описание
uniqueId	string	Указывает идентификатор, который однозначно идентифицирует роль облачной службы.

CloudServiceRoleSku

Объект

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

Имя	Тип	Описание
capacity	integer (int64)	Указывает количество экземпляров ролей в облачной службе.
name	string	Имя SKU. ПРИМЕЧАНИЕ. Если новый номер SKU не поддерживается на оборудовании облачной службы в настоящее время, необходимо удалить и повторно создать облачную службу или вернуться к старому номеру SKU.
tier	string	Указывает уровень облачной службы. Возможные значения Стандарт Basic

InnerError

Объект

Сведения о внутренней ошибке.

Имя	Тип	Описание
errordetail	string	Внутреннее сообщение об ошибке или дамп исключений.
exceptiontype	string	Тип исключения.