Microsoft.ApiManagement-Dienst/Gateways
Bicep-Ressourcendefinition
Der Ressourcentyp "Dienst/Gateways" 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/service/gateways-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/gateways@2024-06-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
locationData: {
city: 'string'
countryOrRegion: 'string'
district: 'string'
name: 'string'
}
}
}
Eigenschaftswerte
GatewayContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Gatewaybeschreibung | Schnur Zwänge: Max. Länge = |
| locationData | Gatewayspeicherort. | ResourceLocationDataContract- |
Microsoft.ApiManagement/service/gateways
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Elternteil | 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 des Typs: Dienst- |
| Eigenschaften | Gatewaydetails. | GatewayContractProperties |
ResourceLocationDataContract
| Name | Beschreibung | Wert |
|---|---|---|
| Stadt | Die Stadt oder das Gebietsschema, in dem sich die Ressource befindet. | Schnur Zwänge: Max. Länge = |
| countryOrRegion | Das Land oder die Region, in dem sich die Ressource befindet. | Schnur Zwänge: Max. Länge = |
| Bezirk | Der Bezirk, das Bundesland oder die Provinz, in dem sich die Ressource befindet. | Schnur Zwänge: Max. Länge = |
| Name | Ein kanonischer Name für den geografischen oder physischen Standort. | Schnur Zwänge: Max. Länge = (erforderlich) |
Schnellstartbeispiele
Die folgenden Schnellstartbeispiele stellen diesen Ressourcentyp bereit.
| Bicep-Datei | Beschreibung |
|---|---|
| Erstellen der API-Verwaltung im internen VNet mit App-Gateway- | Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt ist. |
ARM-Vorlagenressourcendefinition
Der Ressourcentyp "Dienst/Gateways" 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/service/gateways-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/gateways",
"apiVersion": "2024-06-01-preview",
"name": "string",
"properties": {
"description": "string",
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
}
}
}
Eigenschaftswerte
GatewayContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Gatewaybeschreibung | Schnur Zwänge: Max. Länge = |
| locationData | Gatewayspeicherort. | ResourceLocationDataContract- |
Microsoft.ApiManagement/service/gateways
| Name | Beschreibung | Wert |
|---|---|---|
| apiVersion | Die API-Version | "2024-06-01-preview" |
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| Eigenschaften | Gatewaydetails. | GatewayContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/gateways" |
ResourceLocationDataContract
| Name | Beschreibung | Wert |
|---|---|---|
| Stadt | Die Stadt oder das Gebietsschema, in dem sich die Ressource befindet. | Schnur Zwänge: Max. Länge = |
| countryOrRegion | Das Land oder die Region, in dem sich die Ressource befindet. | Schnur Zwänge: Max. Länge = |
| Bezirk | Der Bezirk, das Bundesland oder die Provinz, in dem sich die Ressource befindet. | Schnur Zwänge: Max. Länge = |
| Name | Ein kanonischer Name für den geografischen oder physischen Standort. | Schnur Zwänge: Max. Länge = (erforderlich) |
Schnellstartvorlagen
Die folgenden Schnellstartvorlagen stellen diesen Ressourcentyp bereit.
| Schablone | Beschreibung |
|---|---|
Erstellen der API-Verwaltung im internen VNet mit App-Gateway-
|
Diese Vorlage veranschaulicht, wie Sie eine Instanz von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt ist. |
Terraform -Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp "Dienst/Gateways" 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/service/gateways-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/gateways@2024-06-01-preview"
name = "string"
body = jsonencode({
properties = {
description = "string"
locationData = {
city = "string"
countryOrRegion = "string"
district = "string"
name = "string"
}
}
})
}
Eigenschaftswerte
GatewayContractProperties
| Name | Beschreibung | Wert |
|---|---|---|
| Beschreibung | Gatewaybeschreibung | Schnur Zwänge: Max. Länge = |
| locationData | Gatewayspeicherort. | ResourceLocationDataContract- |
Microsoft.ApiManagement/service/gateways
| Name | Beschreibung | Wert |
|---|---|---|
| Name | Der Ressourcenname | Schnur Zwänge: Min. Länge = 1 Max. Länge = 1 (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource des Typs: Dienst- |
| Eigenschaften | Gatewaydetails. | GatewayContractProperties |
| Art | Der Ressourcentyp | "Microsoft.ApiManagement/service/gateways@2024-06-01-preview" |
ResourceLocationDataContract
| Name | Beschreibung | Wert |
|---|---|---|
| Stadt | Die Stadt oder das Gebietsschema, in dem sich die Ressource befindet. | Schnur Zwänge: Max. Länge = |
| countryOrRegion | Das Land oder die Region, in dem sich die Ressource befindet. | Schnur Zwänge: Max. Länge = |
| Bezirk | Der Bezirk, das Bundesland oder die Provinz, in dem sich die Ressource befindet. | Schnur Zwänge: Max. Länge = |
| Name | Ein kanonischer Name für den geografischen oder physischen Standort. | Schnur Zwänge: Max. Länge = (erforderlich) |