Dela via


Microsoft.ApiManagement-tjänst/gateways

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@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    locationData: {
      city: 'string'
      countryOrRegion: 'string'
      district: 'string'
      name: 'string'
    }
  }
}

Egenskapsvärden

service/gateways

Namn Beskrivning Värde
Namn Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.
sträng (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

GatewayContractProperties

Namn Beskrivning Värde
beskrivning Gatewaybeskrivning sträng

Begränsningar:
Maxlängd = 1 000
locationData Gatewayplats. ResourceLocationDataContract

ResourceLocationDataContract

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

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

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

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

Begränsningar:
Max längd = 256

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 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": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "locationData": {
      "city": "string",
      "countryOrRegion": "string",
      "district": "string",
      "name": "string"
    }
  }
}

Egenskapsvärden

service/gateways

Namn Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/gateways"
apiVersion Resurs-API-versionen "2023-09-01-preview"
Namn Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.
sträng (krävs)
Egenskaper Gatewayinformation. GatewayContractProperties

GatewayContractProperties

Namn Beskrivning Värde
beskrivning Gatewaybeskrivning sträng

Begränsningar:
Maxlängd = 1 000
locationData Gatewayplats. ResourceLocationDataContract

ResourceLocationDataContract

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

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

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

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

Begränsningar:
Max längd = 256

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@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      locationData = {
        city = "string"
        countryOrRegion = "string"
        district = "string"
        name = "string"
      }
    }
  })
}

Egenskapsvärden

service/gateways

Namn Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/gateways@2023-09-01-preview"
Namn Resursnamnet sträng (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

GatewayContractProperties

Namn Beskrivning Värde
beskrivning Gatewaybeskrivning sträng

Begränsningar:
Maxlängd = 1 000
locationData Gatewayplats. ResourceLocationDataContract

ResourceLocationDataContract

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

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

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

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

Begränsningar:
Max längd = 256