Share via

Microsoft.ApiManagement サービス/ワークスペース/スキーマ 2023-05-01-preview

  • [アーティクル]

Bicep リソース定義

サービス/ワークスペース/スキーマ リソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/schemas@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    description: 'string'
    document: any()
    schemaType: 'string'
    value: any()
  }
}

プロパティ値

service/workspaces/schemas

名前 説明 値
name リソース名

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

詳細については、「 親リソースの外部の子リソース」を参照してください。		 種類のリソースのシンボル名: ワークスペース
properties グローバル スキーマのプロパティ。 GlobalSchemaContractProperties

GlobalSchemaContractProperties

名前 説明 値
description 自由形式のスキーマ エンティティの説明。 string
ドキュメント json ベースのスキーマ形式 (json スキーマなど) のグローバル スキーマ ドキュメント オブジェクト。 Bicep の場合は、 any() 関数を使用できます。
schemaType スキーマの種類。 変更不可。 'json'
'xml' (必須)
value JSON ベース以外のスキーマの Json エンコード文字列。 Bicep の場合は、 any() 関数を使用できます。

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

サービス/ワークスペース/スキーマ リソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/workspaces/schemas",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "description": "string",
    "document": {},
    "schemaType": "string",
    "value": {}
  }
}

プロパティ値

service/workspaces/schemas

名前 説明 値
type リソースの種類 'Microsoft.ApiManagement/service/workspaces/schemas'
apiVersion リソース API のバージョン '2023-05-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)
properties グローバル スキーマのプロパティ。 GlobalSchemaContractProperties

GlobalSchemaContractProperties

名前 説明 値
description 自由形式のスキーマ エンティティの説明。 string
ドキュメント json ベースのスキーマ形式 (json スキーマなど) のグローバル スキーマ ドキュメント オブジェクト。
schemaType スキーマの種類。 変更不可。 'json'
'xml' (必須)
value JSON ベース以外のスキーマの Json エンコード文字列。

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

サービス/ワークスペース/スキーマ リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/schemas@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      description = "string"
      schemaType = "string"
    }
  })
}

プロパティ値

service/workspaces/schemas

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/workspaces/schemas@2023-05-01-preview"
name リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: ワークスペース
properties グローバル スキーマのプロパティ。 GlobalSchemaContractProperties

GlobalSchemaContractProperties

名前 説明 値
description 自由形式のスキーマ エンティティの説明。 string
ドキュメント json ベースのスキーマ形式 (json スキーマなど) のグローバル スキーマ ドキュメント オブジェクト。
schemaType スキーマの種類。 変更不可。 "json"
"xml" (必須)
value JSON ベース以外のスキーマの Json エンコード文字列。