Partager via

Service/produits Microsoft.ApiManagement

  • Article

Définition de ressource Bicep

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

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/products, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-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és

service/products

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 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 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’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, ce qui permet 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 utiliser 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 comporter des balises de mise en forme. string
displayName Nom du produit. string (obligatoire)
state si le produit est publié ou non. Les produits publiés peuvent être découverts 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 de Product est notPublished. 'notPublished'
'publié'
subscriptionRequired Indique si un abonnement au 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 nécessaire 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 sur 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
terms Conditions d’utilisation du produit. Les développeurs qui veulent s’abonner au produit devront consulter et accepter ces conditions pour pouvoir terminer le processus d’abonnement. string

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

Déployer sur Azure		 Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités
Créer Azure Front Door devant Azure Gestion des API

Déployer sur Azure		 Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Azure Gestion des API.

Définition de ressources de modèle ARM

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

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/products, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

Valeurs de propriétés

service/products

Nom Description Valeur
type Type de ressource 'Microsoft.ApiManagement/service/products'
apiVersion Version de l’API de ressource '2023-05-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’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, ce qui permet 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 utiliser 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 comporter des balises de mise en forme. string
displayName Nom du produit. string (obligatoire)
state si le produit est publié ou non. Les produits publiés peuvent être découverts 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 de Product est notPublished. 'notPublished'
'publié'
subscriptionRequired Indique si un abonnement au 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 nécessaire 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 sur 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
terms Conditions d’utilisation du produit. Les développeurs qui veulent s’abonner au produit devront consulter et accepter ces conditions pour pouvoir terminer le processus d’abonnement. string

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

Déployer sur Azure		 Ce modèle montre comment créer un service Gestion des API et configurer des sous-entités
Créer Azure Front Door devant Azure Gestion des API

Déployer sur Azure		 Cet exemple montre comment utiliser Azure Front Door comme équilibreur de charge global devant Azure Gestion des API.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource service/products 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/products, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-05-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és

service/products

Nom Description Valeur
type Type de ressource « Microsoft.ApiManagement/service/products@2023-05-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’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, ce qui permet 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 utiliser 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 comporter des balises de mise en forme. string
displayName Nom du produit. string (obligatoire)
state si le produit est publié ou non. Les produits publiés peuvent être découverts 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 de Product est notPublished. « notPublished »
« publié »
subscriptionRequired Indique si un abonnement au 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 nécessaire 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 sur 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
terms Conditions d’utilisation du produit. Les développeurs qui veulent s’abonner au produit devront consulter et accepter ces conditions pour pouvoir terminer le processus d’abonnement. string