Service/passerelles Microsoft.ApiManagement 2020-12-01
Définition de ressource Bicep
Le type de ressource de service/passerelles 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/gateways, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/service/gateways@2020-12-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
locationData: {
city: 'string'
countryOrRegion: 'string'
district: 'string'
name: 'string'
}
}
}
Valeurs de la propriété
GatewayContractProperties
| Nom | Description | Valeur |
|---|---|---|
| description | Description de la passerelle | corde Contraintes: Longueur maximale = 1 000 |
| locationData | Emplacement de la passerelle. | ResourceLocationDataContract |
Microsoft.ApiManagement/service/passerelles
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 80 (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 | Détails de la passerelle. | GatewayContractProperties |
ResourceLocationDataContract
| Nom | Description | Valeur |
|---|---|---|
| ville | Ville ou localité où se trouve la ressource. | corde Contraintes: Longueur maximale = 256 |
| countryOrRegion | Pays ou région où se trouve la ressource. | corde Contraintes: Longueur maximale = 256 |
| district | Le district, l’État ou la province où se trouve la ressource. | corde Contraintes: Longueur maximale = 256 |
| nom | Nom canonique pour l’emplacement géographique ou physique. | corde Contraintes: Longueur maximale = 256 (obligatoire) |
Exemples d’utilisation
Exemples de démarrage rapide Azure
Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.
| Fichier Bicep | Description |
|---|---|
| Créer une gestion des API dans un réseau virtuel interne avec app Gateway | Ce modèle montre comment créer une instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway. |
Définition de ressource de modèle ARM
Le type de ressource de service/passerelles 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/passerelles, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/service/gateways",
"apiVersion": "2020-12-01",
"name": "string",
"properties": {
"description": "string",
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
}
}
}
Valeurs de la propriété
GatewayContractProperties
| Nom | Description | Valeur |
|---|---|---|
| description | Description de la passerelle | corde Contraintes: Longueur maximale = 1 000 |
| locationData | Emplacement de la passerelle. | ResourceLocationDataContract |
Microsoft.ApiManagement/service/passerelles
| Nom | Description | Valeur |
|---|---|---|
| apiVersion | Version de l’API | '2020-12-01' |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 80 (obligatoire) |
| Propriétés | Détails de la passerelle. | GatewayContractProperties |
| type | Type de ressource | 'Microsoft.ApiManagement/service/gateways' |
ResourceLocationDataContract
| Nom | Description | Valeur |
|---|---|---|
| ville | Ville ou localité où se trouve la ressource. | corde Contraintes: Longueur maximale = 256 |
| countryOrRegion | Pays ou région où se trouve la ressource. | corde Contraintes: Longueur maximale = 256 |
| district | Le district, l’État ou la province où se trouve la ressource. | corde Contraintes: Longueur maximale = 256 |
| nom | Nom canonique pour l’emplacement géographique ou physique. | corde Contraintes: Longueur maximale = 256 (obligatoire) |
Exemples d’utilisation
Modèles de démarrage rapide Microsoft Azure
Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.
| Modèle | Description |
|---|---|
Créer une gestion des API dans un réseau virtuel interne avec app Gateway
|
Ce modèle montre comment créer une instance de Gestion des API Azure sur un réseau privé protégé par Azure Application Gateway. |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource de service/passerelles 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/gateways, ajoutez le terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/gateways@2020-12-01"
name = "string"
body = jsonencode({
properties = {
description = "string"
locationData = {
city = "string"
countryOrRegion = "string"
district = "string"
name = "string"
}
}
})
}
Valeurs de la propriété
GatewayContractProperties
| Nom | Description | Valeur |
|---|---|---|
| description | Description de la passerelle | corde Contraintes: Longueur maximale = 1 000 |
| locationData | Emplacement de la passerelle. | ResourceLocationDataContract |
Microsoft.ApiManagement/service/passerelles
| Nom | Description | Valeur |
|---|---|---|
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 80 (obligatoire) |
| parent_id | ID de la ressource qui est le parent de cette ressource. | ID de ressource de type : de service |
| Propriétés | Détails de la passerelle. | GatewayContractProperties |
| type | Type de ressource | « Microsoft.ApiManagement/service/gateways@2020-12-01 » |
ResourceLocationDataContract
| Nom | Description | Valeur |
|---|---|---|
| ville | Ville ou localité où se trouve la ressource. | corde Contraintes: Longueur maximale = 256 |
| countryOrRegion | Pays ou région où se trouve la ressource. | corde Contraintes: Longueur maximale = 256 |
| district | Le district, l’État ou la province où se trouve la ressource. | corde Contraintes: Longueur maximale = 256 |
| nom | Nom canonique pour l’emplacement géographique ou physique. | corde Contraintes: Longueur maximale = 256 (obligatoire) |