WorkspaceSubscription interface

Paket:

@azure/arm-apimanagement

Schnittstelle, die ein WorkspaceSubscription darstellt.

Methoden

createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)	Erstellt oder aktualisiert das Abonnement des angegebenen Benutzers für das angegebene Produkt
delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)	Löscht das angegebene Abonnement
get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)	Ruft die angegebene Abonnemententität ab.
getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)	Ruft die Entitätsstatusversion (Etag) des apimanagement-Abonnements ab, das durch seinen Bezeichner angegeben wird.
list(string, string, string, WorkspaceSubscriptionListOptionalParams)	Listet alle Abonnements des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz auf.
listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)	Ruft die angegebenen Abonnementschlüssel ab.
regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)	Generiert primären Schlüssel des vorhandenen Abonnements des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz.
regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)	Generiert sekundären Schlüssel des vorhandenen Abonnements des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz.
update(string, string, string, string, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)	Aktualisiert die Details eines Abonnements, das durch seinen Bezeichner angegeben ist.

Details zur Methode

createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)

Erstellt oder aktualisiert das Abonnement des angegebenen Benutzers für das angegebene Produkt

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, parameters: SubscriptionCreateParameters, options?: WorkspaceSubscriptionCreateOrUpdateOptionalParams): Promise<WorkspaceSubscriptionCreateOrUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

sid

string

Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in der API-Verwaltung dar.

parameters

SubscriptionCreateParameters

Erstellen Sie Parameter.

options

WorkspaceSubscriptionCreateOrUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceSubscriptionCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)

Löscht das angegebene Abonnement

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, options?: WorkspaceSubscriptionDeleteOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

sid

string

Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in der API-Verwaltung dar.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

options

WorkspaceSubscriptionDeleteOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)

Ruft die angegebene Abonnemententität ab.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetOptionalParams): Promise<WorkspaceSubscriptionGetResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

sid

string

Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in der API-Verwaltung dar.

options

WorkspaceSubscriptionGetOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceSubscriptionGetResponse>

getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)

Ruft die Entitätsstatusversion (Etag) des apimanagement-Abonnements ab, das durch seinen Bezeichner angegeben wird.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetEntityTagOptionalParams): Promise<WorkspaceSubscriptionGetEntityTagHeaders>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

sid

string

Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in der API-Verwaltung dar.

options

WorkspaceSubscriptionGetEntityTagOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceSubscriptionGetEntityTagHeaders>

list(string, string, string, WorkspaceSubscriptionListOptionalParams)

Listet alle Abonnements des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz auf.

function list(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

options

WorkspaceSubscriptionListOptionalParams

Die Optionsparameter.

Gibt zurück

PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>

listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)

Ruft die angegebenen Abonnementschlüssel ab.

function listSecrets(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionListSecretsOptionalParams): Promise<WorkspaceSubscriptionListSecretsResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

sid

string

Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in der API-Verwaltung dar.

options

WorkspaceSubscriptionListSecretsOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceSubscriptionListSecretsResponse>

regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)

Generiert primären Schlüssel des vorhandenen Abonnements des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz.

function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

sid

string

Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in der API-Verwaltung dar.

options

WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)

Generiert sekundären Schlüssel des vorhandenen Abonnements des Arbeitsbereichs in einer API-Verwaltungsdienstinstanz.

function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

sid

string

Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in der API-Verwaltung dar.

options

WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<void>

update(string, string, string, string, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)

Aktualisiert die Details eines Abonnements, das durch seinen Bezeichner angegeben ist.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: WorkspaceSubscriptionUpdateOptionalParams): Promise<WorkspaceSubscriptionUpdateResponse>

Parameter

resourceGroupName

string

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

serviceName

string

Der Name des API-Verwaltungsdiensts.

workspaceId

string

Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.

sid

string

Abonnemententitätsbezeichner. Die Entität stellt die Zuordnung zwischen einem Benutzer und einem Produkt in der API-Verwaltung dar.

ifMatch

string

ETag der Entität. ETag sollte mit dem aktuellen Entitätsstatus aus der Headerantwort der GET-Anforderung übereinstimmen, oder es sollte * für bedingungslose Aktualisierung sein.

parameters

SubscriptionUpdateParameters

Aktualisieren von Parametern.

options

WorkspaceSubscriptionUpdateOptionalParams

Die Optionsparameter.

Gibt zurück

Promise<WorkspaceSubscriptionUpdateResponse>