Share via

az spring apm

  • リファレンス

Note

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

(エンタープライズ層のみ)Azure Spring Apps で API を管理するためのコマンド。

コマンド

名前 説明 型 Status
az spring apm create

(エンタープライズ層のみ)APM を作成します。

 拡張子 GA
az spring apm delete

(エンタープライズ層のみ)APM を削除します。

 拡張子 GA
az spring apm disable-globally

(エンタープライズ層のみ)APM をグローバルに無効にします。

 拡張子 GA
az spring apm enable-globally

(エンタープライズ層のみ)APM をグローバルに有効にします。

 拡張子 GA
az spring apm list

(エンタープライズ層のみ)Azure Spring Apps 内のすべての API を一覧表示します。 シークレットは省略されます。

 拡張子 GA
az spring apm list-enabled-globally

(エンタープライズ層のみ)Azure Spring Apps でグローバルに有効になっているすべての API を一覧表示します。

 拡張子 GA
az spring apm list-support-types

(エンタープライズ層のみ)Azure Spring Apps でサポートされているすべての APM の種類を一覧表示します。

 拡張子 GA
az spring apm show

(エンタープライズ層のみ)APM を表示します。 シークレットはマスクされます。

 拡張子 GA
az spring apm update

(エンタープライズ層のみ)APM を更新します。

 拡張子 GA

az spring apm create

(エンタープライズ層のみ)APM を作成します。

az spring apm create --name
                     --resource-group
                     --service
                     --type
                     [--no-wait]
                     [--properties]
                     [--secrets]

例

シークレットのみを含む APM を作成します。

az spring apm create --name first-apm --type ApplicationInsights --secrets k1=v1 k2=v2 --service MyCluster --resource-group MyResourceGroup

プロパティのみを含む APM を作成します。

az spring apm create --name first-apm --type ApplicationInsights --properties a=b c=d --service MyCluster --resource-group MyResourceGroup

プロパティとシークレットを含む APM を作成します。

az spring apm create --name first-apm --type ApplicationInsights --properties a=b c=d --secrets k1=v1 k2=v2 --service MyCluster --resource-group MyResourceGroup

必須のパラメーター

--name -n

APM 名。

--resource-group -g

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

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

--type

APM に必要な型。 "az spring apm list-support-types" を実行して、サポートされているすべての APM 型を取得します。

省略可能のパラメーター

--no-wait

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

既定値: False
--properties

APM の機密性の高いプロパティ。 "key[=value]" の書式を設定します。

--secrets

APM の機密性の高いプロパティ。 一度置くと、暗号化され、ユーザーに戻ることはありません。 "key[=value]" の書式を設定します。

グローバル パラメーター
--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 spring apm delete

(エンタープライズ層のみ)APM を削除します。

az spring apm delete --name
                     --resource-group
                     --service
                     [--no-wait]
                     [--yes]

例

APM を削除します。

az spring apm delete --name first-apm --service MyCluster --resource-group MyResourceGroup

必須のパラメーター

--name -n

APM 名。

--resource-group -g

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

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

省略可能のパラメーター

--no-wait

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

既定値: False
--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 spring apm disable-globally

(エンタープライズ層のみ)APM をグローバルに無効にします。

az spring apm disable-globally --name
                               --resource-group
                               --service
                               [--no-wait]

例

APM をグローバルに無効にします。

az spring apm disable-globally --name first-apm --service MyCluster --resource-group MyResourceGroup

必須のパラメーター

--name -n

APM 名。

--resource-group -g

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

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

省略可能のパラメーター

--no-wait

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

既定値: 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 spring apm enable-globally

(エンタープライズ層のみ)APM をグローバルに有効にします。

az spring apm enable-globally --name
                              --resource-group
                              --service
                              [--no-wait]

例

APM をグローバルに有効にします。

az spring apm enable-globally --name first-apm --service MyCluster --resource-group MyResourceGroup

必須のパラメーター

--name -n

APM 名。

--resource-group -g

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

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

省略可能のパラメーター

--no-wait

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

既定値: 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 spring apm list

(エンタープライズ層のみ)Azure Spring Apps 内のすべての API を一覧表示します。 シークレットは省略されます。

az spring apm list --resource-group
                   --service

例

Azure Spring Apps 内のすべての API を一覧表示します。

az spring apm list --service MyCluster --resource-group MyResourceGroup

必須のパラメーター

--resource-group -g

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

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

グローバル パラメーター
--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 spring apm list-enabled-globally

(エンタープライズ層のみ)Azure Spring Apps でグローバルに有効になっているすべての API を一覧表示します。

az spring apm list-enabled-globally --resource-group
                                    --service

例

Azure Spring Apps でグローバルに有効になっているすべての API を一覧表示します。

az spring apm list-enabled-globally --service MyCluster --resource-group MyResourceGroup

必須のパラメーター

--resource-group -g

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

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

グローバル パラメーター
--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 spring apm list-support-types

(エンタープライズ層のみ)Azure Spring Apps でサポートされているすべての APM の種類を一覧表示します。

az spring apm list-support-types --resource-group
                                 --service

例

Azure Spring Apps でサポートされているすべての APM の種類を一覧表示します。

az spring apm list-support-types --service MyCluster --resource-group MyResourceGroup

必須のパラメーター

--resource-group -g

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

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

グローバル パラメーター
--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 spring apm show

(エンタープライズ層のみ)APM を表示します。 シークレットはマスクされます。

az spring apm show --name
                   --resource-group
                   --service

例

APM を表示します。

az spring apm show --name first-apm --service MyCluster --resource-group MyResourceGroup

必須のパラメーター

--name -n

APM 名。

--resource-group -g

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

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

グローバル パラメーター
--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 spring apm update

(エンタープライズ層のみ)APM を更新します。

az spring apm update --name
                     --resource-group
                     --service
                     --type
                     [--no-wait]
                     [--properties]
                     [--secrets]

例

プロパティとシークレットを使用して APM を更新します。

az spring apm update --name first-apm --type ApplicationInsights --properties a=b c=d --secrets k1=v1 k2=v2 --service MyCluster --resource-group MyResourceGroup

必須のパラメーター

--name -n

APM 名。

--resource-group -g

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

--service -s

Azure Spring Apps インスタンスの名前。az configure --defaults spring= を使用して既定のサービスを構成できます。

--type

APM に必要な型。 "az spring apm list-support-types" を実行して、サポートされているすべての APM 型を取得します。

省略可能のパラメーター

--no-wait

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

既定値: False
--properties

APM の機密性の高いプロパティ。 "key[=value]" の書式を設定します。

--secrets

APM の機密性の高いプロパティ。 一度置くと、暗号化され、ユーザーに戻ることはありません。 "key[=value]" の書式を設定します。

グローバル パラメーター
--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 を使います。