Service Microsoft.ApiManagement/abonnements 2016-07-07
- dernière
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Définition de ressource Bicep
Le type de ressource de service/abonnements peut être déployé avec des opérations qui ciblent :
- groupes de ressources - Consultez commandes de déploiement de 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 bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2016-07-07' = {
parent: resourceSymbolicName
name: 'string'
primaryKey: 'string'
productId: 'string'
secondaryKey: 'string'
state: 'string'
userId: 'string'
}
Valeurs de propriété
Microsoft.ApiManagement/service/abonnements
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 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 |
| 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 |
| Productid | Produit (chemin d’accès d’ID de produit) pour lequel l’abonnement est créé sous forme /products/{productId} | 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' |
| userId | Utilisateur (chemin d’accès de l’ID utilisateur) pour lequel l’abonnement est créé sous la forme /users/{uid} | chaîne (obligatoire) |
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 :
- groupes de ressources - Consultez commandes de déploiement de 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 code JSON suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/service/subscriptions",
"apiVersion": "2016-07-07",
"name": "string",
"primaryKey": "string",
"productId": "string",
"secondaryKey": "string",
"state": "string",
"userId": "string"
}
Valeurs de propriété
Microsoft.ApiManagement/service/abonnements
| Nom | Description | Valeur |
|---|---|---|
| apiVersion | Version de l’API | '2016-07-07' |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[^*#&+:<>?]+$ (obligatoire) |
| 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 |
| Productid | Produit (chemin d’accès d’ID de produit) pour lequel l’abonnement est créé sous forme /products/{productId} | 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' |
| type | Type de ressource | 'Microsoft.ApiManagement/service/subscriptions' |
| userId | Utilisateur (chemin d’accès de l’ID utilisateur) pour lequel l’abonnement est créé sous la forme /users/{uid} | chaîne (obligatoire) |
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@2016-07-07"
name = "string"
primaryKey = "string"
productId = "string"
secondaryKey = "string"
state = "string"
userId = "string"
}