Microsoft.ApiManagement サービス/ドキュメント 2022-08-01

  • [アーティクル]

Bicep リソース定義

サービス/ドキュメント リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/documentations リソースを作成するには、次の Bicep をテンプレートに追加します。

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

プロパティ値

service/documentations

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。		 種類のリソースのシンボル名: service
properties Markdown ドキュメントの詳細。 DocumentationContractProperties

DocumentationContractProperties

名前 説明 値
content Markdown ドキュメントの内容。 string
title ドキュメントのタイトル。 string

ARM テンプレート リソース定義

サービス/ドキュメント リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/documentations リソースを作成するには、次の JSON をテンプレートに追加します。

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

プロパティ値

service/documentations

名前 説明 値
type リソースの種類 'Microsoft.ApiManagement/service/documentations'
apiVersion リソース API のバージョン '2022-08-01'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties Markdown ドキュメントの詳細。 DocumentationContractProperties

DocumentationContractProperties

名前 説明 値
content Markdown ドキュメントの内容。 string
title ドキュメントのタイトル。 string

Terraform (AzAPI プロバイダー) リソース定義

サービス/ドキュメント リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/documentations リソースを作成するには、次の Terraform をテンプレートに追加します。

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

プロパティ値

service/documentations

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/documentations@2022-08-01"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
properties Markdown ドキュメントの詳細。 DocumentationContractProperties

DocumentationContractProperties

名前 説明 値
content Markdown ドキュメントの内容。 string
title ドキュメントのタイトル。 string