Subscription interface
Interfaccia che rappresenta una sottoscrizione.
Metodi
Dettagli metodo
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Crea o aggiorna la sottoscrizione dell'utente specificato al prodotto specificato.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- sid
-
string
Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API.
- parameters
- SubscriptionCreateParameters
Creare parametri.
Parametri delle opzioni.
Restituisce
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Elimina la sottoscrizione specificata.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- sid
-
string
Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API.
- ifMatch
-
string
ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
- options
- SubscriptionDeleteOptionalParams
Parametri delle opzioni.
Restituisce
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Ottiene l'entità Subscription specificata.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- sid
-
string
Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API.
- options
- SubscriptionGetOptionalParams
Parametri delle opzioni.
Restituisce
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Ottiene la versione dello stato dell'entità (Etag) della sottoscrizione apimanagement specificata dal relativo identificatore.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- sid
-
string
Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API.
Parametri delle opzioni.
Restituisce
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Elenca tutte le sottoscrizioni dell'istanza del servizio Gestione API.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- options
- SubscriptionListOptionalParams
Parametri delle opzioni.
Restituisce
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Ottiene le chiavi di sottoscrizione specificate.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- sid
-
string
Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API.
Parametri delle opzioni.
Restituisce
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Rigenera la chiave primaria della sottoscrizione esistente dell'istanza del servizio Gestione API.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- sid
-
string
Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API.
Parametri delle opzioni.
Restituisce
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Rigenera la chiave secondaria della sottoscrizione esistente dell'istanza del servizio Gestione API.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- sid
-
string
Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API.
Parametri delle opzioni.
Restituisce
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Aggiornamenti i dettagli di una sottoscrizione specificata dal relativo identificatore.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
- serviceName
-
string
Nome del servizio di Gestione API.
- sid
-
string
Identificatore dell'entità sottoscrizione. L'entità rappresenta l'associazione tra un utente e un prodotto in Gestione API.
- ifMatch
-
string
ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
- parameters
- SubscriptionUpdateParameters
Aggiornare i parametri.
- options
- SubscriptionUpdateOptionalParams
Parametri delle opzioni.
Restituisce
Promise<SubscriptionUpdateResponse>