BlobBaseClient クラス

定義

BlobBaseClient を使用すると、Azure Storage の BLOB を操作できます。

public class BlobBaseClient
type BlobBaseClient = class
Public Class BlobBaseClient
継承
BlobBaseClient
派生

コンストラクター

BlobBaseClient()

BlobBaseClient クラスの新しいインスタンスを初期化します。

BlobBaseClient(String, String, String)

BlobBaseClient クラスの新しいインスタンスを初期化します。

BlobBaseClient(String, String, String, BlobClientOptions)

BlobBaseClient クラスの新しいインスタンスを初期化します。

BlobBaseClient(Uri, AzureSasCredential, BlobClientOptions)

BlobBaseClient クラスの新しいインスタンスを初期化します。

BlobBaseClient(Uri, BlobClientOptions)

BlobBaseClient クラスの新しいインスタンスを初期化します。

BlobBaseClient(Uri, StorageSharedKeyCredential, BlobClientOptions)

BlobBaseClient クラスの新しいインスタンスを初期化します。

BlobBaseClient(Uri, TokenCredential, BlobClientOptions)

BlobBaseClient クラスの新しいインスタンスを初期化します。

プロパティ

AccountName

BLOB クライアントに対応するストレージ アカウント名を取得します。

BlobContainerName

BLOB クライアントに対応するコンテナー名を取得します。

CanGenerateSasUri

クライアントが SAS を生成できるかどうかを判断します。 クライアントが で認証されている場合。StorageSharedKeyCredential

Name

BLOB の名前を取得します。

Uri

BLOB のプライマリ Uri エンドポイントを取得します。

メソッド

AbortCopyFromUri(String, BlobRequestConditions, CancellationToken)

この操作は AbortCopyFromUri(String, BlobRequestConditions, CancellationToken) 保留中 CopyFromUriOperationの を中止し、この BLOB の長さと完全なメタデータを残します。

詳細については、「 BLOB のコピーを中止します

AbortCopyFromUriAsync(String, BlobRequestConditions, CancellationToken)

この操作は AbortCopyFromUriAsync(String, BlobRequestConditions, CancellationToken) 保留中 CopyFromUriOperationの を中止し、この BLOB の長さと完全なメタデータを残します。

詳細については、「 BLOB のコピーを中止します

CreateSnapshot(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

CreateSnapshot(IDictionary<String,String>, BlobRequestConditions, CancellationToken) 操作は、BLOB の読み取り専用スナップショットを作成します。

詳細については、「 スナップショット BLOB

CreateSnapshotAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

CreateSnapshotAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken) 操作は、BLOB の読み取り専用スナップショットを作成します。

詳細については、「 スナップショット BLOB

Delete(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

Delete(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) 操作は、指定した BLOB またはスナップショットを削除対象としてマークします。 後でガベージ コレクション中に BLOB が削除され、数分かかる場合があります。

BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 を使用して IncludeSnapshots、両方を同時に削除できます。

詳細については、「 BLOB を削除します

DeleteAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

DeleteAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken) 操作は、指定した BLOB またはスナップショットを削除対象としてマークします。 後でガベージ コレクション中に BLOB が削除され、数分かかる場合があります。

BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 を使用して IncludeSnapshots、両方を同時に削除できます。

詳細については、「 BLOB を削除します

DeleteIfExists(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

この操作によりDeleteIfExists(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)、指定した BLOB またはスナップショットが削除対象としてマークされます (BLOB が存在する場合)。 後でガベージ コレクション中に BLOB が削除され、数分かかる場合があります。

BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 を使用して IncludeSnapshots、両方を同時に削除できます。

詳細については、「 BLOB を削除します

DeleteIfExistsAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)

この操作によりDeleteIfExistsAsync(DeleteSnapshotsOption, BlobRequestConditions, CancellationToken)、指定した BLOB またはスナップショットが削除対象としてマークされます (BLOB が存在する場合)。 後でガベージ コレクション中に BLOB が削除され、数分かかる場合があります。

BLOB を削除するには、そのスナップショットをすべて削除する必要があります。 を使用して IncludeSnapshots、両方を同時に削除できます。

詳細については、「 BLOB を削除します

DeleteImmutabilityPolicy(CancellationToken)

BLOB に関連付けられている不変ポリシーを削除します。 ストレージ アカウントで BLOB のバージョン管理を有効にする必要があり、この API を呼び出すには、バージョン管理が有効になっている不変ストレージを持つコンテナー内に BLOB が存在する必要があることに注意してください。

