Share via

Microsoft.ApiManagement service/apis/tagDescriptions 2022-04-01-preview

  • [アーティクル]

Bicep リソース定義

service/apis/tagDescriptions リソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

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

プロパティ値

service/apis/tagDescriptions

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)

文字制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部の子リソース」を参照してください。		 型のリソースのシンボル名: apis
properties TagDescription の作成操作に指定されたプロパティ。 TagDescriptionBasePropertiesOrTagDescriptionContract...

TagDescriptionBasePropertiesOrTagDescriptionContract...

名前 説明 値
description タグの説明。 string
externalDocsDescription タグを記述する外部リソースの説明。 string
externalDocsUrl タグを記述する外部リソースの絶対 URL。 string

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

service/apis/tagDescriptions リソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

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

プロパティ値

service/apis/tagDescriptions

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

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

文字制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
properties TagDescription の作成操作に指定されたプロパティ。 TagDescriptionBasePropertiesOrTagDescriptionContract...

TagDescriptionBasePropertiesOrTagDescriptionContract...

名前 説明 値
description タグの説明。 string
externalDocsDescription タグを記述する外部リソースの説明。 string
externalDocsUrl タグを記述する外部リソースの絶対 URL。 string

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

service/apis/tagDescriptions リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

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

リソース形式

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

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

プロパティ値

service/apis/tagDescriptions

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/apis/tagDescriptions@2022-04-01-preview"
name リソース名 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: apis
properties TagDescription の作成操作に指定されたプロパティ。 TagDescriptionBasePropertiesOrTagDescriptionContract...

TagDescriptionBasePropertiesOrTagDescriptionContract...

名前 説明 値
description タグの説明。 string
externalDocsDescription タグを記述する外部リソースの説明。 string
externalDocsUrl タグを記述する外部リソースの絶対 URL。 string