User - List By Service

Elenca una raccolta di utenti registrati nell'istanza del servizio specificata.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?api-version=2021-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=2021-08-01

Parametri dell'URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nome del gruppo di risorse.

serviceName
path True
  • string

Nome del servizio di Gestione API.

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

subscriptionId
path True
  • string

Credenziali di sottoscrizione che identificano in modo univoco Microsoft Azure sottoscrizione. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True
  • string

Versione dell'API da usare con la richiesta client.

$filter
query
  • string

| | dei campi | di utilizzo Operatori supportati | Funzioni supportate |
|-------------|-------------|-------------|-------------|
| nome | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| firstName | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| lastName | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| | di posta elettronica filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| state | filtro | eq | |
| registrationDate | filtro | ge, le, eq, ne, gt, lt | |
| nota | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| gruppi | espandere | | |

$skip
query
  • integer
int32

Numero di record da ignorare.

$top
query
  • integer
int32

Numero di record da restituire.

expandGroups
query
  • boolean

Gruppo dettagliato in risposta.

Risposte

Name Type Description
200 OK

Elenca una raccolta di entità User.

Other Status Codes

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

ApiManagementListUsers

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users?api-version=2021-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": ""
}

Definizioni

ErrorFieldContract

Contratto campo di errore.

ErrorResponse

Risposta errore.

GroupContractProperties

Proprietà del contratto di gruppo.

GroupType

Tipo di gruppo.

UserCollection

Rappresentazione dell'elenco Utenti in pagine.

UserContract

Dettagli utente.

UserIdentityContract

Dettagli dell'identità dell'utente.

UserState

Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo.

ErrorFieldContract

Contratto campo di errore.

Name Type Description
code
  • string

Codice di errore a livello di proprietà.

message
  • string

Rappresentazione leggibile dell'errore a livello di proprietà.

target
  • string

Nome della proprietà.

ErrorResponse

Risposta errore.

Name Type Description
error.code
  • string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message
  • string

Rappresentazione leggibile dell'errore.

GroupContractProperties

Proprietà del contratto di gruppo.

Name Type Description
builtIn
  • boolean

true se il gruppo è uno dei tre gruppi di sistema (Amministratori, Sviluppatori o Guest); in caso contrario false.

description
  • string

Descrizione del gruppo. Può contenere tag di formattazione HTML.

displayName
  • string

Nome del gruppo.

externalId
  • string

Per i gruppi esterni, questa proprietà contiene l'ID del gruppo dal provider di identità esterno, ad esempio per Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; in caso contrario, il valore è Null.

type

Tipo di gruppo.

GroupType

Tipo di gruppo.

Name Type Description
custom
  • string
external
  • string
system
  • string

UserCollection

Rappresentazione dell'elenco Utenti in pagine.

Name Type Description
count
  • integer

Numero totale di conteggio record in tutte le pagine.

nextLink
  • string

Collegamento alla pagina successiva, se disponibile.

value

Valori di pagina.

UserContract

Dettagli utente.

Name Type Default Value Description
id
  • string

ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

nome della risorsa.

properties.email
  • string

Indirizzo di posta elettronica.

properties.firstName
  • string

Nome.

properties.groups

La raccolta di utenti di gruppi fa parte di .

properties.identities

Raccolta di identità utente.

properties.lastName
  • string

Cognome.

properties.note
  • string

Nota facoltativa su un utente impostata dall'amministratore.

properties.registrationDate
  • string

Data di registrazione dell'utente. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.

properties.state active

Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo.

type
  • string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft. Archiviazione/storageAccounts"

UserIdentityContract

Dettagli dell'identità dell'utente.

Name Type Description
id
  • string

Valore dell'identificatore all'interno del provider.

provider
  • string

Nome del provider di identità.

UserState

Stato dell'account. Specifica se l'utente è attivo o meno. Gli utenti bloccati non possono eseguire l'accesso al portale per sviluppatori o chiamare le API di prodotti sottoscritti. Lo stato predefinito è Attivo.

Name Type Description
active
  • string

Lo stato utente è attivo.

blocked
  • string

L'utente è bloccato. Gli utenti bloccati non possono eseguire l'autenticazione nel portale per sviluppatori o chiamare l'API.

deleted
  • string

L'account utente viene chiuso. Tutte le identità e le entità correlate vengono rimosse.

pending
  • string

L'account utente è in sospeso. Richiede la conferma dell'identità prima che possa essere attivata.