次の方法で共有


Microsoft.ApiManagement service/apis/tagDescriptions 2023-09-01-preview

Bicep リソース定義

service/apis/tagDescriptions リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

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

プロパティ値

service/apis/tagDescriptions

名前 形容 価値
名前 リソース名

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

文字制限: 1 ~ 80

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

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

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

TagDescriptionBasePropertiesOrTagDescriptionContract...

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

制約:
最大長 = 2000

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

service/apis/tagDescriptions リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

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

プロパティ値

service/apis/tagDescriptions

名前 形容 価値
種類 リソースの種類 'Microsoft.ApiManagement/service/apis/tagDescriptions'
apiVersion リソース API のバージョン '2023-09-01-preview'
名前 リソース名

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

文字制限: 1 ~ 80

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

文字で始まり、英数字で終わる。
プロパティ TagDescription の作成操作に指定されたプロパティ。 TagDescriptionBasePropertiesOrTagDescriptionContract...

TagDescriptionBasePropertiesOrTagDescriptionContract...

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

制約:
最大長 = 2000

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

service/apis/tagDescriptions リソースの種類は、次をターゲットとする操作と共にデプロイできます。

  • リソース グループの

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

リソースの形式

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

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

プロパティ値

service/apis/tagDescriptions

名前 形容 価値
種類 リソースの種類 "Microsoft.ApiManagement/service/apis/tagDescriptions@2023-09-01-preview"
名前 リソース名 string (必須)

文字制限: 1 ~ 80

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

文字で始まり、英数字で終わる。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: API
プロパティ TagDescription の作成操作に指定されたプロパティ。 TagDescriptionBasePropertiesOrTagDescriptionContract...

TagDescriptionBasePropertiesOrTagDescriptionContract...

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

制約:
最大長 = 2000