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

Group - Get

  • Ссылка
Служба:
API Management
Версия API:
2024-05-01

Возвращает сведения о группе, указанной идентификатором.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2024-05-01

Параметры URI

Имя В Обязательно Тип Описание
groupId
 path True

string

minLength: 1
maxLength: 256

Идентификатор группы. Должен быть уникальным в текущем экземпляре службы управления API.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Имя группы ресурсов. Имя не учитывает регистр.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

Имя службы управления API.
subscriptionId
 path True

string (uuid)

Идентификатор целевой подписки. Значение должно быть UUID.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.

Ответы

Имя Тип Описание
200 OK

GroupContract

Текст ответа содержит указанную сущность группы.

Заголовки

ETag: string
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementGetGroup

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

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9?api-version=2024-05-01

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

Код состояния:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "59306a29e4bbd510dc24e5f9",
  "properties": {
    "displayName": "AwesomeGroup (samiraad.onmicrosoft.com)",
    "description": "awesome group of people",
    "builtIn": false,
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca"
  }
}

Определения

Имя Описание
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Ответ на ошибку
GroupContract

Сведения о контракте.
GroupType

Тип группы.

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

GroupContract

Object

Сведения о контракте.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.builtIn

boolean

значение true, если группа является одной из трех системных групп (администраторы, разработчики или гости); в противном случае значение false.
properties.description

string

maxLength: 1000

Описание группы. Может содержать теги форматирования HTML.
properties.displayName

string

minLength: 1
maxLength: 300

Имя группы.
properties.externalId

string

Для внешних групп это свойство содержит идентификатор группы из внешнего поставщика удостоверений, например для Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; в противном случае значение равно NULL.
properties.type

GroupType

Тип группы.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

GroupType

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

Тип группы.

Значение Описание
custom
external
system