DeleteImmutabilityPolicyAsync(CancellationToken)

BLOB に関連付けられている不変ポリシーを削除します。 ストレージ アカウントで BLOB のバージョン管理を有効にする必要があり、この API を呼び出すには、バージョン管理が有効になっている不変ストレージを持つコンテナー内に BLOB が存在する必要があることに注意してください。

DownloadContent()

この操作では DownloadContent() 、メタデータとプロパティを含む BLOB がサービスからダウンロードされます。

詳細については、「 BLOB を取得します

DownloadContent(BlobDownloadOptions, CancellationToken)

この操作では DownloadContent(BlobDownloadOptions, CancellationToken) 、メタデータとプロパティを含む BLOB がサービスからダウンロードされます。

詳細については、「 BLOB を取得します

DownloadContent(CancellationToken)

この操作では DownloadContent(CancellationToken) 、メタデータとプロパティを含む BLOB がサービスからダウンロードされます。

詳細については、「 BLOB を取得します

DownloadContentAsync()

この操作では DownloadContentAsync() 、メタデータとプロパティを含む BLOB がサービスからダウンロードされます。

詳細については、「 BLOB を取得します

DownloadContentAsync(BlobDownloadOptions, CancellationToken)

この操作では DownloadContentAsync(BlobDownloadOptions, CancellationToken) 、メタデータとプロパティを含む BLOB がサービスからダウンロードされます。

詳細については、「 BLOB を取得します

DownloadContentAsync(CancellationToken)

この操作では DownloadContentAsync(CancellationToken) 、メタデータとプロパティを含む BLOB がサービスからダウンロードされます。

詳細については、「 BLOB を取得します

DownloadStreaming(BlobDownloadOptions, CancellationToken)

この操作では DownloadStreaming(BlobDownloadOptions, CancellationToken) 、メタデータとプロパティを含む BLOB がサービスからダウンロードされます。

詳細については、「 BLOB を取得します

DownloadStreamingAsync(BlobDownloadOptions, CancellationToken)

この操作では DownloadStreamingAsync(BlobDownloadOptions, CancellationToken) 、メタデータとプロパティを含む BLOB がサービスからダウンロードされます。

詳細については、「 BLOB を取得します

DownloadTo(Stream)

この操作では DownloadTo(Stream) 、並列要求を使用して BLOB をダウンロードし、コンテンツを に destination書き込みます。

DownloadTo(Stream, BlobDownloadToOptions, CancellationToken)

この操作ではAzure.Storage.Blobs.Specialized.BlobBaseClient.DownloadTo(System.String,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken)、並列要求を使用して BLOB をダウンロードし、 または options.Stream.Streamにコンテンツをoptions.Path.Path書き込みます。

DownloadTo(Stream, CancellationToken)

この操作では DownloadTo(Stream, CancellationToken) 、並列要求を使用して BLOB をダウンロードし、コンテンツを に destination書き込みます。

DownloadTo(String)

この操作では DownloadTo(String) 、並列要求を使用して BLOB をダウンロードし、コンテンツを に path書き込みます。

DownloadTo(String, BlobDownloadToOptions, CancellationToken)

この操作ではAzure.Storage.Blobs.Specialized.BlobBaseClient.DownloadTo(System.String,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken)、並列要求を使用して BLOB をダウンロードし、 または options.Stream.Streamにコンテンツをoptions.Path.Path書き込みます。

DownloadTo(String, CancellationToken)

この操作では DownloadTo(String, CancellationToken) 、並列要求を使用して BLOB をダウンロードし、コンテンツを に path書き込みます。

DownloadToAsync(Stream)

では DownloadToAsync(Stream) 、並列要求を使用して BLOB をダウンロードし、コンテンツを に destination書き込みます。

DownloadToAsync(Stream, BlobDownloadToOptions, CancellationToken)

この操作ではAzure.Storage.Blobs.Specialized.BlobBaseClient.DownloadToAsync(System.IO.Stream,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken)、並列要求を使用して BLOB をダウンロードし、 または options.Stream.Streamにコンテンツをoptions.Path.Path書き込みます。

DownloadToAsync(Stream, CancellationToken)

この操作では DownloadToAsync(Stream, CancellationToken) 、並列要求を使用して BLOB をダウンロードし、コンテンツを に destination書き込みます。

DownloadToAsync(String)

では DownloadToAsync(String) 、並列要求を使用して BLOB をダウンロードし、コンテンツを に path書き込みます。

DownloadToAsync(String, BlobDownloadToOptions, CancellationToken)

