Dela via

Tjänsten Microsoft.ApiManagement/documentations 2023-05-01-preview

  • Artikel

Bicep-resursdefinition

Resurstypen tjänst/dokumentation 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/documentations lägger du till följande Bicep i mallen.

resource symbolicname 'Microsoft.ApiManagement/service/documentations@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    content: 'string'
    title: 'string'
  }
}

Egenskapsvärden

tjänst/dokumentation

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 Information om Markdown-dokumentation. DokumentationKontraktEgenskaper

DokumentationKontraktEgenskaper

Name Beskrivning Värde
innehåll Markdown-dokumentationsinnehåll. sträng
title dokumentationsrubrik. sträng

Resursdefinition för ARM-mall

Resurstypen tjänst/dokumentation 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/documentations lägger du till följande JSON i mallen.

{
  "type": "Microsoft.ApiManagement/service/documentations",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "content": "string",
    "title": "string"
  }
}

Egenskapsvärden

tjänst/dokumentation

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/documentations"
apiVersion Resurs-API-versionen "2023-05-01-preview"
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
properties Information om Markdown-dokumentation. DokumentationKontraktEgenskaper

DokumentationKontraktEgenskaper

Name Beskrivning Värde
innehåll Markdown-dokumentationsinnehåll. sträng
title dokumentationsrubrik. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen tjänst/dokumentation 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/documentations lägger du till följande Terraform i mallen.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/documentations@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      content = "string"
      title = "string"
    }
  })
}

Egenskapsvärden

tjänst/dokumentation

Name Beskrivning Värde
typ Resurstypen "Microsoft.ApiManagement/service/documentations@2023-05-01-preview"
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 Information om Markdown-dokumentation. DokumentationKontraktEgenskaper

DokumentationKontraktEgenskaper

Name Beskrivning Värde
innehåll Markdown-dokumentationsinnehåll. sträng
title dokumentationsrubrik. sträng