Share via

User - List By Service

  • Reference
Service:
API Management
API Version:
2022-08-01

Vypíše kolekci registrovaných uživatelů v zadané instanci služby.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?api-version=2022-08-01
With optional parameters: 
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 identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
 path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName
 path True

string

Název služby API Management.

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

string

ID cílového předplatného.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.
$filter
 query

string

| Pole | Využití | Podporované operátory | Podporované funkce |
|-------------|-------------|-------------|-------------|
| name | filtr | ge, le, eq, ne, gt, lt | podřetězce, obsahuje, startswith, endswith |
| jméno | filtr | ge, le, eq, ne, gt, lt | podřetězce, obsahuje, startswith, endswith |
| příjmení | filtr | ge, le, eq, ne, gt, lt | podřetězce, obsahuje, startswith, endswith |
| e-mail | filtr | ge, le, eq, ne, gt, lt | podřetězce, obsahuje, startswith, endswith |
| state | filtr | eq | |
| registrationDate | filtr | ge, le, eq, ne, gt, lt | |
| poznámka | filtr | ge, le, eq, ne, gt, lt | podřetězce, obsahuje, startswith, endswith |
| skupiny | rozbalit | | |
$skip
 query

integer

int32

Počet záznamů, které se mají přeskočit
$top
 query

integer

int32

Počet vrácených záznamů.
expandGroups
 query

boolean

Podrobná skupina v odpovědi.

Odpovědi

Name Typ Description
200 OK

UserCollection

Vypíše kolekci entit uživatelů.
Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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

Status code:
200 
{
  "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": ""
}

Definice

Name Description
ErrorFieldContract

Chybový kontrakt pole.
ErrorResponse

Odpověď na chybu.
GroupContractProperties

Vlastnosti skupinového kontraktu.
GroupType

Typ skupiny.
UserCollection

Reprezentace seznamu stránkovaných uživatelů
UserContract

Podrobnosti o uživateli.
UserIdentityContract

Podrobnosti o identitě uživatele
UserState

Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat rozhraní API odebíraných produktů. Výchozí stav je Aktivní.

ErrorFieldContract

Chybový kontrakt pole.

Name Typ Description
code

string

Kód chyby na úrovni vlastnosti.
message

string

Pro člověka čitelná reprezentace chyby na úrovni vlastností.
target

string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Typ Description
error.code

string

Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details

ErrorFieldContract[]

Seznam neplatných polí se odešle v požadavku v případě chyby ověření.
error.message

string

Pro člověka čitelná reprezentace chyby.

GroupContractProperties

Vlastnosti skupinového kontraktu.

Name Typ Description
builtIn

boolean

pokud je skupina jednou ze tří systémových skupin (Správci, Vývojáři nebo Hosté); jinak false.
description

string

Popis skupiny. Může obsahovat značky formátování HTML.
displayName

string

Název skupiny.
externalId

string

U externích skupin obsahuje tato vlastnost ID skupiny od externího zprostředkovatele identity, například pro Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>, jinak je hodnota null.
type

GroupType

Typ skupiny.

GroupType

Typ skupiny.

Name Typ Description
custom

string

external

string

system

string

UserCollection

Reprezentace seznamu stránkovaných uživatelů

Name Typ Description
count

integer

Celkový počet záznamů na všech stránkách
nextLink

string

Odkaz na další stránku, pokud existuje.
value

UserContract[]

Hodnoty stránky.

UserContract

Podrobnosti o uživateli.

Name Typ Výchozí hodnota Description
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}
name

string

Název prostředku
properties.email

string

E-mailovou adresu
properties.firstName

string

Jméno.
properties.groups

GroupContractProperties[]

Kolekce skupin, do které uživatel patří.
properties.identities

UserIdentityContract[]

Kolekce identit uživatelů.
properties.lastName

string

Příjmení.
properties.note

string

Volitelná poznámka o uživateli nastaveném správcem.
properties.registrationDate

string

Datum registrace uživatele. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
properties.state

UserState

active

Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat rozhraní API odebíraných produktů. Výchozí stav je Aktivní.
type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

UserIdentityContract

Podrobnosti o identitě uživatele

Name Typ Description
id

string

Hodnota identifikátoru v rámci zprostředkovatele.
provider

string

Název zprostředkovatele identity.

UserState

Stav účtu. Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat rozhraní API odebíraných produktů. Výchozí stav je Aktivní.

Name Typ Description
active

string

Stav uživatele je aktivní.
blocked

string

Uživatel je zablokovaný. Blokovaní uživatelé se nemůžou ověřit na portálu pro vývojáře nebo volat rozhraní API.
deleted

string

Uživatelský účet je uzavřen. Odeberou se všechny identity a související entity.
pending

string

Uživatelský účet čeká na vyřízení. Před aktivací vyžaduje potvrzení identity.