az apic metadata

リファレンス

Note

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

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

コマンド

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

必須のパラメーター

--assignments

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

--metadata-name

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

--resource-group -g

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

--schema

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

--service-name -n

Azure API Center サービスの名前。

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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"

省略可能のパラメーター

--ids

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

--metadata-name

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

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--subscription

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

--yes -y

確認のダイアログを表示しません。

規定値: False

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

az apic metadata export

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

az apic metadata export --assignments {api, deployment, environment}
                        --file-name
                        [--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

必須のパラメーター

--assignments

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

指定可能な値: api, deployment, environment

--file-name

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

省略可能のパラメーター

--ids

--no-wait

実行時間の長い操作の終了を待機しません。

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

--service-name -n

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

--subscription

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

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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 サービスの名前。

省略可能のパラメーター

--filter

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

--max-items

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

--next-token

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

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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"

省略可能のパラメーター

--ids

--metadata-name

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

--resource-group -g

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

--service-name -n

Azure API Center サービスの名前。

--subscription

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

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

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]+$"}'

省略可能のパラメーター

--add

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

--assignments

--force-string

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--ids

--metadata-name

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

--remove

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

--resource-group -g

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

--schema

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

--service-name -n

Azure API Center サービスの名前。

--set

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

--subscription

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

グローバルパラメーター

--debug

すべてのデバッグログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc

規定値: json

--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。詳細なデバッグログを表示するには --debug を使います。

次の方法で共有

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

例

省略可能のパラメーター

その他のリソース