az storage file metadata

Note

このコマンド グループには、Azure CLIと少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細については、 を参照してください。

ファイル メタデータを管理します。

コマンド

名前 説明 型 状態
az storage file metadata show

ファイルのすべてのユーザー定義メタデータを返します。

 Core GA
az storage file metadata show (storage-preview 拡張機能)

ファイルのすべてのユーザー定義メタデータを返します。

 Extension GA
az storage file metadata update

ファイル メタデータを更新します。

 Core GA
az storage file metadata update (storage-preview 拡張機能)

ファイル メタデータを更新します。

 Extension GA

az storage file metadata show

編集

ファイルのすべてのユーザー定義メタデータを返します。

az storage file metadata show --path
                              --share-name
                              [--account-key]
                              [--account-name]
                              [--auth-mode {key, login}]
                              [--backup-intent --enable-file-backup-request-intent]
                              [--connection-string]
                              [--disallow-trailing-dot {false, true}]
                              [--file-endpoint]
                              [--sas-token]
                              [--snapshot]
                              [--timeout]

例

ファイルのメタデータを表示する

az storage file metadata show -s MyShare --path /path/to/file

必須のパラメーター

--path -p

ファイル共有内のファイルへのパス。

--share-name -s

ファイル共有名。

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

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

--account-key

ストレージ アカウント キー。 ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--account-name

ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは、認証されたAzure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--auth-mode

コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。

プロパティ 値
指定可能な値: key, login
--backup-intent --enable-file-backup-request-intent

ファイルの OAuth (Azure AD) 認証で使用するために必要なパラメーター。 これにより、ファイル/ディレクトリ レベルのアクセス許可チェックがバイパスされ、許可されたデータ アクションに基づいて、それらのファイル/ディレクトリに ACL が設定されている場合でも、アクセスが許可されます。

プロパティ 値
規定値: False
--connection-string

ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--disallow-trailing-dot

true の場合、末尾のドットはターゲット URI からトリミングされます。 既定値は False です。

プロパティ 値
規定値: False
指定可能な値: false, true
--file-endpoint

ストレージ データ サービス エンドポイント。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 az storage account showを使用して各サービス プライマリ エンドポイントを見つけることができます。 環境変数: AZURE_STORAGE_SERVICE_ENDPOINT。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--sas-token

共有アクセス署名 (SAS) ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--snapshot

スナップショットのバージョンを表す文字列 (該当する場合)。

--timeout

要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。

グローバル パラメーター
--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 storage file metadata show (storage-preview 拡張機能)

ファイルのすべてのユーザー定義メタデータを返します。

az storage file metadata show --path
                              --share-name
                              [--account-key]
                              [--account-name]
                              [--auth-mode {key, login}]
                              [--backup-intent --enable-file-backup-request-intent]
                              [--connection-string]
                              [--disallow-trailing-dot {false, true}]
                              [--sas-token]
                              [--snapshot]
                              [--timeout]

例

ファイルのメタデータを表示する

az storage file metadata show -s MyShare --path /path/to/file

必須のパラメーター

--path -p

ファイル共有内のファイルへのパス。

--share-name -s

ファイル共有名。

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

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

--account-key

ストレージ アカウント キー。 ストレージ アカウント名と組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--account-name

ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは、認証されたAzure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--auth-mode

コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。

プロパティ 値
指定可能な値: key, login
--backup-intent --enable-file-backup-request-intent

ファイルの OAuth (Azure AD) 認証で使用するために必要なパラメーター。 これにより、ファイル/ディレクトリ レベルのアクセス許可チェックがバイパスされ、許可されたデータ アクションに基づいて、それらのファイル/ディレクトリに ACL が設定されている場合でも、アクセスが許可されます。

プロパティ 値
規定値: False
--connection-string

ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--disallow-trailing-dot

true の場合、末尾のドットはターゲット URI からトリミングされます。 既定値は False です。

プロパティ 値
規定値: False
指定可能な値: false, true
--sas-token

共有アクセス署名 (SAS) ストレージ アカウント名と組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--snapshot

スナップショットのバージョンを表す文字列 (該当する場合)。

--timeout

要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。

グローバル パラメーター
--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 storage file metadata update

編集

ファイル メタデータを更新します。

az storage file metadata update --path
                                --share-name
                                [--account-key]
                                [--account-name]
                                [--acquire-policy-token]
                                [--auth-mode {key, login}]
                                [--backup-intent --enable-file-backup-request-intent]
                                [--change-reference]
                                [--connection-string]
                                [--disallow-trailing-dot {false, true}]
                                [--file-endpoint]
                                [--metadata]
                                [--sas-token]
                                [--timeout]

