Compartilhar via


Group - Update

Atualizações os detalhes do grupo especificado por seu identificador.

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

Parâmetros de URI

Nome Em Obrigatório Tipo 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. O nome diferencia maiúsculas de minúsculas.

serviceName
path True

string

O nome do serviço Gerenciamento de API.

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

subscriptionId
path True

string

A ID da assinatura de destino.

api-version
query True

string

A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
If-Match True

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

Corpo da solicitação

Nome Tipo 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 o Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; caso contrário, o valor é nulo.

properties.type

GroupType

Tipo de grupo.

Respostas

Nome Tipo Description
200 OK

GroupContract

Os detalhes do grupo foram atualizados com êxito.

Cabeçalhos

ETag: string

Other Status Codes

ErrorResponse

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementUpdateGroup

Solicitação de exemplo

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


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

Resposta de exemplo

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/tempgroup",
  "type": "Microsoft.ApiManagement/service/groups",
  "name": "tempgroup",
  "properties": {
    "displayName": "tempgroup",
    "description": "awesome group of people",
    "builtIn": false,
    "type": "external",
    "externalId": "aad://samiraad.onmicrosoft.com/groups/3773adf4-032e-4d25-9988-eaff9ca72eca"
  }
}

Definições

Nome Description
ErrorFieldContract

Contrato de campo de erro.

ErrorResponse

Resposta de erro.

GroupContract

Detalhes do contrato.

GroupType

Tipo de grupo.

GroupUpdateParameters

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

ErrorFieldContract

Contrato de campo de erro.

Nome Tipo Description
code

string

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

message

string

Representação legível por humanos do erro no nível da propriedade.

target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome Tipo 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

ErrorFieldContract[]

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.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O 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 o Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; caso contrário, o valor é nulo.

properties.type

GroupType

Tipo de grupo.

type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

GroupType

Tipo de grupo.

Nome Tipo Description
custom

string

external

string

system

string

GroupUpdateParameters

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

Nome Tipo 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 o Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; caso contrário, o valor é nulo.

properties.type

GroupType

Tipo de grupo.