Group - Create Or Update

Cria ou atualiza um grupo.

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

Parâmetros de URI

Name In Required Type Description
groupId
path True
  • string

Identificador de grupo. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço Gerenciamento de API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenciais de assinatura que identificam exclusivamente Microsoft Azure assinatura. A ID da assinatura faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API a ser usada com a solicitação do cliente.

Cabeçalho da solicitação

Name Required Type Description
If-Match
  • string

ETag da Entidade. Não é necessário ao criar uma entidade, mas necessário ao atualizar uma entidade.

Corpo da solicitação

Name Required Type Description
properties.displayName True
  • string

Nome do grupo.

properties.description
  • string

Descrição do grupo.

properties.externalId
  • string

Identificador dos grupos externos, essa propriedade contém a ID do grupo do provedor de identidade externo, por exemplo, para Azure Active Directoryaad://<tenant>.onmicrosoft.com/groups/<group object id>; caso contrário, o valor é nulo.

properties.type

Tipo de grupo.

Respostas

Name Type Description
200 OK

O grupo já existe.

Headers

  • ETag: string
201 Created

O grupo foi criado com êxito.

Headers

  • ETag: string
Other Status Codes

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementCreateGroup
ApiManagementCreateGroupExternal

ApiManagementCreateGroup

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup?api-version=2020-12-01

{
  "properties": {
    "displayName": "temp group"
  }
}

Sample Response

{
  "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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/aadGroup?api-version=2020-12-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"
  }
}

Sample Response

{
  "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"
  }
}

Definições

ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta de erro.

GroupContract

Detalhes do contrato.

GroupCreateParameters

Parâmetros fornecidos para a operação Criar Grupo.

GroupType

Tipo de grupo.

ErrorFieldContract

Contrato de Campo de Erro.

Name Type Description
code
  • string

Código de erro no nível da propriedade.

message
  • string

Representação legível de erro no nível da propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.

error.message
  • string

Representação legível ao olho humano do erro.

GroupContract

Detalhes do contrato.

Name Type Description
id
  • string

ID do recurso.

name
  • string

Nome do recurso.

properties.builtIn
  • boolean

true se o grupo for um dos três grupos do sistema (Administradores, Desenvolvedores ou Convidados); caso contrário, false.

properties.description
  • string

Descrição do grupo. Pode conter marcas de formatação HTML.

properties.displayName
  • string

Nome do grupo.

properties.externalId
  • string

Para grupos externos, essa propriedade contém a ID do grupo do provedor de identidade externo, por exemplo, para Azure Active Directoryaad://<tenant>.onmicrosoft.com/groups/<group object id>; caso contrário, o valor é nulo.

properties.type

Tipo de grupo.

type
  • string

Tipo de recurso para Gerenciamento de API recurso.

GroupCreateParameters

Parâmetros fornecidos para a operação Criar Grupo.

Name Type Description
properties.description
  • string

Descrição do grupo.

properties.displayName
  • string

Nome do grupo.

properties.externalId
  • string

Identificador dos grupos externos, essa propriedade contém a ID do grupo do provedor de identidade externo, por exemplo, para Azure Active Directoryaad://<tenant>.onmicrosoft.com/groups/<group object id>; caso contrário, o valor é nulo.

properties.type

Tipo de grupo.

GroupType

Tipo de grupo.

Name Type Description
custom
  • string
external
  • string
system
  • string