Microsoft.ApiManagement service/gateways 2023-03-01-preview
Definicja zasobu Bicep
Typ zasobu usługi/bram można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/gateways, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ApiManagement/service/gateways@2023-03-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
description: 'string'
locationData: {
city: 'string'
countryOrRegion: 'string'
district: 'string'
name: 'string'
}
}
}
Wartości właściwości
GatewayContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| opis | Opis bramy | struna Ograniczenia: Maksymalna długość = 1000 |
| locationData | Lokalizacja bramy. | ResourceLocationDataContract |
Microsoft.ApiManagement/service/gateways
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 80 (wymagane) |
| rodzic | W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: usługi |
| Właściwości | Szczegóły bramy. | GatewayContractProperties |
ResourceLocationDataContract
| Nazwa | Opis | Wartość |
|---|---|---|
| miasto | Miasto lub lokalizacja, w której znajduje się zasób. | struna Ograniczenia: Maksymalna długość = 256 |
| countryOrRegion | Kraj lub region, w którym znajduje się zasób. | struna Ograniczenia: Maksymalna długość = 256 |
| dzielnica | Region, stan lub prowincja, w której znajduje się zasób. | struna Ograniczenia: Maksymalna długość = 256 |
| nazwa | Nazwa kanoniczna lokalizacji geograficznej lub fizycznej. | struna Ograniczenia: Maksymalna długość = 256 (wymagana) |
Przykłady z przewodnika Szybki start
W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.
| Plik Bicep | Opis |
|---|---|
| tworzenie usługi API Management w wewnętrznej sieci wirtualnej przy użyciu usługi App Gateway | Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w sieci prywatnej chronionej przez usługę Azure Application Gateway. |
Definicja zasobu szablonu usługi ARM
Typ zasobu usługi/bram można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/gateways, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service/gateways",
"apiVersion": "2023-03-01-preview",
"name": "string",
"properties": {
"description": "string",
"locationData": {
"city": "string",
"countryOrRegion": "string",
"district": "string",
"name": "string"
}
}
}
Wartości właściwości
GatewayContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| opis | Opis bramy | struna Ograniczenia: Maksymalna długość = 1000 |
| locationData | Lokalizacja bramy. | ResourceLocationDataContract |
Microsoft.ApiManagement/service/gateways
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2023-03-01-preview" |
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 80 (wymagane) |
| Właściwości | Szczegóły bramy. | GatewayContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/gateways" |
ResourceLocationDataContract
| Nazwa | Opis | Wartość |
|---|---|---|
| miasto | Miasto lub lokalizacja, w której znajduje się zasób. | struna Ograniczenia: Maksymalna długość = 256 |
| countryOrRegion | Kraj lub region, w którym znajduje się zasób. | struna Ograniczenia: Maksymalna długość = 256 |
| dzielnica | Region, stan lub prowincja, w której znajduje się zasób. | struna Ograniczenia: Maksymalna długość = 256 |
| nazwa | Nazwa kanoniczna lokalizacji geograficznej lub fizycznej. | struna Ograniczenia: Maksymalna długość = 256 (wymagana) |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Szablon | Opis |
|---|---|
|
tworzenie usługi API Management w wewnętrznej sieci wirtualnej przy użyciu usługi App Gateway wdrażanie  |
Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w sieci prywatnej chronionej przez usługę Azure Application Gateway. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu usługi/bram można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/gateways, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/gateways@2023-03-01-preview"
name = "string"
body = jsonencode({
properties = {
description = "string"
locationData = {
city = "string"
countryOrRegion = "string"
district = "string"
name = "string"
}
}
})
}
Wartości właściwości
GatewayContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| opis | Opis bramy | struna Ograniczenia: Maksymalna długość = 1000 |
| locationData | Lokalizacja bramy. | ResourceLocationDataContract |
Microsoft.ApiManagement/service/gateways
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Minimalna długość = 1 Maksymalna długość = 80 (wymagane) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: usługi |
| Właściwości | Szczegóły bramy. | GatewayContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/gateways@2023-03-01-preview" |
ResourceLocationDataContract
| Nazwa | Opis | Wartość |
|---|---|---|
| miasto | Miasto lub lokalizacja, w której znajduje się zasób. | struna Ograniczenia: Maksymalna długość = 256 |
| countryOrRegion | Kraj lub region, w którym znajduje się zasób. | struna Ograniczenia: Maksymalna długość = 256 |
| dzielnica | Region, stan lub prowincja, w której znajduje się zasób. | struna Ograniczenia: Maksymalna długość = 256 |
| nazwa | Nazwa kanoniczna lokalizacji geograficznej lub fizycznej. | struna Ograniczenia: Maksymalna długość = 256 (wymagana) |