Microsoft.ApiManagement-tjänst/dokumentation
Bicep-resursdefinition
Resurstypen tjänst/dokumentation kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/documentations-resurs lägger du till följande Bicep i mallen.
resource symbolicname 'Microsoft.ApiManagement/service/documentations@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
content: 'string'
title: 'string'
}
}
Egenskapsvärden
service/dokumentation
| Namn | Beskrivning | Värde |
|---|---|---|
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i Bicep. |
sträng (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: tjänst |
| Egenskaper | Information om Markdown-dokumentation. | DocumentationContractProperties |
DokumentationContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| innehåll | Markdown-dokumentationsinnehåll. | sträng |
| titel | dokumentationstitel. | sträng |
Resursdefinition för ARM-mall
Resurstypen tjänst/dokumentation kan distribueras med åtgärder som mål:
- Resursgrupper – Se resursgruppsdistributionskommandon
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.
Resursformat
Om du vill skapa en Microsoft.ApiManagement/service/documentations-resurs lägger du till följande JSON i mallen.
{
"type": "Microsoft.ApiManagement/service/documentations",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"content": "string",
"title": "string"
}
}
Egenskapsvärden
service/dokumentation
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/documentations" |
| apiVersion | Resurs-API-versionen | "2023-09-01-preview" |
| Namn | Resursnamnet Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar. |
sträng (krävs) |
| Egenskaper | Information om Markdown-dokumentation. | DocumentationContractProperties |
DokumentationContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| innehåll | Markdown-dokumentationsinnehåll. | sträng |
| titel | dokumentationstitel. | 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 Microsoft.ApiManagement/service/documentations-resurs lägger du till följande Terraform i mallen.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/documentations@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
content = "string"
title = "string"
}
})
}
Egenskapsvärden
service/dokumentation
| Namn | Beskrivning | Värde |
|---|---|---|
| typ | Resurstypen | "Microsoft.ApiManagement/service/documentations@2023-09-01-preview" |
| Namn | 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 |
| Egenskaper | Information om Markdown-dokumentation. | DocumentationContractProperties |
DokumentationContractProperties
| Namn | Beskrivning | Värde |
|---|---|---|
| innehåll | Markdown-dokumentationsinnehåll. | sträng |
| titel | dokumentationstitel. | sträng |