この操作ではAzure.Storage.Blobs.Specialized.BlobBaseClient.DownloadToAsync(System.IO.Stream,Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.StorageTransferOptions,System.Threading.CancellationToken)、並列要求を使用して BLOB をダウンロードし、 または options.Stream.Streamにコンテンツをoptions.Path.Path書き込みます。

DownloadToAsync(String, CancellationToken)

この操作では DownloadToAsync(String, CancellationToken) 、並列要求を使用して BLOB をダウンロードし、コンテンツを に path書き込みます。

Exists(CancellationToken)

操作を Exists(CancellationToken)BlobBaseClient 呼び出して、関連付けられている BLOB がストレージ サービスのストレージ アカウントのコンテナーに存在するかどうかを確認できます。

ExistsAsync(CancellationToken)

操作は ExistsAsync(CancellationToken) 、 で BlobBaseClient 呼び出して、ストレージ サービスのストレージ アカウントのコンテナーに関連付けられている BLOB が存在するかどうかを確認できます。

GenerateSasUri(BlobSasBuilder)

GenerateSasUri(BlobSasBuilder) 、クライアントの Uri プロパティとビルダーに基づいて Blob Service Shared Access Signature (SAS) URI を生成する を返します。 SAS は、クライアントの共有キー資格情報によって署名されます。

クライアントがサービス Sas に署名できるかどうかをチェックするには、「」を参照してくださいCanGenerateSasUri

詳細については、「 サービス SAS の構築

GenerateSasUri(BlobSasPermissions, DateTimeOffset)

GenerateSasUri(BlobSasPermissions, DateTimeOffset)Uri 渡されたクライアントのプロパティとパラメーターに基づいて Blob Service Shared Access Signature (SAS) URI を生成する を返します。 SAS は、クライアントの共有キー資格情報によって署名されます。

クライアントがサービス Sas に署名できるかどうかをチェックするには、「」を参照してくださいCanGenerateSasUri

詳細については、「 サービス SAS の構築

GetBlobLeaseClientCore(String)

BlobLeaseClient クラスの新しいインスタンスを初期化します。

GetCopyAuthorizationHeaderAsync(BlobBaseClient, CancellationToken)

ソースを BlobBaseClient認証するために OAuth が必要なサービス コピーにサービスを実行するときに承認を渡すための を HttpAuthorization 取得します。

GetParentBlobContainerClientCore()

この BlobBaseClientの親コンテナーを指す新しい BlobContainerClient を作成します。 新しい BlockBlobClient では、 と同じ要求ポリシー パイプラインが使用されます BlobBaseClient

GetProperties(BlobRequestConditions, CancellationToken)

GetProperties(BlobRequestConditions, CancellationToken) 操作は、すべてのユーザー定義メタデータ、標準 HTTP プロパティ、および BLOB のシステム プロパティを返します。 BLOB のコンテンツは返しません。

詳細については、「 BLOB のプロパティを取得します

GetPropertiesAsync(BlobRequestConditions, CancellationToken)

GetPropertiesAsync(BlobRequestConditions, CancellationToken) 操作は、すべてのユーザー定義メタデータ、標準 HTTP プロパティ、および BLOB のシステム プロパティを返します。 BLOB のコンテンツは返しません。

詳細については、「 BLOB のプロパティを取得します

GetTags(BlobRequestConditions, CancellationToken)

基になる BLOB に関連付けられているタグを取得します。

詳細については、「 BLOB タグを取得する

GetTagsAsync(BlobRequestConditions, CancellationToken)

基になる BLOB に関連付けられているタグを取得します。

詳細については、「 BLOB タグを取得する

OpenRead(BlobOpenReadOptions, CancellationToken)

BLOB から読み取るためのストリームを開きます。 ストリームは、読み取り元としてのみ BLOB をダウンロードします。

OpenReadAsync(BlobOpenReadOptions, CancellationToken)

BLOB から読み取るためのストリームを開きます。 ストリームは、読み取り元としてのみ BLOB をダウンロードします。

SetAccessTier(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken)

この操作により SetAccessTier(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) 、BLOB の層が設定されます。 操作は、Premium Storage アカウントのページ BLOB と、BLOB ストレージまたは汎用 v2 アカウント内のブロック BLOB で許可されます。

Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 ブロック BLOB レベルの階層化 Blob Storage 層の詳細については、以下を参照してください。

レベルの設定の詳細については、次を参照してください。 BLOB ストレージ層

SetAccessTierAsync(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken)

