Service/abonnements Microsoft.ApiManagement 2023-03-01-preview
Définition de ressource Bicep
Le type de ressource service/abonnements peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir 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 des ressources
Pour créer une ressource Microsoft.ApiManagement/service/subscriptions, ajoutez le Bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2023-03-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
Valeurs de propriétés
service/subscriptions
| Nom | Description | Valeur |
|---|---|---|
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep. |
chaîne (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique. |
| parent | Dans Bicep, vous pouvez spécifier la ressource parente pour 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 |
| properties | Propriétés du contrat d’abonnement. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| Nom | Description | Valeur |
|---|---|---|
| allowTracing | Détermine si le suivi peut être activé | bool |
| displayName | Nom de l’abonnement. | chaîne (obligatoire) |
| ownerId | Utilisateur (chemin d’id utilisateur) pour lequel l’abonnement est créé au format /users/{userId} | string |
| primaryKey | Clé d’abonnement primaire. Si elle n’est pas spécifiée pendant la requête, la clé est générée automatiquement. | string |
| scope | É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 requête, la clé est générée automatiquement. | string |
| state | É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 les 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ée - 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é. | 'active' 'annulé' 'expiré' 'rejeté' 'soumis' 'suspendu' |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
Créer une instance de Gestion des API et toutes les sous-ressources à l’aide d’un modèle |
Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités |
Définition de ressources de modèle ARM
Le type de ressource service/abonnements peut être déployé avec des opérations qui ciblent :
- Groupes de ressources - Voir 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 des ressources
Pour créer une ressource Microsoft.ApiManagement/service/subscriptions, 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és
service/subscriptions
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ApiManagement/service/subscriptions » |
| apiVersion | Version de l’API de ressource | « 2023-03-01-preview » |
| name | Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON. |
string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique. |
| properties | Propriétés du contrat d’abonnement. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| Nom | Description | Valeur |
|---|---|---|
| allowTracing | Détermine si le suivi peut être activé | bool |
| displayName | Nom de l’abonnement. | string (obligatoire) |
| ownerId | Utilisateur (chemin d’identification utilisateur) pour lequel l’abonnement est créé sous la forme /users/{userId} | string |
| primaryKey | Clé d’abonnement primaire. Si elle n’est pas spécifiée pendant la requête, la clé est générée automatiquement. | string |
| scope | Étendue comme /products/{productId} ou /apis ou /apis/{apiId}. | string (obligatoire) |
| secondaryKey | Clé d’abonnement secondaire. Si elle n’est pas spécifiée pendant la requête, la clé est générée automatiquement. | string |
| state | É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 les 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ée - 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é. | 'active' 'cancelled' 'expiré' 'rejected' 'soumis' 'suspendu' |
Modèles de démarrage rapide
Les modèles de démarrage rapide suivants déploient ce type de ressource.
| Modèle | Description |
|---|---|
| Créer une instance de Gestion des API et toutes les sous-ressources à l’aide d’un modèle |
Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource 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 d’API, consultez journal des modifications.
Format des ressources
Pour créer une ressource Microsoft.ApiManagement/service/subscriptions, ajoutez le Terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/subscriptions@2023-03-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
allowTracing = bool
displayName = "string"
ownerId = "string"
primaryKey = "string"
scope = "string"
secondaryKey = "string"
state = "string"
}
})
}
Valeurs de propriétés
service/subscriptions
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ApiManagement/service/subscriptions@2023-03-01-preview » |
| name | Nom de la ressource | string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique. |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : service |
| properties | Propriétés du contrat d’abonnement. | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| Nom | Description | Valeur |
|---|---|---|
| allowTracing | Détermine si le suivi peut être activé | bool |
| displayName | Nom de l’abonnement. | string (obligatoire) |
| ownerId | Utilisateur (chemin d’identification utilisateur) pour lequel l’abonnement est créé sous la forme /users/{userId} | string |
| primaryKey | Clé d’abonnement primaire. Si elle n’est pas spécifiée pendant la requête, la clé est générée automatiquement. | string |
| scope | Étendue comme /products/{productId} ou /apis ou /apis/{apiId}. | string (obligatoire) |
| secondaryKey | Clé d’abonnement secondaire. Si elle n’est pas spécifiée pendant la requête, la clé est générée automatiquement. | string |
| state | É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 les 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ée - 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é. | « active » « annulé » « expiré » « rejeté » « soumis » « suspendu » |