Group - Create Or Update
Создает или изменяет группу.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2022-08-01
Параметры URI
Имя | В | Обязательно | Тип | Описание |
---|---|---|---|---|
group
|
path | True |
string |
Идентификатор группы. Должен быть уникальным в текущем экземпляре службы Управление API. |
resource
|
path | True |
string |
Имя группы ресурсов. Регистр букв в имени не учитывается. |
service
|
path | True |
string |
Имя службы Управление API. Шаблон регулярного выражения: |
subscription
|
path | True |
string |
Идентификатор целевой подписки. |
api-version
|
query | True |
string |
Версия API, используемая для данной операции. |
Заголовок запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
If-Match |
string |
ETag сущности. Не требуется при создании сущности, но требуется при обновлении сущности. |
Текст запроса
Имя | Обязательно | Тип | Описание |
---|---|---|---|
properties.displayName | True |
string |
Имя группы. |
properties.description |
string |
Описание группы. |
|
properties.externalId |
string |
Идентификатор внешних групп. Это свойство содержит идентификатор группы от внешнего поставщика удостоверений, например для Azure Active Directory |
|
properties.type |
Тип группы. |
Ответы
Имя | Тип | Описание |
---|---|---|
200 OK |
Группа уже существует. Заголовки ETag: string |
|
201 Created |
Группа успешно создана. Заголовки ETag: string |
|
Other Status Codes |
Ответ об ошибке, описывающий причину сбоя операции. |
Безопасность
azure_auth
Поток OAuth2 в Azure Active Directory.
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/authorize
Области
Имя | Описание |
---|---|
user_impersonation | олицетворения учетной записи пользователя |
Примеры
Api |
Api |
ApiManagementCreateGroup
Образец запроса
Пример ответа
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
"type": "Microsoft.ApiManagement/service/groups",
"name": "tempgroup",
"properties": {
"displayName": "temp group",
"type": "custom"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
"type": "Microsoft.ApiManagement/service/groups",
"name": "tempgroup",
"properties": {
"displayName": "temp group",
"type": "custom"
}
}
ApiManagementCreateGroupExternal
Образец запроса
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup?api-version=2022-08-01
{
"properties": {
"displayName": "NewGroup (samiraad.onmicrosoft.com)",
"description": "new group to test",
"type": "external",
"externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
}
}
Пример ответа
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
"type": "Microsoft.ApiManagement/service/groups",
"name": "aadGroup",
"properties": {
"displayName": "NewGroup (samiraad.onmicrosoft.com)",
"description": "new group to test",
"type": "external",
"externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup",
"type": "Microsoft.ApiManagement/service/groups",
"name": "aadGroup",
"properties": {
"displayName": "NewGroup (samiraad.onmicrosoft.com)",
"description": "new group to test",
"type": "external",
"externalId": "aad://samiraad.onmicrosoft.com/groups/83cf2753-5831-4675-bc0e-2f8dc067c58d"
}
}
Определения
Имя | Описание |
---|---|
Error |
Контракт поля ошибки. |
Error |
Ответ об ошибке. |
Group |
Сведения о контракте. |
Group |
Параметры, предоставленные для операции создания группы. |
Group |
Тип группы. |
ErrorFieldContract
Контракт поля ошибки.
Имя | Тип | Описание |
---|---|---|
code |
string |
Код ошибки уровня свойства. |
message |
string |
Удобочитаемое представление ошибки на уровне свойств. |
target |
string |
Имя свойства. |
ErrorResponse
Ответ об ошибке.
Имя | Тип | Описание |
---|---|---|
error.code |
string |
Код ошибки, определяемый службой. Это код служит в качестве подсостояния для кода ошибки HTTP, указанного в ответе. |
error.details |
Список недопустимых полей, отправляемых в запросе, в случае ошибки проверки. |
|
error.message |
string |
Читаемое представление ошибки. |
GroupContract
Сведения о контракте.
Имя | Тип | Описание |
---|---|---|
id |
string |
Полный идентификатор ресурса. Например: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Имя ресурса. |
properties.builtIn |
boolean |
Значение true, если группа является одной из трех системных групп (администраторы, разработчики или гости); в противном случае — false. |
properties.description |
string |
Описание группы. Может содержать теги форматирования HTML. |
properties.displayName |
string |
Имя группы. |
properties.externalId |
string |
Для внешних групп это свойство содержит идентификатор группы от внешнего поставщика удостоверений, например для Azure Active Directory |
properties.type |
Тип группы. |
|
type |
string |
Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts. |
GroupCreateParameters
Параметры, предоставленные для операции создания группы.
Имя | Тип | Описание |
---|---|---|
properties.description |
string |
Описание группы. |
properties.displayName |
string |
Имя группы. |
properties.externalId |
string |
Идентификатор внешних групп. Это свойство содержит идентификатор группы от внешнего поставщика удостоверений, например для Azure Active Directory |
properties.type |
Тип группы. |
GroupType
Тип группы.
Имя | Тип | Описание |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |