az appconfig snapshot

アプリ構成ストアに関連付けられているスナップショットを管理します。

コマンド

名前	説明	型	状態
az appconfig snapshot archive	スナップショットをアーカイブします。	コア	GA
az appconfig snapshot create	アプリ構成スナップショットを作成します。	コア	GA
az appconfig snapshot list	スナップショットを一覧表示します。	コア	GA
az appconfig snapshot recover	アーカイブされたスナップショットを回復します。	コア	GA
az appconfig snapshot show	アプリ構成スナップショットのすべての属性を表示します。	コア	GA

az appconfig snapshot archive

スナップショットをアーカイブします。

az appconfig snapshot archive --snapshot-name
                              [--auth-mode {key, login}]
                              [--connection-string]
                              [--endpoint]
                              [--name]

例

構成ストア MyAppConfiguration のアーカイブ スナップショット MySnapshot。

az appconfig snapshot archive -s MySnapshot -n MyAppConfiguration

必須のパラメーター

--snapshot-name -s

アプリ構成スナップショットの名前。

省略可能のパラメーター

--auth-mode

このパラメーターは、データ操作を承認する方法を示すために使用できます。 認証モードが "キー" の場合は、接続文字列またはストア名を指定すると、承認のためにアカウント アクセス キーが取得されます。 認証モードが "login" の場合は、 --endpoint または --name を指定します。"az login" 資格情報が承認に使用されます。 az configure --defaults appconfig_auth_mode=<auth_mode>を使用して、既定の認証モードを構成できます。 詳細については、https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbacを参照してください。

指定可能な値: key, login

規定値: key

--connection-string

App Configuration ストアのアクセス キーとエンドポイントの組み合わせ。 'az appconfig credential list' を使用して見つけることができます。 ユーザーは、 az configure --defaults appconfig_connection_string=<connection_string> または環境変数を使用して、AZURE_APPCONFIG_CONNECTION_STRINGという名前で事前設定できます。

--endpoint

認証モードが "login" の場合は、App Configuration ストアのエンドポイント URL を指定します。 エンドポイントは、"az appconfig show" コマンドを使用して取得できます。 既定のエンドポイントは、 az configure --defaults appconfig_endpoint=<endpoint>を使用して構成できます。

--name -n

App Configuration ストアの名前。 既定の名前は、 az configure --defaults app_configuration_store=<name>を使用して構成できます。

グローバル パラメーター

--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 appconfig snapshot create

アプリ構成スナップショットを作成します。

az appconfig snapshot create --filters
                             --snapshot-name
                             [--auth-mode {key, login}]
                             [--composition-type {key, key_label}]
                             [--connection-string]
                             [--endpoint]
                             [--name]
                             [--retention-period]
                             [--tags]

例

構成ストア MyAppConfiguration で 'Test' で始まるすべてのキーのスナップショット MySnapshot を作成します。

az appconfig snapshot create -s MySnapshot -n MyAppConfiguration --filters '{\"key\":\"Test*\"}'

'abc' で始まり、保持期間が 1 時間であるすべてのキーのスナップショット MySnapshot を作成します。

az appconfig snapshot create -s MySnapshot -n MyAppConfiguration --filters '{\"key\":\"abc*\"}' --retention-period 3600

"app/" で始まり、ラベルが既定で指定されていないすべてのキーのスナップショットを作成し、キー値が存在する場合は、キーの値を "prod" というラベルでオーバーライドします。

az appconfig snapshot create -s MySnapshot -n MyAppConfiguration --filters '{\"key\":\"app/*\"}' '{\"key\":\"app/*\", \"label\":\"prod\"}' --composition-type 'key'

必須のパラメーター

--filters

App Configuration スナップショットの作成に使用されるキーフィルターとラベル フィルターを表すエスケープされた JSON オブジェクトのスペース区切りのリスト。

--snapshot-name -s

アプリ構成スナップショットの名前。

省略可能のパラメーター

--auth-mode

このパラメーターは、データ操作を承認する方法を示すために使用できます。 認証モードが "キー" の場合は、接続文字列またはストア名を指定すると、承認のためにアカウント アクセス キーが取得されます。 認証モードが "login" の場合は、 --endpoint または --name を指定します。"az login" 資格情報が承認に使用されます。 az configure --defaults appconfig_auth_mode=<auth_mode>を使用して、既定の認証モードを構成できます。 詳細については、https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbacを参照してください。

