Subscription - Create Or Update

Riferimento

Servizio:: API Management

Versione API:: 2024-05-01

Crea o aggiorna la sottoscrizione dell'utente specificato al prodotto specificato.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?api-version=2024-05-01

Con parametri facoltativi:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}?notify={notify}&api-version=2024-05-01&appType={appType}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
sid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.
appType	query		AppType	Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale di pubblicazione legacy.
notify	query		boolean	Notifica delle modifiche apportate allo stato della sottoscrizione. Se false, non inviare alcuna notifica tramite posta elettronica per la modifica dello stato della sottoscrizione Se true, inviare una notifica tramite posta elettronica di modifica dello stato della sottoscrizione

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match		string	ETag dell'entità. Non obbligatorio durante la creazione di un'entità, ma necessario durante l'aggiornamento di un'entità.

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
properties.displayName	True	string minLength: 1 maxLength: 100	Nome sottoscrizione.
properties.scope	True	string	Ambito come /products/{productId} o /apis o /apis/{apiId}.
properties.allowTracing		boolean	Determina se è possibile abilitare la traccia
properties.ownerId		string	Utente (percorso ID utente) per il quale viene creata la sottoscrizione nel formato /users/{userId}
properties.primaryKey		string minLength: 1 maxLength: 256	Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.
properties.secondaryKey		string minLength: 1 maxLength: 256	Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.
properties.state		SubscriptionState	Stato iniziale della sottoscrizione. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. 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.

Risposte

Nome	Tipo	Descrizione
200 OK	SubscriptionContract	L'utente ha già sottoscritto il prodotto. Intestazioni ETag: string
201 Created	SubscriptionContract	L'utente è stato sottoscritto correttamente al prodotto. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

SubscriptionContract

L'utente ha già sottoscritto il prodotto.

Intestazioni

ETag: string

201 Created

SubscriptionContract

L'utente è stato sottoscritto correttamente al prodotto.

Intestazioni

ETag: string

Other Status Codes

ErrorResponse

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

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementCreateSubscription

Esempio di richiesta

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub?api-version=2024-05-01

{
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub"
  }
}

Risposta di esempio

Codice di stato:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Codice di stato:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/subscriptions/testsub",
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "name": "testsub",
  "properties": {
    "ownerId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/57127d485157a511ace86ae7",
    "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5600b59475ff190048060002",
    "displayName": "testsub",
    "state": "submitted",
    "createdDate": "2017-06-02T23:34:03.1055076Z"
  }
}

Definizioni

Nome	Descrizione
AppType	Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale di pubblicazione legacy.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
SubscriptionContract	Dettagli della sottoscrizione.
SubscriptionCreateParameters	Dettagli della creazione 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.

AppType

Enumerazione

Determina il tipo di applicazione che invia la richiesta di creazione dell'utente. Il valore predefinito è il portale di pubblicazione legacy.

Valore	Descrizione
developerPortal	La richiesta di creazione dell'utente è stata inviata dal nuovo portale per sviluppatori.
portal	La richiesta di creazione dell'utente è stata inviata dal portale per sviluppatori legacy.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

SubscriptionContract

Object

Dettagli della sottoscrizione.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.allowTracing	boolean	Determina se la traccia è abilitata
properties.createdDate	string (date-time)	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 minLength: 0 maxLength: 100	Nome della sottoscrizione o Null se la sottoscrizione non ha alcun nome.
properties.endDate	string (date-time)	Data di annullamento o scadenza della sottoscrizione. L'impostazione è solo a scopo di controllo e la sottoscrizione non viene annullata automaticamente. Il ciclo di vita della sottoscrizione può essere gestito usando la proprietà `state`. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.
properties.expirationDate	string (date-time)	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 usando la proprietà `state`. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.
properties.notificationDate	string (date-time)	Data di notifica di 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 della risorsa utente del proprietario della sottoscrizione. Il valore è un URL relativo valido nel formato /users/{userId} dove {userId} è un identificatore utente.
properties.primaryKey	string minLength: 1 maxLength: 256	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 minLength: 1 maxLength: 256	Chiave secondaria della sottoscrizione. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
properties.startDate	string (date-time)	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 usando la proprietà `state`. La data è conforme al formato seguente: `yyyy-MM-ddTHH:mm:ssZ` come specificato dallo standard ISO 8601.
properties.state	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.
properties.stateComment	string	Commento di sottoscrizione facoltativo aggiunto da un amministratore quando lo stato viene modificato in "rifiutato".
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SubscriptionCreateParameters

Object

Dettagli della creazione della sottoscrizione.

Nome	Tipo	Descrizione
properties.allowTracing	boolean	Determina se è possibile abilitare la traccia
properties.displayName	string minLength: 1 maxLength: 100	Nome sottoscrizione.
properties.ownerId	string	Utente (percorso ID utente) per il quale viene creata la sottoscrizione nel formato /users/{userId}
properties.primaryKey	string minLength: 1 maxLength: 256	Chiave di sottoscrizione primaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.
properties.scope	string	Ambito come /products/{productId} o /apis o /apis/{apiId}.
properties.secondaryKey	string minLength: 1 maxLength: 256	Chiave di sottoscrizione secondaria. Se non specificato durante la chiave di richiesta, verrà generato automaticamente.
properties.state	SubscriptionState	Stato iniziale della sottoscrizione. Se non viene specificato alcun valore, la sottoscrizione viene creata con stato Inviato. 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.

SubscriptionState

Enumerazione

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.

Valore	Descrizione
active
cancelled
expired
rejected
submitted
suspended

Condividi tramite

Subscription - Create Or Update

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementCreateSubscription

Esempio di richiesta

Risposta di esempio

Definizioni

AppType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SubscriptionContract

SubscriptionCreateParameters

SubscriptionState

Risorse aggiuntive