例

ファイルのメタデータを更新する

az storage file metadata update -s MyShare --path /path/to/file --metadata key1=value1

必須のパラメーター

--path -p

ファイル共有内のファイルへのパス。

--share-name -s

ファイル共有名。

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

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

--account-key

ストレージ アカウント キー。 ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--account-name

ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは、認証されたAzure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--auth-mode

コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。

プロパティ 値
指定可能な値: key, login
--backup-intent --enable-file-backup-request-intent

ファイルの OAuth (Azure AD) 認証で使用するために必要なパラメーター。 これにより、ファイル/ディレクトリ レベルのアクセス許可チェックがバイパスされ、許可されたデータ アクションに基づいて、それらのファイル/ディレクトリに ACL が設定されている場合でも、アクセスが許可されます。

プロパティ 値
規定値: False
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--connection-string

ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--disallow-trailing-dot

true の場合、末尾のドットはターゲット URI からトリミングされます。 既定値は False です。

プロパティ 値
規定値: False
指定可能な値: false, true
--file-endpoint

ストレージ データ サービス エンドポイント。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 az storage account showを使用して各サービス プライマリ エンドポイントを見つけることができます。 環境変数: AZURE_STORAGE_SERVICE_ENDPOINT。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--metadata

スペース区切りのキーと値のペアのメタデータ。 これにより、既存のメタデータが上書きされます。

--sas-token

共有アクセス署名 (SAS) ストレージ アカウント名またはサービス エンドポイントと組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--timeout

要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。

グローバル パラメーター
--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 storage file metadata update (storage-preview 拡張機能)

ファイル メタデータを更新します。

az storage file metadata update --path
                                --share-name
                                [--account-key]
                                [--account-name]
                                [--acquire-policy-token]
                                [--auth-mode {key, login}]
                                [--backup-intent --enable-file-backup-request-intent]
                                [--change-reference]
                                [--connection-string]
                                [--disallow-trailing-dot {false, true}]
                                [--metadata]
                                [--sas-token]
                                [--timeout]

例

ファイルのメタデータを更新する

az storage file metadata update -s MyShare --path /path/to/file --metadata key1=value1

必須のパラメーター

--path -p

ファイル共有内のファイルへのパス。

--share-name -s

ファイル共有名。

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

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

--account-key

ストレージ アカウント キー。 ストレージ アカウント名と組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_KEY。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--account-name

ストレージ アカウント名。 関連する環境変数: AZURE_STORAGE_ACCOUNT。 ストレージ アカウント キーまたは SAS トークンと組み合わせて使用する必要があります。 どちらも存在しない場合、コマンドは、認証されたAzure アカウントを使用してストレージ アカウント キーのクエリを試みます。 多数のストレージ コマンドが実行されると、API クォータに達する可能性があります。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--auth-mode

コマンドを実行するモード。 "ログイン" モードでは、認証にログイン資格情報が直接使用されます。 従来の "キー" モードでは、アカウントの認証パラメーターが指定されていない場合、アカウント キーのクエリが試行されます。 環境変数: AZURE_STORAGE_AUTH_MODE。

プロパティ 値
指定可能な値: key, login
--backup-intent --enable-file-backup-request-intent

ファイルの OAuth (Azure AD) 認証で使用するために必要なパラメーター。 これにより、ファイル/ディレクトリ レベルのアクセス許可チェックがバイパスされ、許可されたデータ アクションに基づいて、それらのファイル/ディレクトリに ACL が設定されている場合でも、アクセスが許可されます。

プロパティ 値
規定値: False
--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ 値
パラメーター グループ: Global Policy Arguments
--connection-string

ストレージ アカウントの接続文字列。 環境変数: AZURE_STORAGE_CONNECTION_STRING。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--disallow-trailing-dot

true の場合、末尾のドットはターゲット URI からトリミングされます。 既定値は False です。

プロパティ 値
規定値: False
指定可能な値: false, true
--metadata

スペース区切りのキーと値のペアのメタデータ。 これにより、既存のメタデータが上書きされます。

--sas-token

共有アクセス署名 (SAS) ストレージ アカウント名と組み合わせて使用する必要があります。 環境変数: AZURE_STORAGE_SAS_TOKEN。

プロパティ 値
パラメーター グループ: Storage Account Arguments
--timeout

要求タイムアウト (秒単位)。 サービスへの各呼び出しに適用されます。

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