Passerelles Microsoft.ApiManagement 2024-05-01
Définition de ressource Bicep
Le type de ressource des 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/passerelles, ajoutez le bicep suivant à votre modèle.
resource symbolicname 'Microsoft.ApiManagement/gateways@2024-05-01' = {
location: 'string'
name: 'string'
properties: {
backend: {
subnet: {
id: 'string'
}
}
configurationApi: {}
frontend: {}
virtualNetworkType: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Valeurs de propriété
ApiManagementGatewayProperties
| Nom | Description | Valeur |
|---|---|---|
| back-end | Informations sur la façon dont la passerelle doit s’intégrer aux systèmes principaux. | BackendConfiguration |
| configurationApi | Informations relatives à l’API Configuration de la passerelle Gestion des API. Cela s’applique uniquement à la passerelle d’API avec une référence SKU Standard. | GatewayConfigurationApi |
| frontend | Informations sur la façon dont la passerelle doit être exposée. | FrontendConfiguration |
| virtualNetworkType | Type de VPN dans lequel la passerelle Gestion des API doit être configurée. | 'Externe' 'Interne' 'None' |
ApiManagementGatewaySkuProperties
| Nom | Description | Valeur |
|---|---|---|
| capacité | Capacité de la référence SKU (nombre d’unités déployées de la référence SKU) | Int |
| nom | Nom de la référence SKU. | 'Standard' 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (obligatoire) |
ApimResourceTags
| Nom | Description | Valeur |
|---|
BackendConfiguration
| Nom | Description | Valeur |
|---|---|---|
| sous-réseau | Nom d’hôte par défaut de la passerelle de plan de données vers laquelle les requêtes peuvent être envoyées. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Nom | Description | Valeur |
|---|---|---|
| id | ID ARM du sous-réseau dans lequel les systèmes principaux sont hébergés. | corde |
FrontendConfiguration
| Nom | Description | Valeur |
|---|
GatewayConfigurationApi
| Nom | Description | Valeur |
|---|
Microsoft.ApiManagement/passerelles
| Nom | Description | Valeur |
|---|---|---|
| emplacement | Emplacement des ressources. | chaîne (obligatoire) |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obligatoire) |
| Propriétés | Propriétés de la passerelle Gestion des API. | ApiManagementGatewayProperties (obligatoire) |
| Sku | Propriétés de référence SKU de la passerelle Gestion des API. | ApiManagementGatewaySkuProperties (obligatoire) |
| étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
Définition de ressource de modèle ARM
Le type de ressource des 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/passerelles, ajoutez le code JSON suivant à votre modèle.
{
"type": "Microsoft.ApiManagement/gateways",
"apiVersion": "2024-05-01",
"name": "string",
"location": "string",
"properties": {
"backend": {
"subnet": {
"id": "string"
}
},
"configurationApi": {
},
"frontend": {
},
"virtualNetworkType": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Valeurs de propriété
ApiManagementGatewayProperties
| Nom | Description | Valeur |
|---|---|---|
| back-end | Informations sur la façon dont la passerelle doit s’intégrer aux systèmes principaux. | BackendConfiguration |
| configurationApi | Informations relatives à l’API Configuration de la passerelle Gestion des API. Cela s’applique uniquement à la passerelle d’API avec une référence SKU Standard. | GatewayConfigurationApi |
| frontend | Informations sur la façon dont la passerelle doit être exposée. | FrontendConfiguration |
| virtualNetworkType | Type de VPN dans lequel la passerelle Gestion des API doit être configurée. | 'Externe' 'Interne' 'None' |
ApiManagementGatewaySkuProperties
| Nom | Description | Valeur |
|---|---|---|
| capacité | Capacité de la référence SKU (nombre d’unités déployées de la référence SKU) | Int |
| nom | Nom de la référence SKU. | 'Standard' 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (obligatoire) |
ApimResourceTags
| Nom | Description | Valeur |
|---|
BackendConfiguration
| Nom | Description | Valeur |
|---|---|---|
| sous-réseau | Nom d’hôte par défaut de la passerelle de plan de données vers laquelle les requêtes peuvent être envoyées. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Nom | Description | Valeur |
|---|---|---|
| id | ID ARM du sous-réseau dans lequel les systèmes principaux sont hébergés. | corde |
FrontendConfiguration
| Nom | Description | Valeur |
|---|
GatewayConfigurationApi
| Nom | Description | Valeur |
|---|
Microsoft.ApiManagement/passerelles
| Nom | Description | Valeur |
|---|---|---|
| apiVersion | Version de l’API | '2024-05-01' |
| emplacement | Emplacement des ressources. | chaîne (obligatoire) |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obligatoire) |
| Propriétés | Propriétés de la passerelle Gestion des API. | ApiManagementGatewayProperties (obligatoire) |
| Sku | Propriétés de référence SKU de la passerelle Gestion des API. | ApiManagementGatewaySkuProperties (obligatoire) |
| étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. Consultez les balises dans les modèles |
| type | Type de ressource | 'Microsoft.ApiManagement/gateways' |
Définition de ressource Terraform (fournisseur AzAPI)
Le type de ressource des 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/passerelles, ajoutez terraform suivant à votre modèle.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/gateways@2024-05-01"
name = "string"
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
backend = {
subnet = {
id = "string"
}
}
configurationApi = {
}
frontend = {
}
virtualNetworkType = "string"
}
})
}
Valeurs de propriété
ApiManagementGatewayProperties
| Nom | Description | Valeur |
|---|---|---|
| back-end | Informations sur la façon dont la passerelle doit s’intégrer aux systèmes principaux. | BackendConfiguration |
| configurationApi | Informations relatives à l’API Configuration de la passerelle Gestion des API. Cela s’applique uniquement à la passerelle d’API avec une référence SKU Standard. | GatewayConfigurationApi |
| frontend | Informations sur la façon dont la passerelle doit être exposée. | FrontendConfiguration |
| virtualNetworkType | Type de VPN dans lequel la passerelle Gestion des API doit être configurée. | 'Externe' 'Interne' 'None' |
ApiManagementGatewaySkuProperties
| Nom | Description | Valeur |
|---|---|---|
| capacité | Capacité de la référence SKU (nombre d’unités déployées de la référence SKU) | Int |
| nom | Nom de la référence SKU. | 'Standard' 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (obligatoire) |
ApimResourceTags
| Nom | Description | Valeur |
|---|
BackendConfiguration
| Nom | Description | Valeur |
|---|---|---|
| sous-réseau | Nom d’hôte par défaut de la passerelle de plan de données vers laquelle les requêtes peuvent être envoyées. | BackendSubnetConfiguration |
BackendSubnetConfiguration
| Nom | Description | Valeur |
|---|---|---|
| id | ID ARM du sous-réseau dans lequel les systèmes principaux sont hébergés. | corde |
FrontendConfiguration
| Nom | Description | Valeur |
|---|
GatewayConfigurationApi
| Nom | Description | Valeur |
|---|
Microsoft.ApiManagement/passerelles
| Nom | Description | Valeur |
|---|---|---|
| emplacement | Emplacement des ressources. | chaîne (obligatoire) |
| nom | Nom de la ressource | corde Contraintes: Longueur minimale = 1 Longueur maximale = 1 Modèle = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (obligatoire) |
| Propriétés | Propriétés de la passerelle Gestion des API. | ApiManagementGatewayProperties (obligatoire) |
| Sku | Propriétés de référence SKU de la passerelle Gestion des API. | ApiManagementGatewaySkuProperties (obligatoire) |
| étiquettes | Balises de ressource | Dictionnaire de noms et de valeurs d’étiquettes. |
| type | Type de ressource | « Microsoft.ApiManagement/gateways@2024-05-01 » |