WorkspaceSubscription interface
Interfaccia che rappresenta un oggetto WorkspaceSubscription.
Metodi
Dettagli metodo
createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)
Crea o aggiorna la sottoscrizione dell'utente specificato al prodotto specificato.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, parameters: SubscriptionCreateParameters, options?: WorkspaceSubscriptionCreateOrUpdateOptionalParams): Promise<WorkspaceSubscriptionCreateOrUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio 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
delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)
Elimina la sottoscrizione specificata.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, options?: WorkspaceSubscriptionDeleteOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio 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 dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
Parametri delle opzioni.
Restituisce
Promise<void>
get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)
Ottiene l'entità Subscription specificata.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetOptionalParams): Promise<WorkspaceSubscriptionGetResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio 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<WorkspaceSubscriptionGetResponse>
getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)
Ottiene la versione dello stato dell'entità (Etag) della sottoscrizione apimanagement specificata dal relativo identificatore.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetEntityTagOptionalParams): Promise<WorkspaceSubscriptionGetEntityTagHeaders>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio 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
list(string, string, string, WorkspaceSubscriptionListOptionalParams)
Elenca tutte le sottoscrizioni dell'area di lavoro in un'istanza del servizio Gestione API.
function list(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)
Ottiene le chiavi di sottoscrizione specificate.
function listSecrets(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionListSecretsOptionalParams): Promise<WorkspaceSubscriptionListSecretsResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio 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
regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)
Rigenera la chiave primaria della sottoscrizione esistente dell'area di lavoro in un'istanza del servizio Gestione API.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio 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, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)
Rigenera la chiave secondaria della sottoscrizione esistente dell'area di lavoro in un'istanza del servizio Gestione API.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio 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, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)
Aggiorna i dettagli di una sottoscrizione specificata dal relativo identificatore.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: WorkspaceSubscriptionUpdateOptionalParams): Promise<WorkspaceSubscriptionUpdateResponse>Parametri
- resourceGroupName
-
string
Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
- serviceName
-
string
Nome del servizio Gestione API.
- workspaceId
-
string
Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio 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 dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.
- parameters
- SubscriptionUpdateParameters
Aggiornare i parametri.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceSubscriptionUpdateResponse>