User - List By Service
Wyświetla listę kolekcji zarejestrowanych użytkowników w określonym wystąpieniu usługi.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?$filter={$filter}&$top={$top}&$skip={$skip}&expandGroups={expandGroups}&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. Regex pattern: |
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. |
|
expand
|
query |
boolean |
Szczegółowa grupa w odpowiedzi. |
Odpowiedzi
Nazwa | Typ | Opis |
---|---|---|
200 OK |
Wyświetla listę kolekcji jednostek Użytkownika. |
|
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.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nazwa | Opis |
---|---|
user_impersonation | personifikacja konta użytkownika |
Przykłady
ApiManagementListUsers
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users?api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
"type": "Microsoft.ApiManagement/service/users",
"name": "1",
"properties": {
"firstName": "Administrator",
"lastName": "",
"email": "admin@live.com",
"state": "active",
"registrationDate": "2015-09-22T01:57:39.677Z",
"identities": [
{
"provider": "Azure",
"id": "admin@live.com"
}
]
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
"type": "Microsoft.ApiManagement/service/users",
"name": "56eaec62baf08b06e46d27fd",
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foo.bar.83@gmail.com",
"state": "active",
"registrationDate": "2016-03-17T17:41:56.327Z",
"identities": [
{
"provider": "Basic",
"id": "foo.bar.83@gmail.com"
}
]
}
},
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
"type": "Microsoft.ApiManagement/service/users",
"name": "5931a75ae4bbd512a88c680b",
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com",
"state": "active",
"registrationDate": "2017-06-02T17:58:50.357Z",
"identities": [
{
"provider": "Microsoft",
"id": "*************"
}
]
}
}
],
"count": 3,
"nextLink": ""
}
Definicje
Nazwa | Opis |
---|---|
Error |
Błąd Kontrakt pola. |
Error |
Odpowiedź na błąd. |
Group |
Właściwości kontraktu grupy. |
Group |
Typ grupy. |
User |
Reprezentacja listy stronicowanych użytkowników. |
User |
Szczegóły użytkownika. |
User |
Szczegóły tożsamości użytkownika. |
User |
Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Domyślny stan to Aktywny. |
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 wysyłanych w żądaniu w przypadku błędu walidacji. |
|
error.message |
string |
Czytelna dla człowieka reprezentacja błędu. |
GroupContractProperties
Właściwości kontraktu grupy.
Nazwa | Typ | Opis |
---|---|---|
builtIn |
boolean |
prawda, jeśli grupa jest jedną z trzech grup systemowych (Administratorzy, Deweloperzy lub Goście); w przeciwnym razie wartość false. |
description |
string |
Opis grupy. Może zawierać tagi formatowania HTML. |
displayName |
string |
Nazwa grupy. |
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 |
type |
Typ grupy. |
GroupType
Typ grupy.
Nazwa | Typ | Opis |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |
UserCollection
Reprezentacja listy stronicowanych użytkowników.
Nazwa | Typ | Opis |
---|---|---|
count |
integer |
Łączna liczba rekordów na wszystkich stronach. |
nextLink |
string |
Jeśli istnieje, łącze następnej strony. |
value |
Wartości stron. |
UserContract
Szczegóły użytkownika.
Nazwa | Typ | Wartość domyślna | 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.email |
string |
Adres e-mail. |
|
properties.firstName |
string |
Imię. |
|
properties.groups |
Kolekcja użytkowników grup jest częścią. |
||
properties.identities |
Kolekcja tożsamości użytkowników. |
||
properties.lastName |
string |
Nazwisko. |
|
properties.note |
string |
Opcjonalna uwaga dotycząca użytkownika ustawionego przez administratora. |
|
properties.registrationDate |
string |
Data rejestracji użytkownika. Data jest zgodna z następującym formatem: |
|
properties.state | active |
Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Domyślny stan to Aktywny. |
|
type |
string |
Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts" |
UserIdentityContract
Szczegóły tożsamości użytkownika.
Nazwa | Typ | Opis |
---|---|---|
id |
string |
Wartość identyfikatora w obrębie dostawcy. |
provider |
string |
Nazwa dostawcy tożsamości. |
UserState
Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Domyślny stan to Aktywny.
Nazwa | Typ | Opis |
---|---|---|
active |
string |
Stan użytkownika jest aktywny. |
blocked |
string |
Użytkownik jest zablokowany. Zablokowani użytkownicy nie mogą uwierzytelniać się w portalu deweloperów ani wywoływać interfejsu API. |
deleted |
string |
Konto użytkownika jest zamknięte. Wszystkie tożsamości i powiązane jednostki są usuwane. |
pending |
string |
Konto użytkownika oczekuje. Wymaga potwierdzenia tożsamości, zanim będzie można go uaktywnić. |