この操作により SetAccessTierAsync(AccessTier, BlobRequestConditions, Nullable<RehydratePriority>, CancellationToken) 、BLOB の層が設定されます。 操作は、Premium Storage アカウントのページ BLOB と、BLOB ストレージまたは汎用 v2 アカウント内のブロック BLOB で許可されます。

Premium ページ BLOB の層によって、BLOB の許容サイズ、IOPS、帯域幅が決まります。 ブロック BLOB の層によって、ホット/クール/アーカイブ ストレージの種類が決まります。 この操作では、BLOB の ETag は更新されません。 ブロック BLOB レベルの階層化 Blob Storage 層の詳細については、以下を参照してください。

レベルの設定の詳細については、次を参照してください。 BLOB ストレージ層

SetHttpHeaders(BlobHttpHeaders, BlobRequestConditions, CancellationToken)

SetHttpHeaders(BlobHttpHeaders, BlobRequestConditions, CancellationToken) 操作は BLOB のシステム プロパティを設定します。

詳細については、「 BLOB のプロパティを設定します

SetHttpHeadersAsync(BlobHttpHeaders, BlobRequestConditions, CancellationToken)

SetHttpHeadersAsync(BlobHttpHeaders, BlobRequestConditions, CancellationToken) 操作は BLOB のシステム プロパティを設定します。

詳細については、「 BLOB のプロパティを設定します

SetImmutabilityPolicy(BlobImmutabilityPolicy, BlobRequestConditions, CancellationToken)

BLOB、BLOB スナップショット、または BLOB バージョンに不変ポリシーを設定します。 ストレージ アカウントで BLOB のバージョン管理を有効にする必要があり、BLOB は、この API を呼び出すためにバージョン管理が有効になっている不変ストレージを持つコンテナー内に存在する必要があることに注意してください。

SetImmutabilityPolicyAsync(BlobImmutabilityPolicy, BlobRequestConditions, CancellationToken)

BLOB、BLOB スナップショット、または BLOB バージョンに不変ポリシーを設定します。 ストレージ アカウントで BLOB のバージョン管理を有効にする必要があり、BLOB は、この API を呼び出すためにバージョン管理が有効になっている不変ストレージを持つコンテナー内に存在する必要があることに注意してください。

SetLegalHold(Boolean, CancellationToken)

BLOB の訴訟ホールドを設定します。 ストレージ アカウントで BLOB のバージョン管理を有効にする必要があり、BLOB は、この API を呼び出すためにバージョン管理が有効になっている不変ストレージを持つコンテナー内に存在する必要があることに注意してください。

SetLegalHoldAsync(Boolean, CancellationToken)

BLOB の訴訟ホールドを設定します。 ストレージ アカウントで BLOB のバージョン管理を有効にする必要があり、BLOB は、この API を呼び出すためにバージョン管理が有効になっている不変ストレージを持つコンテナー内に存在する必要があることに注意してください。

SetMetadata(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

SetMetadata(IDictionary<String,String>, BlobRequestConditions, CancellationToken) 操作は、指定された BLOB のユーザー定義メタデータを、1 組以上の名前と値のペアとして設定します。

詳細については、「 BLOB メタデータを設定します

SetMetadataAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

SetMetadataAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken) 操作は、指定された BLOB のユーザー定義メタデータを、1 組以上の名前と値のペアとして設定します。

詳細については、「 BLOB メタデータを設定します

SetTags(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

基になる BLOB にタグを設定します。 BLOB には、最大 10 個のタグを含めることができます。 タグ キーは 1 ~ 128 文字にする必要があります。 タグ値は 0 ~ 256 文字にする必要があります。 有効なタグ キーと値の文字には、小文字と大文字、数字 (0 から 9)、スペース (' ')、プラス ('+')、マイナス ('-')、ピリオド ('.')、スラッシュ ('/')、コロン (':')、等しい ('=')、アンダースコア ('_') が含まれます。

詳細については、「 BLOB タグを設定します

SetTagsAsync(IDictionary<String,String>, BlobRequestConditions, CancellationToken)

基になる BLOB にタグを設定します。 BLOB には、最大 10 個のタグを含めることができます。 タグ キーは 1 ~ 128 文字にする必要があります。 タグ値は 0 ~ 256 文字にする必要があります。 有効なタグ キーと値の文字には、小文字と大文字、数字 (0 から 9)、スペース (' ')、プラス ('+')、マイナス ('-')、ピリオド ('.')、スラッシュ ('/')、コロン (':')、等しい ('=')、アンダースコア ('_') が含まれます。

詳細については、「 BLOB タグを設定します

StartCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken)

