Group - List By Service
Lista uma coleção de grupos definidos em uma instância de serviço.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
resource
|
path | True |
string |
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas. |
service
|
path | True |
string |
O nome do serviço Gerenciamento de API. Padrão Regex: |
subscription
|
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. |
$filter
|
query |
string |
| Campo | Uso | Operadores com suporte | Funções com suporte | |
|
$skip
|
query |
integer int32 |
Número de registros a serem ignorados. |
|
$top
|
query |
integer int32 |
Número de registros a serem retornados. |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
Lista uma coleção de entidades de grupo. |
|
Other Status Codes |
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
ApiManagementListGroups
Solicitação de exemplo
Resposta de exemplo
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020001",
"type": "Microsoft.ApiManagement/service/groups",
"name": "5600b59375ff190048020001",
"properties": {
"displayName": "Administrators",
"description": "Administrators is a built-in group. Its membership is managed by the system. Microsoft Azure subscription administrators fall into this group.",
"builtIn": true,
"type": "system"
}
},
{
"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"
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020002",
"type": "Microsoft.ApiManagement/service/groups",
"name": "5600b59375ff190048020002",
"properties": {
"displayName": "Developers",
"description": "Developers is a built-in group. Its membership is managed by the system. Signed-in users fall into this group.",
"builtIn": true,
"type": "system"
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/5600b59375ff190048020003",
"type": "Microsoft.ApiManagement/service/groups",
"name": "5600b59375ff190048020003",
"properties": {
"displayName": "Guests",
"description": "Guests is a built-in group. Its membership is managed by the system. Unauthenticated users visiting the developer portal fall into this group.",
"builtIn": true,
"type": "system"
}
}
],
"count": 4,
"nextLink": ""
}
Definições
Nome | Description |
---|---|
Error |
Contrato de campo de erro. |
Error |
Resposta de erro. |
Group |
Representação de lista de grupos paginado. |
Group |
Detalhes do contrato. |
Group |
Tipo de 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 |
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. |
GroupCollection
Representação de lista de grupos paginado.
Nome | Tipo | Description |
---|---|---|
count |
integer |
Número total de contagem de registros em todas as páginas. |
nextLink |
string |
Próximo link da página, se houver. |
value |
Valores de página. |
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 |
properties.type |
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 |