Group - Create Or Update

Crea o actualiza un 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 identificador URI

Name In Required Type Description
groupId
path True
  • string

Identificador de grupo. Debe ser único en la instancia de servicio de API Management actual.

resourceGroupName
path True
  • string

Nombre del grupo de recursos.

serviceName
path True
  • string

Nombre del servicio API Management.

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

subscriptionId
path True
  • string

Credenciales de suscripción que identifican de forma única Microsoft Azure suscripción. El identificador de suscripción forma parte del URI para cada llamada al servicio.

api-version
query True
  • string

Versión de la API que se va a usar con la solicitud de cliente.

Encabezado de la solicitud

Name Required Type Description
If-Match
  • string

ETag de la entidad. No es necesario al crear una entidad, pero es necesario al actualizar una entidad.

Cuerpo de la solicitud

Name Required Type Description
properties.displayName True
  • string

Nombre de grupo.

properties.description
  • string

Descripción de grupo.

properties.externalId
  • string

Identificador de los grupos externos, esta propiedad contiene el identificador del grupo del proveedor de identidades externo, por ejemplo, para Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; de lo contrario, el valor es NULL.

properties.type

Tipo de grupo.

Respuestas

Name Type Description
200 OK

El grupo ya existe.

Headers

  • ETag: string
201 Created

El grupo se creó correctamente.

Headers

  • ETag: string
Other Status Codes

Respuesta de error que describe el motivo del error de la operación.

Seguridad

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 suplantar la cuenta de usuario

Ejemplos

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

Definiciones

ErrorFieldContract

Contrato de campo de error.

ErrorResponse

Respuesta de error.

GroupContract

Detalles del contrato.

GroupCreateParameters

Parámetros proporcionados a la operación Crear grupo.

GroupType

Tipo de grupo.

ErrorFieldContract

Contrato de campo de error.

Name Type Description
code
  • string

Código de error de nivel de propiedad.

message
  • string

Representación legible del error de nivel de propiedad.

target
  • string

Nombre de propiedad.

ErrorResponse

Respuesta de error.

Name Type Description
error.code
  • string

Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.

error.details

La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.

error.message
  • string

Representación legible del error.

GroupContract

Detalles del contrato.

Name Type Description
id
  • string

Identificador del recurso.

name
  • string

Nombre del recurso.

properties.builtIn
  • boolean

True si el grupo es uno de los tres grupos del sistema (administradores, desarrolladores o invitados); en caso contrario, false.

properties.description
  • string

Descripción de grupo. Puede contener etiquetas de formato HTML.

properties.displayName
  • string

Nombre de grupo.

properties.externalId
  • string

En el caso de los grupos externos, esta propiedad contiene el identificador del grupo del proveedor de identidades externo, por ejemplo, para Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; de lo contrario, el valor es NULL.

properties.type

Tipo de grupo.

type
  • string

Tipo de recurso para API Management recurso.

GroupCreateParameters

Parámetros proporcionados a la operación Crear grupo.

Name Type Description
properties.description
  • string

Descripción de grupo.

properties.displayName
  • string

Nombre de grupo.

properties.externalId
  • string

Identificador de los grupos externos, esta propiedad contiene el identificador del grupo del proveedor de identidades externo, por ejemplo, para Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; de lo contrario, el valor es NULL.

properties.type

Tipo de grupo.

GroupType

Tipo de grupo.

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