操作は StartCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken) 、 から source この BLOB へのデータの非同期コピーを開始します。 からGetProperties(BlobRequestConditions, CancellationToken)返された をAzure.Storage.Blobs.Models.BlobProperties.CopyStatusチェックして、コピーが完了したかどうかを判断できます。

詳細については、「 BLOB をコピーします

StartCopyFromUriAsync(Uri, BlobCopyFromUriOptions, CancellationToken)

操作は Azure.Storage.Blobs.Specialized.BlobBaseClient.StartCopyFromUri(System.Uri,System.Collections.Generic.IDictionary{System.String,System.String},System.Nullable{Azure.Storage.Blobs.Models.AccessTier},Azure.Storage.Blobs.Models.BlobRequestConditions,Azure.Storage.Blobs.Models.BlobRequestConditions,System.Nullable{Azure.Storage.Blobs.Models.RehydratePriority},System.Threading.CancellationToken) 、 から source この BLOB へのデータの非同期コピーを開始します。 からGetPropertiesAsync(BlobRequestConditions, CancellationToken)返された をAzure.Storage.Blobs.Models.BlobProperties.CopyStatusチェックして、コピーが完了したかどうかを判断できます。

詳細については、「 BLOB をコピーします

SyncCopyFromUri(Uri, BlobCopyFromUriOptions, CancellationToken)

[URL からの BLOB のコピー] 操作では、最大 256 MiB のソース BLOB サイズに対して、BLOB をストレージ アカウント内の宛先に同期的にコピーします。 この API は、バージョン 2018-03-28 以降で使用できます。 URL からの BLOB のコピー操作のソースには、パブリックまたは共有アクセス署名で承認されている任意の Azure ストレージ アカウント内のコミットされたブロック BLOB を指定できます。

ソース BLOB のサイズは、最大 256 MiB の長さにできます。

詳細については、「 URL から BLOB をコピーします

SyncCopyFromUriAsync(Uri, BlobCopyFromUriOptions, CancellationToken)

[URL からの BLOB のコピー] 操作では、最大 256 MiB のソース BLOB サイズに対して、BLOB をストレージ アカウント内の宛先に同期的にコピーします。 この API は、バージョン 2018-03-28 以降で使用できます。 BLOB のコピー元 URL 操作のソースには、パブリックまたは共有アクセス署名で承認されている任意の Azure ストレージ アカウント内のコミット済みブロック BLOB を指定できます。

ソース BLOB のサイズは、最大 256 MiB の長さにできます。

詳細については、「 URL から BLOB をコピーします

Undelete(CancellationToken)

この操作により Undelete(CancellationToken) 、論理的に削除された BLOB と、関連付けられている論理的に削除されたスナップショットの内容とメタデータが復元されます。

詳細については、「 BLOB の削除を取り消します

UndeleteAsync(CancellationToken)

この操作により UndeleteAsync(CancellationToken) 、論理的に削除された BLOB と、関連付けられている論理的に削除されたスナップショットの内容とメタデータが復元されます。

詳細については、「 BLOB の削除を取り消します

WithCustomerProvidedKey(Nullable<CustomerProvidedKey>)

同じUriソースを指定して、 BlobBaseClient クラスの新しいインスタンスを初期化しますcustomerProvidedKey

WithEncryptionScope(String)

同じUriソースを指定して、 BlobBaseClient クラスの新しいインスタンスを初期化しますencryptionScope

WithSnapshot(String)

同じUriソースと指定されたsnapshotタイムスタンプをBlobBaseClient使用して、 クラスの新しいインスタンスを初期化します。

詳細については、「 BLOB のスナップショットを作成します

WithSnapshotCore(String)

指定したsnapshotタイムスタンプをBlobBaseClient持つ同じUriソースを持つ クラスの新しいインスタンスを作成します。

WithVersion(String)

同じUriソースと指定されたversionIdタイムスタンプをBlobBaseClient使用して、 クラスの新しいインスタンスを初期化します。

拡張メソッド

GetBlobLeaseClient(BlobBaseClient, String)

BlobLeaseClient クラスの新しいインスタンスを初期化します。

GetParentBlobContainerClient(BlobBaseClient)

このBlobBaseClientの親コンテナーを指す新しい BlobContainerClient を作成します。 新しい BlockBlobClient では、 と同じ要求ポリシー パイプラインが使用されます BlobBaseClient

適用対象