指定可能な値: key, login

規定値: key

--composition-type

App Configuration スナップショットの構築に使用されるコンポジションの種類。 指定しない場合、既定値は key です。

指定可能な値: key, key_label

--connection-string

App Configuration ストアのアクセス キーとエンドポイントの組み合わせ。 'az appconfig credential list' を使用して見つけることができます。 ユーザーは、 az configure --defaults appconfig_connection_string=<connection_string> または環境変数を使用して、AZURE_APPCONFIG_CONNECTION_STRINGという名前で事前設定できます。

--endpoint

認証モードが "login" の場合は、App Configuration ストアのエンドポイント URL を指定します。 エンドポイントは、"az appconfig show" コマンドを使用して取得できます。 既定のエンドポイントは、 az configure --defaults appconfig_endpoint=<endpoint>を使用して構成できます。

--name -n

App Configuration ストアの名前。 既定の名前は、 az configure --defaults app_configuration_store=<name>を使用して構成できます。

--retention-period

有効期限が切れる前にスナップショットをアーカイブできる期間 (秒単位)。 スナップショットは、Free レベル ストアの場合は最大 7 日間 (604,800 秒)、Standard レベルストアの場合は 90 日間 (7,776,000 秒) アーカイブできます。 指定する場合、保持期間は少なくとも 1 時間 (3600 秒) である必要があります。

--tags

