Microsoft.ApiManagement-Gateways 2023-09-01-preview
Bicep-Ressourcendefinition
Der Gateways-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/gateways-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/gateways@2023-09-01-preview' = {
location: 'string'
name: 'string'
properties: {
backend: {
subnet: {
id: 'string'
}
}
configurationApi: {}
frontend: {}
virtualNetworkType: 'string'
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Eigenschaftswerte
ApiManagementGatewayProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Back-End | Informationen dazu, wie das Gateway in Back-End-Systeme integriert werden soll. | Back-EndConfiguration- |
| configurationApi | Informationen zur Konfigurations-API des API-Verwaltungsgateways. Dies gilt nur für API-Gateways mit Standard-SKU. | GatewayConfigurationApi- |
| Frontend | Informationen dazu, wie das Gateway verfügbar gemacht werden soll. | FrontendConfiguration- |
| virtualNetworkType | Der VPN-Typ, in dem das API-Verwaltungsgateway konfiguriert werden muss. | 'Extern' "Intern" 'None' |
ApiManagementGatewaySkuProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Fassungsvermögen | Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU) | Int |
| Name | Name der Sku. | "Standard" 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (erforderlich) |
ApimResourceTags
| Name | Beschreibung | Wert |
|---|
Back-EndConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| Subnetz | Der Standardhostname des Datenebenengateways, an das Anforderungen gesendet werden können. | Back-EndSubnetConfiguration- |
Back-EndSubnetConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| id | Die ARM-ID des Subnetzes, in dem die Back-End-Systeme gehostet werden. | Schnur |
FrontendConfiguration
| Name | Beschreibung | Wert |
|---|
GatewayConfigurationApi
| Name | Beschreibung | Wert |
|---|
Microsoft.ApiManagement/Gateways
| Name | Beschreibung | Wert |
|---|---|---|
| Ort | Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (erforderlich) |
| Eigenschaften | Eigenschaften des API-Verwaltungsgateways. | ApiManagementGatewayProperties (erforderlich) |
| Sku | SKU-Eigenschaften des API-Verwaltungsgateways. | ApiManagementGatewaySkuProperties (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
ARM-Vorlagenressourcendefinition
Der Gateways-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/Gateways-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/gateways",
"apiVersion": "2023-09-01-preview",
"name": "string",
"location": "string",
"properties": {
"backend": {
"subnet": {
"id": "string"
}
},
"configurationApi": {
},
"frontend": {
},
"virtualNetworkType": "string"
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Eigenschaftswerte
ApiManagementGatewayProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Back-End | Informationen dazu, wie das Gateway in Back-End-Systeme integriert werden soll. | Back-EndConfiguration- |
| configurationApi | Informationen zur Konfigurations-API des API-Verwaltungsgateways. Dies gilt nur für API-Gateways mit Standard-SKU. | GatewayConfigurationApi- |
| Frontend | Informationen dazu, wie das Gateway verfügbar gemacht werden soll. | FrontendConfiguration- |
| virtualNetworkType | Der VPN-Typ, in dem das API-Verwaltungsgateway konfiguriert werden muss. | 'Extern' "Intern" 'None' |
ApiManagementGatewaySkuProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Fassungsvermögen | Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU) | Int |
| Name | Name der Sku. | "Standard" 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (erforderlich) |
ApimResourceTags
| Name | Beschreibung | Wert |
|---|
Back-EndConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| Subnetz | Der Standardhostname des Datenebenengateways, an das Anforderungen gesendet werden können. | Back-EndSubnetConfiguration- |
Back-EndSubnetConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| id | Die ARM-ID des Subnetzes, in dem die Back-End-Systeme gehostet werden. | Schnur |
FrontendConfiguration
| Name | Beschreibung | Wert |
|---|
GatewayConfigurationApi
| Name | Beschreibung | Wert |
|---|
Microsoft.ApiManagement/Gateways
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | "2023-09-01-preview" |
| Ort | Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (erforderlich) |
| Eigenschaften | Eigenschaften des API-Verwaltungsgateways. | ApiManagementGatewayProperties (erforderlich) |
| Sku | SKU-Eigenschaften des API-Verwaltungsgateways. | ApiManagementGatewaySkuProperties (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. Siehe Tags in Vorlagen |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/gateways" |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Gateways-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/gateways-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/gateways@2023-09-01-preview"
name = "string"
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
backend = {
subnet = {
id = "string"
}
}
configurationApi = {
}
frontend = {
}
virtualNetworkType = "string"
}
})
}
Eigenschaftswerte
ApiManagementGatewayProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Back-End | Informationen dazu, wie das Gateway in Back-End-Systeme integriert werden soll. | Back-EndConfiguration- |
| configurationApi | Informationen zur Konfigurations-API des API-Verwaltungsgateways. Dies gilt nur für API-Gateways mit Standard-SKU. | GatewayConfigurationApi- |
| Frontend | Informationen dazu, wie das Gateway verfügbar gemacht werden soll. | FrontendConfiguration- |
| virtualNetworkType | Der VPN-Typ, in dem das API-Verwaltungsgateway konfiguriert werden muss. | 'Extern' "Intern" 'None' |
ApiManagementGatewaySkuProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Fassungsvermögen | Kapazität der SKU (Anzahl der bereitgestellten Einheiten der SKU) | Int |
| Name | Name der Sku. | "Standard" 'WorkspaceGatewayPremium' 'WorkspaceGatewayStandard' (erforderlich) |
ApimResourceTags
| Name | Beschreibung | Wert |
|---|
Back-EndConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| Subnetz | Der Standardhostname des Datenebenengateways, an das Anforderungen gesendet werden können. | Back-EndSubnetConfiguration- |
Back-EndSubnetConfiguration
| Name | Beschreibung | Wert |
|---|---|---|
| id | Die ARM-ID des Subnetzes, in dem die Back-End-Systeme gehostet werden. | Schnur |
FrontendConfiguration
| Name | Beschreibung | Wert |
|---|
GatewayConfigurationApi
| Name | Beschreibung | Wert |
|---|
Microsoft.ApiManagement/Gateways
| Name | Beschreibung | Wert |
|---|---|---|
| Ort | Ressourcenspeicherort. | Zeichenfolge (erforderlich) |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 Pattern = ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$ (erforderlich) |
| Eigenschaften | Eigenschaften des API-Verwaltungsgateways. | ApiManagementGatewayProperties (erforderlich) |
| Sku | SKU-Eigenschaften des API-Verwaltungsgateways. | ApiManagementGatewaySkuProperties (erforderlich) |
| Schilder | Ressourcentags | Wörterbuch der Tagnamen und -werte. |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/gateways@2023-09-01-preview" |