Microsoft.ApiManagement 服務/產品/原則 2021-01-01-preview

Bicep 資源定義

服務/產品/原則資源類型可以使用目標作業來部署:

如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。

使用範例

Bicep 範例

部署 API 管理 服務產品原則的基本範例。

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource service 'Microsoft.ApiManagement/service@2021-08-01' = {
  name: resourceName
  location: location
  sku: {
    capacity: 0
    name: 'Consumption'
  }
  properties: {
    certificates: []
    customProperties: {
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10': 'false'
      'Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11': 'false'
    }
    disableGateway: false
    publicNetworkAccess: 'Enabled'
    publisherEmail: 'pub1@email.com'
    publisherName: 'pub1'
    virtualNetworkType: 'None'
  }
}

resource product 'Microsoft.ApiManagement/service/products@2021-08-01' = {
  name: resourceName
  parent: service
  properties: {
    description: ''
    displayName: 'Test Product'
    state: 'notPublished'
    subscriptionRequired: false
    terms: ''
  }
}

resource policy2 'Microsoft.ApiManagement/service/products/policies@2021-08-01' = {
  name: 'policy'
  parent: product
  properties: {
    format: 'rawxml-link'
    value: 'https://gist.githubusercontent.com/riordanp/ca22f8113afae0eb38cc12d718fd048d/raw/d6ac89a2f35a6881a7729f8cb4883179dc88eea1/example.xml'
  }
}

Azure 已驗證的模組

下列 Azure 驗證模組 可用來部署此資源類型。

Module 描述
API 管理服務 - 產品 - 政策 AVM 子模組用於 API 管理服務 - 產品 - 政策

資源格式

若要建立 Microsoft.ApiManagement/service/products/policies 資源,請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.ApiManagement/service/products/policies@2021-01-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    format: 'string'
    value: 'string'
  }
}

屬性值

Microsoft.ApiManagement/service/products/policies

名字 描述 價值
名字 資源名稱 'policy' (必要)
父代 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。

如需詳細資訊,請參閱 父資源外部的子資源。
類型的資源符號名稱: service/products
性能 原則的屬性。 PolicyContractProperties

PolicyContractProperties

名字 描述 價值
格式 policyContent 的格式。 'rawxml'
'rawxml-link'
'xml'
'xml-link'
價值 原則的內容,如格式所定義。 字串 (必要)

ARM 樣本資源定義

服務/產品/原則資源類型可以使用目標作業來部署:

使用範例

資源格式

若要建立 Microsoft.ApiManagement/service/products/policies 資源,請將下列 JSON 新增至範本。

{
  "type": "Microsoft.ApiManagement/service/products/policies",
  "apiVersion": "2021-01-01-preview",
  "name": "string",
  "properties": {
    "format": "string",
    "value": "string"
  }
}

屬性值

Microsoft.ApiManagement/service/products/policies

名字 描述 價值
apiVersion API 版本 '2021-01-01-preview'
名字 資源名稱 'policy' (必要)
性能 原則的屬性。 PolicyContractProperties
型別 資源類型 'Microsoft.ApiManagement/service/products/policies'

PolicyContractProperties

名字 描述 價值
格式 policyContent 的格式。 'rawxml'
'rawxml-link'
'xml'
'xml-link'
價值 原則的內容,如格式所定義。 字串 (必要)

Terraform (AzAPI 提供者) 資源定義

服務/產品/原則資源類型可以使用目標作業來部署:

  • 資源團體 關於每個 API 版本變更屬性的清單,請參見 變更日誌。

使用範例

Terraform 範例

部署 API 管理 服務產品原則的基本範例。

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "product" {
  type      = "Microsoft.ApiManagement/service/products@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      description          = ""
      displayName          = "Test Product"
      state                = "notPublished"
      subscriptionRequired = false
      terms                = ""
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "policy2" {
  type      = "Microsoft.ApiManagement/service/products/policies@2021-08-01"
  parent_id = azapi_resource.product.id
  name      = "policy"
  body = {
    properties = {
      format = "rawxml-link"
      value  = "https://gist.githubusercontent.com/riordanp/ca22f8113afae0eb38cc12d718fd048d/raw/d6ac89a2f35a6881a7729f8cb4883179dc88eea1/example.xml"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

資源格式

若要建立 Microsoft.ApiManagement/service/products/policies 資源,請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products/policies@2021-01-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      format = "string"
      value = "string"
    }
  }
}

屬性值

Microsoft.ApiManagement/service/products/policies

名字 描述 價值
名字 資源名稱 'policy' (必要)
parent_id 此資源為父系之資源的標識碼。 類型資源的標識碼: 服務/產品
性能 原則的屬性。 PolicyContractProperties
型別 資源類型 “Microsoft.ApiManagement/service/products/policies@2021-01-01-preview”

PolicyContractProperties

名字 描述 價值
格式 policyContent 的格式。 'rawxml'
'rawxml-link'
'xml'
'xml-link'
價值 原則的內容,如格式所定義。 字串 (必要)