Partager via

Service/abonnements Microsoft.ApiManagement 2023-03-01-preview

  • Article

Définition de ressource Bicep

Le type de ressource de service/abonnements peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiManagement/service/abonnements, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2023-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

Valeurs de propriété

Microsoft.ApiManagement/service/abonnements

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur maximale =
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : service
Propriétés Propriétés du contrat d’abonnement. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Nom Description Valeur
allowTracing Détermine si le suivi peut être activé Bool
displayName Nom de l’abonnement. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
ownerId Utilisateur (chemin d’accès de l’ID utilisateur) pour lequel l’abonnement est créé sous la forme /users/{userId} corde
primaryKey Clé d’abonnement principale. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
portée Étendue comme /products/{productId} ou /apis ou /apis/{apiId}. chaîne (obligatoire)
secondaryKey Clé d’abonnement secondaire. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
état État initial de l’abonnement. Si aucune valeur n’est spécifiée, l’abonnement est créé avec l’état Soumis. 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é. 'actif'
'annulé'
'expiré'
'rejeté'
'soumis'
'suspendu'

Définition de ressource de modèle ARM

Le type de ressource de service/abonnements peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiManagement/service/abonnements, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

Valeurs de propriété

Microsoft.ApiManagement/service/abonnements

Nom Description Valeur
apiVersion Version de l’API '2023-03-01-preview'
nom Nom de la ressource corde

Contraintes:
Longueur maximale =
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
Propriétés Propriétés du contrat d’abonnement. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
type Type de ressource 'Microsoft.ApiManagement/service/subscriptions'

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Nom Description Valeur
allowTracing Détermine si le suivi peut être activé Bool
displayName Nom de l’abonnement. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
ownerId Utilisateur (chemin d’accès de l’ID utilisateur) pour lequel l’abonnement est créé sous la forme /users/{userId} corde
primaryKey Clé d’abonnement principale. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
portée Étendue comme /products/{productId} ou /apis ou /apis/{apiId}. chaîne (obligatoire)
secondaryKey Clé d’abonnement secondaire. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
état État initial de l’abonnement. Si aucune valeur n’est spécifiée, l’abonnement est créé avec l’état Soumis. 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é. 'actif'
'annulé'
'expiré'
'rejeté'
'soumis'
'suspendu'

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource de service/abonnements peut être déployé avec des opérations qui ciblent :

  • groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.ApiManagement/service/abonnements, ajoutez le terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/subscriptions@2023-03-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      allowTracing = bool
      displayName = "string"
      ownerId = "string"
      primaryKey = "string"
      scope = "string"
      secondaryKey = "string"
      state = "string"
    }
  })
}

Valeurs de propriété

Microsoft.ApiManagement/service/abonnements

Nom Description Valeur
nom Nom de la ressource corde

Contraintes:
Longueur maximale =
Modèle = ^[^*#&+:<>?]+$ (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : de service
Propriétés Propriétés du contrat d’abonnement. SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties
type Type de ressource « Microsoft.ApiManagement/service/subscriptions@2023-03-01-preview »

SubscriptionCreateParameterPropertiesOrSubscriptionContractProperties

Nom Description Valeur
allowTracing Détermine si le suivi peut être activé Bool
displayName Nom de l’abonnement. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1 (obligatoire)
ownerId Utilisateur (chemin d’accès de l’ID utilisateur) pour lequel l’abonnement est créé sous la forme /users/{userId} corde
primaryKey Clé d’abonnement principale. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
portée Étendue comme /products/{productId} ou /apis ou /apis/{apiId}. chaîne (obligatoire)
secondaryKey Clé d’abonnement secondaire. Si elle n’est pas spécifiée pendant la clé de requête, elle est générée automatiquement. corde

Contraintes:
Longueur minimale = 1
Longueur maximale = 1
état État initial de l’abonnement. Si aucune valeur n’est spécifiée, l’abonnement est créé avec l’état Soumis. 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é. 'actif'
'annulé'
'expiré'
'rejeté'
'soumis'
'suspendu'