Dela via


Microsoft.ApiManagement service/gateways 2024-05-01

Bicep-resursdefinition

Resurstypen tjänst/gateways kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/gateways-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service/gateways@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    locationData: {
      city: 'string'
      countryOrRegion: 'string'
      district: 'string'
      name: 'string'
    }
  }
}

Egenskapsvärden

GatewayContractProperties

Namn Beskrivning Värde
beskrivning Gatewaybeskrivning sträng

Begränsningar:
Max längd =
locationData Gatewayplats. ResourceLocationDataContract

Microsoft.ApiManagement/service/gateways

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
förälder I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför den överordnade resursen.
Symboliskt namn för resurs av typen: tjänst
Egenskaper Gatewayinformation. GatewayContractProperties

ResourceLocationDataContract

Namn Beskrivning Värde
stad Den ort eller ort där resursen finns. sträng

Begränsningar:
Max längd =
countryOrRegion Det land eller den region där resursen finns. sträng

Begränsningar:
Max längd =
distrikt Det distrikt, den delstat eller den provins där resursen finns. sträng

Begränsningar:
Max längd =
Namn Ett kanoniskt namn för den geografiska eller fysiska platsen. sträng

Begränsningar:
Maximal längd = (krävs)

Snabbstartsexempel

Följande snabbstartsexempel distribuerar den här resurstypen.

Bicep-fil Beskrivning
Skapa API Management i internt VNet med App Gateway Den här mallen visar hur du skapar en instans av Azure API Management i ett privat nätverk som skyddas av Azure Application Gateway.

Resursdefinition för ARM-mall

Resurstypen tjänst/gateways kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/gateways-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service/gateways",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "description": "string",
    "locationData": {
      "city": "string",
      "countryOrRegion": "string",
      "district": "string",
      "name": "string"
    }
  }
}

Egenskapsvärden

GatewayContractProperties

Namn Beskrivning Värde
beskrivning Gatewaybeskrivning sträng

Begränsningar:
Max längd =
locationData Gatewayplats. ResourceLocationDataContract

Microsoft.ApiManagement/service/gateways

Namn Beskrivning Värde
apiVersion API-versionen '2024-05-01'
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
Egenskaper Gatewayinformation. GatewayContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/gateways"

ResourceLocationDataContract

Namn Beskrivning Värde
stad Den ort eller ort där resursen finns. sträng

Begränsningar:
Max längd =
countryOrRegion Det land eller den region där resursen finns. sträng

Begränsningar:
Max längd =
distrikt Det distrikt, den delstat eller den provins där resursen finns. sträng

Begränsningar:
Max längd =
Namn Ett kanoniskt namn för den geografiska eller fysiska platsen. sträng

Begränsningar:
Maximal längd = (krävs)

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Beskrivning
Skapa API Management i internt VNet med App Gateway

Distribuera till Azure
Den här mallen visar hur du skapar en instans av Azure API Management i ett privat nätverk som skyddas av Azure Application Gateway.

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/gateways kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.ApiManagement/service/gateways-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/gateways@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      locationData = {
        city = "string"
        countryOrRegion = "string"
        district = "string"
        name = "string"
      }
    }
  })
}

Egenskapsvärden

GatewayContractProperties

Namn Beskrivning Värde
beskrivning Gatewaybeskrivning sträng

Begränsningar:
Max längd =
locationData Gatewayplats. ResourceLocationDataContract

Microsoft.ApiManagement/service/gateways

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1 (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: tjänst
Egenskaper Gatewayinformation. GatewayContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/gateways@2024-05-01"

ResourceLocationDataContract

Namn Beskrivning Värde
stad Den ort eller ort där resursen finns. sträng

Begränsningar:
Max längd =
countryOrRegion Det land eller den region där resursen finns. sträng

Begränsningar:
Max längd =
distrikt Det distrikt, den delstat eller den provins där resursen finns. sträng

Begränsningar:
Max längd =
Namn Ett kanoniskt namn för den geografiska eller fysiska platsen. sträng

Begränsningar:
Maximal längd = (krävs)