Group - Get
Obtiene los detalles del grupo especificado por su identificador.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}?api-version=2022-08-01
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
group
|
path | True |
string |
Identificador de grupo. Debe ser único en la instancia de servicio API Management actual. |
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
service
|
path | True |
string |
Nombre del servicio API Management. Regex pattern: |
subscription
|
path | True |
string |
Identificador de la suscripción de destino. |
api-version
|
query | True |
string |
Versión de API que se usará para la operación. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
El cuerpo de la respuesta contiene la entidad Group especificada. Headers ETag: string |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de la operación. |
Seguridad
azure_auth
Flujo de OAuth2 de Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nombre | Description |
---|---|
user_impersonation | suplantación de su cuenta de usuario |
Ejemplos
ApiManagementGetGroup
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/59306a29e4bbd510dc24e5f9?api-version=2022-08-01
Sample Response
{
"id": "/subscriptions/subid/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"
}
}
Definiciones
Nombre | Description |
---|---|
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
Group |
Detalles del contrato. |
Group |
Tipo de grupo. |
ErrorFieldContract
Contrato de campo de error.
Nombre | Tipo | 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.
Nombre | Tipo | 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.
Nombre | Tipo | Description |
---|---|---|
id |
string |
Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nombre del recurso. |
properties.builtIn |
boolean |
True si el grupo es uno de los tres grupos del sistema (administradores, desarrolladores o invitados); de lo 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 |
properties.type |
Tipo de grupo. |
|
type |
string |
Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
GroupType
Tipo de grupo.
Nombre | Tipo | Description |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |