Service/espaces de travail/produits Microsoft.ApiManagement
Définition de ressource Bicep
Le type de ressource de service/espaces de travail/produits 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/workspaces/products, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/products@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
approvalRequired: bool
description: 'string'
displayName: 'string'
state: 'string'
subscriptionRequired: bool
subscriptionsLimit: int
terms: 'string'
}
}
Valeurs de propriété
service/espaces de travail/produits
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans Bicep. |
chaîne (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 : espaces de travail |
| Propriétés | Propriétés du contrat d’entité de produit. | ProductContractProperties |
ProductContractProperties
| Nom | Description | Valeur |
|---|---|---|
| approvalRequired | si l’approbation de l’abonnement est requise. Si la valeur est false, les nouveaux abonnements sont approuvés automatiquement pour permettre aux développeurs d’appeler les API du produit immédiatement après l’abonnement. Si la valeur est true, les administrateurs doivent approuver manuellement l’abonnement avant que le développeur puisse effectuer l’une des API du produit. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false. | Bool |
| description | Description du produit. Peut inclure des balises de mise en forme HTML. | corde Contraintes: Longueur maximale = 1 000 |
| displayName | Nom du produit. | chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 300 |
| état | si le produit est publié ou non. Les produits publiés sont détectables par les utilisateurs du portail des développeurs. Les produits non publiés ne sont visibles que par les administrateurs. L’état par défaut du produit n’est pas Publié. | 'notPubliée' 'publié' |
| subscriptionRequired | Indique si un abonnement produit est requis pour accéder aux API incluses dans ce produit. Si la valeur est true, le produit est appelé « protégé » et une clé d’abonnement valide est requise pour qu’une demande adressée à une API incluse dans le produit réussisse. Si la valeur est false, le produit est appelé « ouvert » et les demandes adressées à une API incluse dans le produit peuvent être effectuées sans clé d’abonnement. Si la propriété est omise lors de la création d’un produit, sa valeur est supposée être true. | Bool |
| subscriptionsLimit | Indique si le nombre d’abonnements qu’un utilisateur peut avoir à ce produit en même temps. Définissez la valeur Null ou omettez pour autoriser un nombre illimité d’abonnements par utilisateur. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false. | Int |
| petits caractères | Conditions d’utilisation du produit. Les développeurs qui essaient de s’abonner au produit sont présentés et doivent accepter ces conditions avant de pouvoir terminer le processus d’abonnement. | corde |
Définition de ressource de modèle ARM
Le type de ressource de service/espaces de travail/produits 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/workspaces/products, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/service/workspaces/products",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
Valeurs de propriété
service/espaces de travail/produits
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | 'Microsoft.ApiManagement/service/workspaces/products' |
| apiVersion | Version de l’API de ressource | '2023-09-01-preview' |
| nom | Nom de la ressource Découvrez comment définir des noms et des types pour les ressources enfants dans modèles ARM JSON. |
chaîne (obligatoire) |
| Propriétés | Propriétés du contrat d’entité de produit. | ProductContractProperties |
ProductContractProperties
| Nom | Description | Valeur |
|---|---|---|
| approvalRequired | si l’approbation de l’abonnement est requise. Si la valeur est false, les nouveaux abonnements sont approuvés automatiquement pour permettre aux développeurs d’appeler les API du produit immédiatement après l’abonnement. Si la valeur est true, les administrateurs doivent approuver manuellement l’abonnement avant que le développeur puisse effectuer l’une des API du produit. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false. | Bool |
| description | Description du produit. Peut inclure des balises de mise en forme HTML. | corde Contraintes: Longueur maximale = 1 000 |
| displayName | Nom du produit. | chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 300 |
| état | si le produit est publié ou non. Les produits publiés sont détectables par les utilisateurs du portail des développeurs. Les produits non publiés ne sont visibles que par les administrateurs. L’état par défaut du produit n’est pas Publié. | 'notPubliée' 'publié' |
| subscriptionRequired | Indique si un abonnement produit est requis pour accéder aux API incluses dans ce produit. Si la valeur est true, le produit est appelé « protégé » et une clé d’abonnement valide est requise pour qu’une demande adressée à une API incluse dans le produit réussisse. Si la valeur est false, le produit est appelé « ouvert » et les demandes adressées à une API incluse dans le produit peuvent être effectuées sans clé d’abonnement. Si la propriété est omise lors de la création d’un produit, sa valeur est supposée être true. | Bool |
| subscriptionsLimit | Indique si le nombre d’abonnements qu’un utilisateur peut avoir à ce produit en même temps. Définissez la valeur Null ou omettez pour autoriser un nombre illimité d’abonnements par utilisateur. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false. | Int |
| petits caractères | Conditions d’utilisation du produit. Les développeurs qui essaient de s’abonner au produit sont présentés et doivent accepter ces conditions avant de pouvoir terminer le processus d’abonnement. | corde |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource de service/espaces de travail/produits 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/workspaces/products, ajoutez la terraform suivante à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/products@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
approvalRequired = bool
description = "string"
displayName = "string"
state = "string"
subscriptionRequired = bool
subscriptionsLimit = int
terms = "string"
}
})
}
Valeurs de propriété
service/espaces de travail/produits
| Nom | Description | Valeur |
|---|---|---|
| type | Type de ressource | « Microsoft.ApiManagement/service/workspaces/products@2023-09-01-preview » |
| nom | Nom de la ressource | chaîne (obligatoire) |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : espaces de travail |
| Propriétés | Propriétés du contrat d’entité de produit. | ProductContractProperties |
ProductContractProperties
| Nom | Description | Valeur |
|---|---|---|
| approvalRequired | si l’approbation de l’abonnement est requise. Si la valeur est false, les nouveaux abonnements sont approuvés automatiquement pour permettre aux développeurs d’appeler les API du produit immédiatement après l’abonnement. Si la valeur est true, les administrateurs doivent approuver manuellement l’abonnement avant que le développeur puisse effectuer l’une des API du produit. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false. | Bool |
| description | Description du produit. Peut inclure des balises de mise en forme HTML. | corde Contraintes: Longueur maximale = 1 000 |
| displayName | Nom du produit. | chaîne (obligatoire) Contraintes: Longueur minimale = 1 Longueur maximale = 300 |
| état | si le produit est publié ou non. Les produits publiés sont détectables par les utilisateurs du portail des développeurs. Les produits non publiés ne sont visibles que par les administrateurs. L’état par défaut du produit n’est pas Publié. | « notPublié » « publié » |
| subscriptionRequired | Indique si un abonnement produit est requis pour accéder aux API incluses dans ce produit. Si la valeur est true, le produit est appelé « protégé » et une clé d’abonnement valide est requise pour qu’une demande adressée à une API incluse dans le produit réussisse. Si la valeur est false, le produit est appelé « ouvert » et les demandes adressées à une API incluse dans le produit peuvent être effectuées sans clé d’abonnement. Si la propriété est omise lors de la création d’un produit, sa valeur est supposée être true. | Bool |
| subscriptionsLimit | Indique si le nombre d’abonnements qu’un utilisateur peut avoir à ce produit en même temps. Définissez la valeur Null ou omettez pour autoriser un nombre illimité d’abonnements par utilisateur. Peut être présent uniquement si la propriété subscriptionRequired est présente et a la valeur false. | Int |
| petits caractères | Conditions d’utilisation du produit. Les développeurs qui essaient de s’abonner au produit sont présentés et doivent accepter ces conditions avant de pouvoir terminer le processus d’abonnement. | corde |