Microsoft.ApiManagement service/gateways 2022-04-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp Dienst/Gateways kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/gateways-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/gateways@2022-04-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
description: 'string'
locationData: {
city: 'string'
countryOrRegion: 'string'
district: 'string'
name: 'string'
}
}
}
Eigenschaftswerte
service/gateways
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen. |
Zeichenfolge (erforderlich) |
| parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: Dienst |
| properties | Gatewaydetails. | GatewayContractProperties |
GatewayContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Gatewaybeschreibung | Zeichenfolge |
| locationData | Gatewayspeicherort. | ResourceLocationDataContract |
ResourceLocationDataContract
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| city | Die Stadt oder den Ort, in dem sich die Ressource befindet. | Zeichenfolge |
| countryOrRegion | Das Land oder die Region, in dem sich die Ressource befindet. | Zeichenfolge |
| district | Der Distrikt, das Bundesland oder die Provinz, in dem sich die Ressource befindet. | Zeichenfolge |
| name | Ein kanonischer Name für den geografischen oder physischen Standort. | Zeichenfolge (erforderlich) |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
Erstellen API Management im internen VNET mit App Gateway |
In dieser Vorlage wird veranschaulicht, wie Sie eine instance von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt ist. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp Dienst/Gateways kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/gateways-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/gateways",
"apiVersion": "2022-04-01-preview",
"name": "string",
"properties": {
"description": "string",
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
}
}
}
Eigenschaftswerte
service/gateways
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.ApiManagement/service/gateways" |
| apiVersion | Die Ressourcen-API-Version | '2022-04-01-preview' |
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) |
| properties | Gatewaydetails. | GatewayContractProperties |
GatewayContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Gatewaybeschreibung | Zeichenfolge |
| locationData | Gatewayspeicherort. | ResourceLocationDataContract |
ResourceLocationDataContract
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| city | Die Stadt oder der Ort, in dem sich die Ressource befindet. | Zeichenfolge |
| countryOrRegion | Das Land oder die Region, in dem sich die Ressource befindet. | Zeichenfolge |
| district | Der Bezirk, das Bundesland oder die Provinz, in dem sich die Ressource befindet. | Zeichenfolge |
| name | Ein kanonischer Name für den geografischen oder physischen Standort. | Zeichenfolge (erforderlich) |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
| Vorlage | BESCHREIBUNG |
|---|---|
| Erstellen API Management im internen VNET mit App Gateway |
Diese Vorlage veranschaulicht, wie Sie eine instance von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt wird. |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp service/gateways kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/gateways-Ressource zu erstellen, fügen Sie Ihrer Vorlage den folgenden Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/gateways@2022-04-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
description = "string"
locationData = {
city = "string"
countryOrRegion = "string"
district = "string"
name = "string"
}
}
})
}
Eigenschaftswerte
service/gateways
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.ApiManagement/service/gateways@2022-04-01-preview" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ: Dienst |
| properties | Gatewaydetails. | GatewayContractProperties |
GatewayContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| description | Gatewaybeschreibung | Zeichenfolge |
| locationData | Gatewayspeicherort. | ResourceLocationDataContract |
ResourceLocationDataContract
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| city | Die Stadt oder der Ort, in dem sich die Ressource befindet. | Zeichenfolge |
| countryOrRegion | Das Land oder die Region, in dem sich die Ressource befindet. | Zeichenfolge |
| district | Der Bezirk, das Bundesland oder die Provinz, in dem sich die Ressource befindet. | Zeichenfolge |
| name | Ein kanonischer Name für den geografischen oder physischen Standort. | Zeichenfolge (erforderlich) |