WorkspaceSubscription interface
Interface représentant un WorkspaceSubscription.
Méthodes
Détails de la méthode
createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)
Crée ou met à jour de l’abonnement de l’utilisateur spécifié au produit spécifié.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, parameters: SubscriptionCreateParameters, options?: WorkspaceSubscriptionCreateOrUpdateOptionalParams): Promise<WorkspaceSubscriptionCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- sid
-
string
Identificateur d’entité d’abonnement. L’entité représente l’association entre un utilisateur et un produit dans Gestion des API.
- parameters
- SubscriptionCreateParameters
Créez des paramètres.
Paramètres d’options.
Retours
delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)
Supprime l’abonnement spécifié.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, options?: WorkspaceSubscriptionDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- sid
-
string
Identificateur d’entité d’abonnement. L’entité représente l’association entre un utilisateur et un produit dans Gestion des API.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)
Obtient l’entité d’abonnement spécifiée.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetOptionalParams): Promise<WorkspaceSubscriptionGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- sid
-
string
Identificateur d’entité d’abonnement. L’entité représente l’association entre un utilisateur et un produit dans Gestion des API.
Paramètres d’options.
Retours
Promise<WorkspaceSubscriptionGetResponse>
getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) de l’abonnement apimanagement spécifié par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetEntityTagOptionalParams): Promise<WorkspaceSubscriptionGetEntityTagHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- sid
-
string
Identificateur d’entité d’abonnement. L’entité représente l’association entre un utilisateur et un produit dans Gestion des API.
Paramètres d’options.
Retours
list(string, string, string, WorkspaceSubscriptionListOptionalParams)
Répertorie tous les abonnements de l’espace de travail dans une instance de service Gestion des API.
function list(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
Paramètres d’options.
Retours
listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)
Obtient les clés d’abonnement spécifiées.
function listSecrets(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionListSecretsOptionalParams): Promise<WorkspaceSubscriptionListSecretsResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- sid
-
string
Identificateur d’entité d’abonnement. L’entité représente l’association entre un utilisateur et un produit dans Gestion des API.
Paramètres d’options.
Retours
regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)
Régénère la clé primaire de l’abonnement existant de l’espace de travail dans une instance de service Gestion des API.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- sid
-
string
Identificateur d’entité d’abonnement. L’entité représente l’association entre un utilisateur et un produit dans Gestion des API.
Paramètres d’options.
Retours
Promise<void>
regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)
Régénère la clé secondaire de l’abonnement existant de l’espace de travail dans une instance de service Gestion des API.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- sid
-
string
Identificateur d’entité d’abonnement. L’entité représente l’association entre un utilisateur et un produit dans Gestion des API.
Paramètres d’options.
Retours
Promise<void>
update(string, string, string, string, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)
Met à jour les détails d’un abonnement spécifié par son identificateur.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: WorkspaceSubscriptionUpdateOptionalParams): Promise<WorkspaceSubscriptionUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom du service Gestion des API.
- workspaceId
-
string
Identificateur de l’espace de travail. Doit être unique dans l’instance actuelle du service Gestion des API.
- sid
-
string
Identificateur d’entité d’abonnement. L’entité représente l’association entre un utilisateur et un produit dans Gestion des API.
- ifMatch
-
string
ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- parameters
- SubscriptionUpdateParameters
Mettez à jour les paramètres.
Paramètres d’options.
Retours
Promise<WorkspaceSubscriptionUpdateResponse>