Dela via


Microsoft.ApiManagement service/apis/tagDescriptions 2024-05-01

Bicep-resursdefinition

Resurstypen service/apis/tagDescriptions 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/apis/tagDescriptions-resurs lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service/apis/tagDescriptions@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    description: 'string'
    externalDocsDescription: 'string'
    externalDocsUrl: 'string'
  }
}

Egenskapsvärden

Microsoft.ApiManagement/service/apis/tagDescriptions

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
Mönster = ^[^*#&+:<>?]+$ (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: service/apis
Egenskaper Egenskaper som anges för åtgärden Skapa TagDescription. TagDescriptionBasePropertiesOrTagDescriptionContractProperties

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

Namn Beskrivning Värde
beskrivning Beskrivning av taggen. sträng
externalDocsDescription Beskrivning av de externa resurser som beskriver taggen. sträng
externalDocsUrl Absolut URL för externa resurser som beskriver taggen. sträng

Begränsningar:
Max längd =

Resursdefinition för ARM-mall

Resurstypen service/apis/tagDescriptions 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/apis/tagDescriptions-resurs lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "description": "string",
    "externalDocsDescription": "string",
    "externalDocsUrl": "string"
  }
}

Egenskapsvärden

Microsoft.ApiManagement/service/apis/tagDescriptions

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

Begränsningar:
Min längd = 1
Maximal längd = 1
Mönster = ^[^*#&+:<>?]+$ (krävs)
Egenskaper Egenskaper som anges för åtgärden Skapa TagDescription. TagDescriptionBasePropertiesOrTagDescriptionContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/apis/tagDescriptions"

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

Namn Beskrivning Värde
beskrivning Beskrivning av taggen. sträng
externalDocsDescription Beskrivning av de externa resurser som beskriver taggen. sträng
externalDocsUrl Absolut URL för externa resurser som beskriver taggen. sträng

Begränsningar:
Max längd =

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen service/apis/tagDescriptions 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/apis/tagDescriptions-resurs lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/tagDescriptions@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      description = "string"
      externalDocsDescription = "string"
      externalDocsUrl = "string"
    }
  })
}

Egenskapsvärden

Microsoft.ApiManagement/service/apis/tagDescriptions

Namn Beskrivning Värde
Namn Resursnamnet sträng

Begränsningar:
Min längd = 1
Maximal längd = 1
Mönster = ^[^*#&+:<>?]+$ (krävs)
parent_id ID för resursen som är överordnad för den här resursen. ID för resurs av typen: service/apis
Egenskaper Egenskaper som anges för åtgärden Skapa TagDescription. TagDescriptionBasePropertiesOrTagDescriptionContractProperties
typ Resurstypen "Microsoft.ApiManagement/service/apis/tagDescriptions@2024-05-01"

TagDescriptionBasePropertiesOrTagDescriptionContractProperties

Namn Beskrivning Värde
beskrivning Beskrivning av taggen. sträng
externalDocsDescription Beskrivning av de externa resurser som beskriver taggen. sträng
externalDocsUrl Absolut URL för externa resurser som beskriver taggen. sträng

Begränsningar:
Max längd =