Group - List By Service
Wyświetla listę kolekcji grup zdefiniowanych w wystąpieniu usługi.
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
Parametry identyfikatora URI
Nazwa | W | Wymagane | Typ | Opis |
---|---|---|---|---|
resource
|
path | True |
string |
Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter. |
service
|
path | True |
string |
Nazwa usługi API Management. Wzorzec wyrażenia regularnego: |
subscription
|
path | True |
string |
Identyfikator subskrypcji docelowej. |
api-version
|
query | True |
string |
Wersja interfejsu API do użycia dla tej operacji. |
$filter
|
query |
string |
| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje | |
|
$skip
|
query |
integer int32 |
Liczba rekordów do pominięcia. |
|
$top
|
query |
integer int32 |
Liczba rekordów do zwrócenia. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Wyświetla listę kolekcji jednostek grupy. |
|
Other Status Codes |
Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się. |
Zabezpieczenia
azure_auth
Przepływ OAuth2 usługi Azure Active Directory.
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/authorize
Zakresy
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
ApiManagementListGroups
Przykładowe żądanie
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups?api-version=2022-08-01
Przykładowa odpowiedź
{
"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": ""
}
Definicje
Nazwa | Opis |
---|---|
Error |
Błąd Kontrakt pola. |
Error |
Odpowiedź na błąd. |
Group |
Reprezentacja listy grup stronicowanych. |
Group |
Szczegóły kontraktu. |
Group |
Typ grupy. |
ErrorFieldContract
Błąd Kontrakt pola.
Nazwa | Typ | Opis |
---|---|---|
code |
string |
Kod błędu poziomu właściwości. |
message |
string |
Czytelna dla człowieka reprezentacja błędu na poziomie właściwości. |
target |
string |
Nazwa właściwości. |
ErrorResponse
Odpowiedź na błąd.
Nazwa | Typ | Opis |
---|---|---|
error.code |
string |
Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi. |
error.details |
Lista nieprawidłowych pól jest wysyłana w żądaniu w przypadku błędu walidacji. |
|
error.message |
string |
Czytelna dla człowieka reprezentacja błędu. |
GroupCollection
Reprezentacja listy grup stronicowanych.
Nazwa | Typ | Opis |
---|---|---|
count |
integer |
Łączna liczba rekordów na wszystkich stronach. |
nextLink |
string |
Jeśli istnieje link do następnej strony. |
value |
Wartości stron. |
GroupContract
Szczegóły kontraktu.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Nazwa zasobu |
properties.builtIn |
boolean |
prawda, jeśli grupa jest jedną z trzech grup systemowych (Administratorzy, Deweloperzy lub Goście); w przeciwnym razie wartość false. |
properties.description |
string |
Opis grupy. Może zawierać tagi formatowania HTML. |
properties.displayName |
string |
Nazwa grupy. |
properties.externalId |
string |
W przypadku grup zewnętrznych ta właściwość zawiera identyfikator grupy od zewnętrznego dostawcy tożsamości, np. dla usługi Azure Active Directory |
properties.type |
Typ grupy. |
|
type |
string |
Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" |
GroupType
Typ grupy.
Nazwa | Typ | Opis |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |