Dela via


Tjänsten Microsoft.ApiManagement/gateways 2022-08-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 Resurs för Microsoft.ApiManagement/service/gateways lägger du till följande Bicep i mallen.

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

Egenskapsvärden

tjänst/gateways

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.
sträng (krävs)
parent 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 överordnad resurs.
Symboliskt namn för resurs av typen: tjänst
properties Gatewayinformation. GatewayContractProperties

GatewayContractProperties

Name Beskrivning Värde
beskrivning Gatewaybeskrivning sträng
locationData Gatewayplats. ResourceLocationDataContract

ResourceLocationDataContract

Name Beskrivning Värde
city Orten eller platsen där resursen finns. sträng
countryOrRegion Det land eller den region där resursen finns. sträng
distrikt Det distrikt, den delstat eller den provins där resursen finns. sträng
name Ett kanoniskt namn för den geografiska eller fysiska platsen. sträng (krävs)

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa API Management i internt virtuellt nätverk 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 Resurs för Microsoft.ApiManagement/service/gateways lägger du till följande JSON i mallen.

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

Egenskapsvärden

tjänst/gateways

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/gateways"
apiVersion Resurs-API-versionen '2022-08-01'
name Resursnamnet

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

GatewayContractProperties

Name Beskrivning Värde
beskrivning Gatewaybeskrivning sträng
locationData Gatewayplats. ResourceLocationDataContract

ResourceLocationDataContract

Name Beskrivning Värde
city Orten eller platsen där resursen finns. sträng
countryOrRegion Det land eller den region där resursen finns. sträng
distrikt Det distrikt, den delstat eller den provins där resursen finns. sträng
name Ett kanoniskt namn för den geografiska eller fysiska platsen. sträng (krävs)

Snabbstartsmallar

Följande snabbstartsmallar distribuerar den här resurstypen.

Mall Description
Skapa API Management i internt virtuellt nätverk 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 Resurs för Microsoft.ApiManagement/service/gateways lägger du till följande Terraform i mallen.

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

Egenskapsvärden

tjänst/gateways

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/gateways@2022-08-01"
name 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
properties Gatewayinformation. GatewayContractProperties

GatewayContractProperties

Name Beskrivning Värde
beskrivning Gatewaybeskrivning sträng
locationData Gatewayplats. ResourceLocationDataContract

ResourceLocationDataContract

Name Beskrivning Värde
city Orten eller platsen där resursen finns. sträng
countryOrRegion Det land eller den region där resursen finns. sträng
distrikt Det distrikt, den delstat eller den provins där resursen finns. sträng
name Ett kanoniskt namn för den geografiska eller fysiska platsen. sträng (krävs)