az apic metadata

Note

このリファレンスは、Azure CLI (バージョン 2.57.0 以降) の apic-extension 拡張機能の一部です。拡張機能は、az apic metadata コマンドを初めて実行するときに自動的にインストールされます。拡張機能の詳細については、を参照してください。

API Center でメタデータスキーマを管理するコマンド。

コマンド

名前	説明	型	状態
az apic metadata create	新しいメタデータスキーマを作成するか、既存のメタデータスキーマを更新します。	Extension	GA
az apic metadata delete	指定したメタデータスキーマを削除します。	Extension	GA
az apic metadata export	メタデータスキーマをエクスポートします。	Extension	GA
az apic metadata list	メタデータスキーマのコレクションを一覧表示します。	Extension	GA
az apic metadata show	メタデータスキーマの詳細を取得します。	Extension	GA
az apic metadata update	既存のメタデータスキーマを更新します。	Extension	GA

az apic metadata create

新しいメタデータスキーマを作成するか、既存のメタデータスキーマを更新します。

az apic metadata create --assignments
                        --metadata-name
                        --resource-group
                        --schema
                        --service-name

例

メタデータの作成の例 1

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"First name", "pattern": "^[a-zA-Z0-9]+$"}' --assignments '[{entity:api,required:true,deprecated:false}]'

メタデータの作成の例 2

az apic metadata create --resource-group api-center-test --service-name contoso  --metadata-name testregion --schema '{"type":"string","title":"testregion","oneOf":[{"const":"Region1","description":""},{"const":"Region2","description":""},{"const":"Region3","description":""}]}' --assignments '[{entity:api,required:true,deprecated:false},{entity:environment,required:true,deprecated:false}]'

JSON ファイルスキーマと割り当てを使用してメタデータを作成する例

az apic metadata create --resource-group api-center-test --service-name contoso --metadata-name "test" --schema '@schema.json' --assignments '@assignments.json'

必須のパラメーター

--assignments

カスタムメタデータの割り当てスコープを定義します (例: "[{entity:api,required:true,deprecated:false}]")。使用可能なエンティティ値は、api、deployment、environment です。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

プロパティ	値
パラメーターグループ:	Properties Arguments

--metadata-name

メタデータスキーマの名前。

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--schema

型を定義する JSON スキーマ。

プロパティ	値
パラメーターグループ:	Properties Arguments

--service-name -n

Azure API Center サービスの名前。

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apic metadata delete

指定したメタデータスキーマを削除します。

az apic metadata delete [--ids]
                        [--metadata-name]
                        [--resource-group]
                        [--service-name]
                        [--subscription]
                        [--yes]

例

メタデータスキーマの削除

az apic metadata delete --resource-group api-center-test --service-name contoso --metadata-name "test1"

スキーマの削除

az apic metadata delete -g api-center-test -n contosoeuap --metadata-name "approver"

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

1 つ以上のリソース ID (スペース区切り)。これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--metadata-name

メタデータスキーマの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--service-name -n

Azure API Center サービスの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apic metadata export

メタデータスキーマをエクスポートします。

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--custom-metadata-only {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                        [--resource-group]
                        [--service-name]
                        [--subscription]

例

API に割り当てられたメタデータスキーマのエクスポート

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json

デプロイに割り当てられたメタデータスキーマのエクスポート

az apic metadata export -g api-center-test -n contosoeuap --assignments deployment --file-name filename.json

環境に割り当てられたメタデータスキーマをエクスポートする

az apic metadata export -g api-center-test -n contosoeuap --assignments environment --file-name filename.json

カスタムメタデータスキーマのみをエクスポートする

az apic metadata export -g api-center-test -n contosoeuap --assignments api --file-name filename.json --custom-metadata-only

必須のパラメーター

--assignments

メタデータスキーマが要求されるエンティティ。

プロパティ	値
パラメーターグループ:	Payload Arguments
指定可能な値:	api, deployment, environment

--file-name

メタデータスキーマのエクスポート先となるファイルの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--custom-metadata-only

カスタムメタデータのみをエクスポートします。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--ids

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--service-name -n

API センターサービスの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apic metadata list

メタデータスキーマのコレクションを一覧表示します。

az apic metadata list --resource-group
                      --service-name
                      [--filter]
                      [--max-items]
                      [--next-token]

例

スキーマを一覧表示する

az apic metadata list -g api-center-test -n contosoeuap

必須のパラメーター

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name -n

Azure API Center サービスの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--filter

OData フィルターパラメーター。

--max-items

コマンドの出力で返される項目の合計数。使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

プロパティ	値
パラメーターグループ:	Pagination Arguments

--next-token

ページ分割を開始する場所を指定するトークン。これは、以前に切り捨てられた応答からのトークン値です。

プロパティ	値
パラメーターグループ:	Pagination Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apic metadata show

メタデータスキーマの詳細を取得します。

az apic metadata show [--ids]
                      [--metadata-name]
                      [--resource-group]
                      [--service-name]
                      [--subscription]

例

スキーマの詳細を表示する 1

az apic metadata show -g api-center-test -n contosoeuap --metadata-name approver

スキーマの詳細を表示する 2

az apic metadata show --resource-group api-center-test --service-name contoso --metadata-name "testchoices"

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--ids

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--metadata-name

メタデータスキーマの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--service-name -n

Azure API Center サービスの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

az apic metadata update

既存のメタデータスキーマを更新します。

az apic metadata update [--add]
                        [--assignments]
                        [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                        [--ids]
                        [--metadata-name]
                        [--remove]
                        [--resource-group]
                        [--schema]
                        [--service-name]
                        [--set]
                        [--subscription]

例

スキーマを更新する

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '{"type":"string", "title":"Last name", "pattern": "^[a-zA-Z0-9]+$"}'

スキーマ json ファイルを使用してスキーマを更新する

az apic metadata update --resource-group api-center-test --service-name contoso --metadata-name "test1" --schema '@schema.json'

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。例: --add property.listProperty <key=value, string or JSON string>。

プロパティ	値
パラメーターグループ:	Generic Update Arguments

--assignments

プロパティ	値
パラメーターグループ:	Properties Arguments

--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ	値
パラメーターグループ:	Generic Update Arguments
指定可能な値:	0, 1, f, false, n, no, t, true, y, yes

--ids

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--metadata-name

メタデータスキーマの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--remove

リストからプロパティまたは要素を削除します。例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ	値
パラメーターグループ:	Generic Update Arguments

--resource-group -g

リソースグループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--schema

型を定義する YAML スキーマ。

プロパティ	値
パラメーターグループ:	Properties Arguments

--service-name -n

Azure API Center サービスの名前。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

--set

設定するプロパティパスと値を指定して、オブジェクトを更新します。例: --set property1.property2=<value>。

プロパティ	値
パラメーターグループ:	Generic Update Arguments

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ	値
パラメーターグループ:	Resource Id Arguments

グローバルパラメーター

--debug

ログの詳細度を上げて、すべてのデバッグログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプメッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。完全なデバッグログには --debug を使用します。

プロパティ	値
規定値:	False

フィードバック

このページはお役に立ちましたか?

次の方法で共有

az apic metadata

コマンド

az apic metadata create

例

必須のパラメーター

az apic metadata delete

例

オプションのパラメーター

az apic metadata export

例

必須のパラメーター

オプションのパラメーター

az apic metadata list

例

必須のパラメーター

オプションのパラメーター

az apic metadata show

例

オプションのパラメーター

az apic metadata update

例

オプションのパラメーター

フィードバック