Služba Microsoft.ApiManagement / dokumentace

Definice prostředku Bicep

Typ prostředku služby nebo dokumentace je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/documentations, přidejte do šablony následující bicep.

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

Hodnoty vlastností

služba / dokumentace

Název Description Hodnota
name Název prostředku

Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu.
string (povinné)
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.
Symbolický název prostředku typu: service
properties Podrobnosti dokumentace k Markdownu DocumentationContractProperties

DocumentationContractProperties

Název Description Hodnota
obsah Obsah dokumentace k Markdownu řetězec
title název dokumentace. řetězec

Definice prostředku šablony ARM

Typ prostředku služby nebo dokumentace je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/documentations, přidejte do šablony následující kód JSON.

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

Hodnoty vlastností

služba / dokumentace

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service/documentations
apiVersion Verze rozhraní API prostředků '2023-05-01-preview'
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.
string (povinné)
properties Podrobnosti dokumentace k Markdownu DocumentationContractProperties

DocumentationContractProperties

Název Description Hodnota
obsah Obsah dokumentace k Markdownu řetězec
title název dokumentace. řetězec

Definice prostředku Terraformu (zprostředkovatele AzAPI)

Typ prostředku služby nebo dokumentace je možné nasadit s operacemi, které cílí na:

  • Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/documentations, přidejte do šablony následující Terraform.

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"
    }
  })
}

Hodnoty vlastností

služba / dokumentace

Název Description Hodnota
typ Typ prostředku Microsoft.ApiManagement/service/documentations@2023-05-01-preview
name Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: service
properties Podrobnosti dokumentace k Markdownu DocumentationContractProperties

DocumentationContractProperties

Název Description Hodnota
obsah Obsah dokumentace k Markdownu řetězec
title název dokumentace. řetězec