スペース区切りのタグ: key[=value] [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 appconfig snapshot list

スナップショットを一覧表示します。

az appconfig snapshot list [--all]
                           [--auth-mode {key, login}]
                           [--connection-string]
                           [--endpoint]
                           [--fields {composition_type, created, etag, expires, filters, items_count, name, retention_period, size, status, tags}]
                           [--name]
                           [--snapshot-name]
                           [--status {archived, failed, provisioning, ready}]
                           [--top]

例

プレフィックス 'abc' で始まる名前を持つすべてのスナップショットを一覧表示します。

az appconfig snapshot list -s abc* -n MyAppConfiguration

アーカイブされたすべてのスナップショットを一覧表示します。

az appconfig snapshot list --status archived -n MyAppConfiguration

プレフィックス 'app' で始まる名前を持つすべてのプロビジョニング スナップショットを一覧表示します。

az appconfig snapshot list -s app* --status provisioning -n MyAppConfiguration

失敗したすべてのスナップショットとプロビジョニング スナップショットを一覧表示します。

az appconfig snapshot list --status failed provisioning -n MyAppConfiguration

省略可能のパラメーター

--all

すべてのアイテムを一覧表示します。

--auth-mode

このパラメーターは、データ操作を承認する方法を示すために使用できます。 認証モードが "キー" の場合は、接続文字列またはストア名を指定すると、承認のためにアカウント アクセス キーが取得されます。 認証モードが "login" の場合は、 --endpoint または --name を指定します。"az login" 資格情報が承認に使用されます。 az configure --defaults appconfig_auth_mode=<auth_mode>を使用して、既定の認証モードを構成できます。 詳細については、https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbacを参照してください。

指定可能な値: key, login

規定値: key

--connection-string

App Configuration ストアのアクセス キーとエンドポイントの組み合わせ。 'az appconfig credential list' を使用して見つけることができます。 ユーザーは、 az configure --defaults appconfig_connection_string=<connection_string> または環境変数を使用して、AZURE_APPCONFIG_CONNECTION_STRINGという名前で事前設定できます。

--endpoint

認証モードが "login" の場合は、App Configuration ストアのエンドポイント URL を指定します。 エンドポイントは、"az appconfig show" コマンドを使用して取得できます。 既定のエンドポイントは、 az configure --defaults appconfig_endpoint=<endpoint>を使用して構成できます。

--fields

スナップショットの出力フィールドをカスタマイズします。

指定可能な値: composition_type, created, etag, expires, filters, items_count, name, retention_period, size, status, tags

--name -n

App Configuration ストアの名前。 既定の名前は、 az configure --defaults app_configuration_store=<name>を使用して構成できます。

--snapshot-name -s

名前が指定されていない場合は、既定ですべてのスナップショットを返します。 たとえば abc* のように、フィルターとしての星印のサポートは、名前のプレフィックスとして abc を持つスナップショットを意味します。

規定値: *

--status

スナップショットを状態でフィルター処理します。 状態が指定されていない場合は、既定ですべてのスナップショットを返します。

指定可能な値: archived, failed, provisioning, ready

--top -t

返すアイテムの最大数。 正の整数にする必要があります。 既定値は 100 です。

グローバル パラメーター

--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 appconfig snapshot recover

アーカイブされたスナップショットを回復します。

az appconfig snapshot recover --snapshot-name
                              [--auth-mode {key, login}]
                              [--connection-string]
                              [--endpoint]
                              [--name]

例

構成ストア MyAppConfiguration でスナップショット MySnapshot を回復します。

az appconfig snapshot recover -s MySnapshot -n MyAppConfiguration

必須のパラメーター

--snapshot-name -s

アプリ構成スナップショットの名前。

省略可能のパラメーター

--auth-mode

このパラメーターは、データ操作を承認する方法を示すために使用できます。 認証モードが "キー" の場合は、接続文字列またはストア名を指定すると、承認のためにアカウント アクセス キーが取得されます。 認証モードが "login" の場合は、 --endpoint または --name を指定します。"az login" 資格情報が承認に使用されます。 az configure --defaults appconfig_auth_mode=<auth_mode>を使用して、既定の認証モードを構成できます。 詳細については、https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbacを参照してください。

指定可能な値: key, login

規定値: key

--connection-string

App Configuration ストアのアクセス キーとエンドポイントの組み合わせ。 'az appconfig credential list' を使用して見つけることができます。 ユーザーは、 az configure --defaults appconfig_connection_string=<connection_string> または環境変数を使用して、AZURE_APPCONFIG_CONNECTION_STRINGという名前で事前設定できます。

--endpoint

認証モードが "login" の場合は、App Configuration ストアのエンドポイント URL を指定します。 エンドポイントは、"az appconfig show" コマンドを使用して取得できます。 既定のエンドポイントは、 az configure --defaults appconfig_endpoint=<endpoint>を使用して構成できます。

--name -n

App Configuration ストアの名前。 既定の名前は、 az configure --defaults app_configuration_store=<name>を使用して構成できます。

グローバル パラメーター

--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 appconfig snapshot show

アプリ構成スナップショットのすべての属性を表示します。

az appconfig snapshot show --snapshot-name
                           [--auth-mode {key, login}]
                           [--connection-string]
                           [--endpoint]
                           [--fields {composition_type, created, etag, expires, filters, items_count, name, retention_period, size, status, tags}]
                           [--name]

例

構成ストア MyAppConfiguration に MySnapshot という名前のアプリ構成スナップショットを表示します。

az appconfig snapshot show -s MySnapshot -n MyAppConfiguration

必須のパラメーター

--snapshot-name -s

アプリ構成スナップショットの名前。

省略可能のパラメーター

--auth-mode

このパラメーターは、データ操作を承認する方法を示すために使用できます。 認証モードが "キー" の場合は、接続文字列またはストア名を指定すると、承認のためにアカウント アクセス キーが取得されます。 認証モードが "login" の場合は、 --endpoint または --name を指定します。"az login" 資格情報が承認に使用されます。 az configure --defaults appconfig_auth_mode=<auth_mode>を使用して、既定の認証モードを構成できます。 詳細については、https://docs.microsoft.com/azure/azure-app-configuration/concept-enable-rbacを参照してください。

指定可能な値: key, login

規定値: key

--connection-string

App Configuration ストアのアクセス キーとエンドポイントの組み合わせ。 'az appconfig credential list' を使用して見つけることができます。 ユーザーは、 az configure --defaults appconfig_connection_string=<connection_string> または環境変数を使用して、AZURE_APPCONFIG_CONNECTION_STRINGという名前で事前設定できます。

--endpoint

認証モードが "login" の場合は、App Configuration ストアのエンドポイント URL を指定します。 エンドポイントは、"az appconfig show" コマンドを使用して取得できます。 既定のエンドポイントは、 az configure --defaults appconfig_endpoint=<endpoint>を使用して構成できます。

--fields

スナップショットの出力フィールドをカスタマイズします。

指定可能な値: composition_type, created, etag, expires, filters, items_count, name, retention_period, size, status, tags

--name -n

App Configuration ストアの名前。 既定の名前は、 az configure --defaults app_configuration_store=<name>を使用して構成できます。

グローバル パラメーター

--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 を使います。