Microsoft.ApiManagement 服務/標籤 2024-10-01-preview

Bicep 資源定義

服務/標籤資源類型可以使用目標作業來部署:

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

使用範例

Bicep 範例

部署 API 管理 標籤的基本範例。

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

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 tag 'Microsoft.ApiManagement/service/tags@2021-08-01' = {
  name: resourceName
  parent: service
  properties: {
    displayName: resourceName
  }
}

資源格式

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

resource symbolicname 'Microsoft.ApiManagement/service/tags@2024-10-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
  }
}

屬性值

Microsoft.ApiManagement/service/tags

名稱 Description 價值觀
名稱 資源名稱 string

約束:
最小長度 = 1
最大長度 = 80
模式 = ^[^*#&+:<>?]+$ (必要)
父代 在 Bicep 中,您可以指定子資源的父資源。 只有在父資源外部宣告子資源時,才需要新增這個屬性。

如需詳細資訊,請參閱 父資源外部的子資源。
類型的資源符號名稱:服務
properties 提供給建立標籤作業的屬性。 TagContractProperties

TagContractProperties

名稱 Description 價值觀
顯示名稱 標記名稱。 string

約束:
最小長度 = 1
最大長度 = 160 (必要)

ARM 樣本資源定義

服務/標籤資源類型可以使用目標作業來部署:

使用範例

資源格式

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

{
  "type": "Microsoft.ApiManagement/service/tags",
  "apiVersion": "2024-10-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string"
  }
}

屬性值

Microsoft.ApiManagement/service/tags

名稱 Description 價值觀
apiVersion API 版本 '2024-10-01-preview'
名稱 資源名稱 string

約束:
最小長度 = 1
最大長度 = 80
模式 = ^[^*#&+:<>?]+$ (必要)
properties 提供給建立標籤作業的屬性。 TagContractProperties
型別 資源類型 'Microsoft.ApiManagement/service/tags'

TagContractProperties

名稱 Description 價值觀
顯示名稱 標記名稱。 string

約束:
最小長度 = 1
最大長度 = 160 (必要)

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" "tag" {
  type      = "Microsoft.ApiManagement/service/tags@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      displayName = var.resource_name
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

資源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/tags@2024-10-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      displayName = "string"
    }
  }
}

屬性值

Microsoft.ApiManagement/service/tags

名稱 Description 價值觀
名稱 資源名稱 string

約束:
最小長度 = 1
最大長度 = 80
模式 = ^[^*#&+:<>?]+$ (必要)
parent_id 此資源為父系之資源的標識碼。 類型的資源標識碼:服務
properties 提供給建立標籤作業的屬性。 TagContractProperties
型別 資源類型 「Microsoft.ApiManagement/service/tags@2024-10-01-preview」

TagContractProperties

名稱 Description 價值觀
顯示名稱 標記名稱。 string

約束:
最小長度 = 1
最大長度 = 160 (必要)