SubscriptionContract interface

Paquet:

@azure/arm-apimanagement

Détails de l’abonnement.

Extends

ProxyResource

Propriétés

allowTracing	Détermine si le suivi est activé
createdDate	Date de création de l’abonnement. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601. REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
displayName	Nom de l’abonnement, ou null si l’abonnement n’a pas de nom.
endDate	Date d’annulation ou d’expiration de l’abonnement. Le paramètre est uniquement à des fins d’audit et l’abonnement n’est pas automatiquement annulé. Le cycle de vie de l’abonnement peut être géré à l’aide de la propriété state. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
expirationDate	Date d’expiration de l’abonnement. Le paramètre est à des fins d’audit uniquement et l’abonnement n’a pas expiré automatiquement. Le cycle de vie de l’abonnement peut être géré à l’aide de la propriété state. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
notificationDate	Date de notification d’expiration de l’abonnement à venir. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
ownerId	Identificateur de ressource utilisateur du propriétaire de l’abonnement. La valeur est une URL relative valide au format /users/{userId} où {userId} est un identificateur d’utilisateur.
primaryKey	Clé primaire d’abonnement. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.
scope	Étendue comme /products/{productId} ou /apis ou /apis/{apiId}.
secondaryKey	Clé secondaire d’abonnement. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.
startDate	Date d’activation de l’abonnement. Le paramètre est uniquement à des fins d’audit et l’abonnement n’est pas activé automatiquement. Le cycle de vie de l’abonnement peut être géré à l’aide de la propriété state. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.
state	État de l’abonnement. Les états possibles sont * actifs – l’abonnement est actif, * suspendu – l’abonnement est bloqué et l’abonné ne peut pas appeler d’API du produit, * envoyé – la demande d’abonnement a été effectuée par le développeur, mais n’a pas encore été approuvée ou rejetée, * rejeté – la demande d’abonnement a été refusée par un administrateur, * annulée – l’abonnement a été annulé par le développeur ou l’administrateur, * expiré : l’abonnement a atteint sa date d’expiration et a été désactivé.
stateComment	Commentaire d’abonnement facultatif ajouté par un administrateur lorsque l’état est remplacé par « rejeté ».

Propriétés héritées

id	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
name	Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.
type	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

Détails de la propriété

allowTracing

Détermine si le suivi est activé

allowTracing?: boolean

Valeur de propriété

boolean

createdDate

Date de création de l’abonnement. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.

REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

createdDate?: Date

Valeur de propriété

Date

displayName

Nom de l’abonnement, ou null si l’abonnement n’a pas de nom.

displayName?: string

Valeur de propriété

string

endDate

Date d’annulation ou d’expiration de l’abonnement. Le paramètre est uniquement à des fins d’audit et l’abonnement n’est pas automatiquement annulé. Le cycle de vie de l’abonnement peut être géré à l’aide de la propriété state. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.

endDate?: Date

Valeur de propriété

Date

expirationDate

Date d’expiration de l’abonnement. Le paramètre est à des fins d’audit uniquement et l’abonnement n’a pas expiré automatiquement. Le cycle de vie de l’abonnement peut être géré à l’aide de la propriété state. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.

expirationDate?: Date

Valeur de propriété

Date

notificationDate

Date de notification d’expiration de l’abonnement à venir. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.

notificationDate?: Date

Valeur de propriété

Date

ownerId

Identificateur de ressource utilisateur du propriétaire de l’abonnement. La valeur est une URL relative valide au format /users/{userId} où {userId} est un identificateur d’utilisateur.

ownerId?: string

Valeur de propriété

string

primaryKey

Clé primaire d’abonnement. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.

primaryKey?: string

Valeur de propriété

string

scope

Étendue comme /products/{productId} ou /apis ou /apis/{apiId}.

scope?: string

Valeur de propriété

string

secondaryKey

Clé secondaire d’abonnement. Cette propriété ne sera pas remplie sur les opérations « GET » ! Utilisez la requête POST « /listSecrets » pour obtenir la valeur.

secondaryKey?: string

Valeur de propriété

string

startDate

Date d’activation de l’abonnement. Le paramètre est uniquement à des fins d’audit et l’abonnement n’est pas activé automatiquement. Le cycle de vie de l’abonnement peut être géré à l’aide de la propriété state. La date est conforme au format suivant : yyyy-MM-ddTHH:mm:ssZ comme spécifié par la norme ISO 8601.

startDate?: Date

Valeur de propriété

Date

state

État de l’abonnement. Les états possibles sont * actifs – l’abonnement est actif, * suspendu – l’abonnement est bloqué et l’abonné ne peut pas appeler d’API du produit, * envoyé – la demande d’abonnement a été effectuée par le développeur, mais n’a pas encore été approuvée ou rejetée, * rejeté – la demande d’abonnement a été refusée par un administrateur, * annulée – l’abonnement a été annulé par le développeur ou l’administrateur, * expiré : l’abonnement a atteint sa date d’expiration et a été désactivé.

state?: SubscriptionState

Valeur de propriété

SubscriptionState

stateComment

Commentaire d’abonnement facultatif ajouté par un administrateur lorsque l’état est remplacé par « rejeté ».

stateComment?: string

Valeur de propriété

string

Détails de la propriété héritée

id

ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

id?: string

Valeur de propriété

string

héritée deProxyResource.id

name

Nom de la ressource REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

name?: string

Valeur de propriété

string

héritée deProxyResource.name

type

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts » REMARQUE : cette propriété ne sera pas sérialisée. Elle ne peut être remplie que par le serveur.

type?: string

Valeur de propriété

string

héritée deProxyResource.type