Subscription interface
Interface représentant un abonnement.
Méthodes
Détails de la méthode
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Crée ou met à jour de l’abonnement de l’utilisateur spécifié au produit spécifié.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom 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
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Supprime l’abonnement spécifié.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): 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.
- 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 d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- options
- SubscriptionDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Obtient l’entité Subscription spécifiée.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom 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.
- options
- SubscriptionGetOptionalParams
Paramètres d’options.
Retours
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Obtient la version d’état d’entité (Etag) de l’abonnement apimanagement spécifié par son identificateur.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom 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<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Répertorie tous les abonnements de l’instance de service de gestion des API.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): 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.
- options
- SubscriptionListOptionalParams
Paramètres d’options.
Retours
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Obtient les clés d’abonnement spécifiées.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom 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<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Régénère la clé primaire d’un abonnement existant de l’instance de service de gestion des API.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): 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.
- 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, SubscriptionRegenerateSecondaryKeyOptionalParams)
Régénère la clé secondaire d’un abonnement existant de l’instance de service de gestion des API.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): 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.
- 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, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Mises à jour les détails d’un abonnement spécifiés par son identificateur.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources. Le nom ne respecte pas la casse.
- serviceName
-
string
Nom 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 d’entité actuel de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.
- parameters
- SubscriptionUpdateParameters
Mettre à jour les paramètres.
- options
- SubscriptionUpdateOptionalParams
Paramètres d’options.
Retours
Promise<SubscriptionUpdateResponse>