User Subscription - List

Elenca la raccolta di sottoscrizioni dell'utente specificato.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions?api-version=2020-06-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}/subscriptions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2020-06-01-preview

Parametri dell'URI

Name In Required Type Description
resourceGroupName
path True
  • string

Nome del gruppo di risorse.

serviceName
path True
  • string

Nome del servizio API Management servizio.

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.

userId
path True
  • string

Identificatore dell'utente. Deve essere univoco nell'istanza del API Management corrente.

api-version
query True
  • string

Versione dell'API da usare con la richiesta client.

$filter
query
  • string

| Campi | Utilizzo | Operatori supportati | Funzioni supportate |
|-------------|------------------------|-----------------------------------|
|nome | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|displayName | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|stateComment | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|ownerId | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|scope | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|userId | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
|productId | filtro | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query
  • integer
int32

Numero di record da ignorare.

$top
query
  • integer
int32

Numero di record da restituire.

Risposte

Name Type Description
200 OK

Elenca una raccolta di entità Subscription.

Other Status Codes

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

Sicurezza

azure_auth

Azure Active Directory flusso OAuth2.

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

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

ApiManagementListUserSubscriptions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions?api-version=2020-06-01-preview

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6ae3",
      "type": "Microsoft.ApiManagement/service/users/subscriptions",
      "name": "57681850a40f7eb6c49f6ae3",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7",
        "displayName": "57681850a40f7eb6c49f6ae5",
        "state": "active",
        "createdDate": "2016-06-20T16:22:39.547Z",
        "startDate": "2016-06-20T00:00:00Z"
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf/subscriptions/57681850a40f7eb6c49f6b2b",
      "type": "Microsoft.ApiManagement/service/users/subscriptions",
      "name": "57681850a40f7eb6c49f6b2b",
      "properties": {
        "ownerId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57681833a40f7eb6c49f6acf",
        "scope": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7",
        "displayName": "57681850a40f7eb6c49f6b2d",
        "state": "active",
        "createdDate": "2016-06-20T16:22:41.103Z",
        "startDate": "2016-06-20T00:00:00Z"
      }
    }
  ],
  "nextLink": ""
}

Definizioni

ErrorFieldContract

Contratto del campo di errore.

ErrorResponse

Risposta all'errore.

SubscriptionCollection

Rappresentazione dell'elenco sottoscrizioni di pagine.

SubscriptionContract

Dettagli della sottoscrizione.

SubscriptionState

Stato della sottoscrizione. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa, la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto* inviata. La richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata. La richiesta di sottoscrizione è stata negata da un amministratore, * annullata: la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore , * scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

ErrorFieldContract

Contratto del 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 all'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.

SubscriptionCollection

Rappresentazione dell'elenco sottoscrizioni di pagine.

Name Type Description
count
  • integer

Numero totale di conteggio dei record in tutte le pagine.

nextLink
  • string

Collegamento alla pagina successiva, se presente.

value

Valori di pagina.

SubscriptionContract

Dettagli della sottoscrizione.

Name Type Description
id
  • string

ID risorsa.

name
  • string

Nome della risorsa.

properties.allowTracing
  • boolean

Determina se la traccia è abilitata

properties.createdDate
  • string

Data di creazione della sottoscrizione. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.

properties.displayName
  • string

Nome della sottoscrizione oppure Null se la sottoscrizione non ha alcun nome.

properties.endDate
  • string

Data in cui la sottoscrizione è stata annullata o scaduta. L'impostazione è solo a scopo di controllo e la sottoscrizione non viene annullata automaticamente. Il ciclo di vita della sottoscrizione può essere gestito tramite la state proprietà . La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.

properties.expirationDate
  • string

Data di scadenza della sottoscrizione. L'impostazione è solo a scopo di controllo e la sottoscrizione non è scaduta automaticamente. Il ciclo di vita della sottoscrizione può essere gestito tramite la state proprietà . La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.

properties.notificationDate
  • string

Data di notifica della scadenza della sottoscrizione imminente. La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.

properties.ownerId
  • string

Identificatore di risorsa utente del proprietario della sottoscrizione. Il valore è un URL relativo valido nel formato /users/{userId} dove {userId} è un identificatore utente.

properties.primaryKey
  • string

Chiave primaria della sottoscrizione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.

properties.scope
  • string

Ambito come /products/{productId} o /apis o /apis/{apiId}.

properties.secondaryKey
  • string

Chiave secondaria della sottoscrizione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.

properties.startDate
  • string

Data di attivazione della sottoscrizione. L'impostazione è solo a scopo di controllo e la sottoscrizione non viene attivata automaticamente. Il ciclo di vita della sottoscrizione può essere gestito tramite la state proprietà . La data è conforme al formato seguente: yyyy-MM-ddTHH:mm:ssZ come specificato dallo standard ISO 8601.

properties.state

Stato della sottoscrizione. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa, la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto* inviata. La richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata. La richiesta di sottoscrizione è stata negata da un amministratore, * annullata: la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore , * scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

properties.stateComment
  • string

Commento facoltativo della sottoscrizione aggiunto da un amministratore quando lo stato viene modificato in "rifiutato".

type
  • string

Tipo di risorsa per API Management risorsa.

SubscriptionState

Stato della sottoscrizione. Gli stati possibili sono * attivi: la sottoscrizione è attiva, * sospesa, la sottoscrizione è bloccata e il sottoscrittore non può chiamare alcuna API del prodotto* inviata. La richiesta di sottoscrizione è stata effettuata dallo sviluppatore, ma non è ancora stata approvata o rifiutata, * rifiutata. La richiesta di sottoscrizione è stata negata da un amministratore, * annullata: la sottoscrizione è stata annullata dallo sviluppatore o dall'amministratore , * scaduto: la sottoscrizione ha raggiunto la data di scadenza ed è stata disattivata.

Name Type Description
active
  • string
cancelled
  • string
expired
  • string
rejected
  • string
submitted
  • string
suspended
  • string