DataLakeDirectoryClient class
DataLakeDirectoryClient は、Azure Storage ディレクトリへの URL を表します。
- Extends
コンストラクター
| Data |
URL とパイプラインから DataLakePathClient のインスタンスを作成します。 |
| Data |
URL と資格情報から DataLakePathClient のインスタンスを作成します。 |
プロパティ
| file |
現在のファイル システムの名前。 |
| name | 現在のパス (ディレクトリまたはファイル) の名前。 |
継承されたプロパティ
| account |
|
| credential | AnonymousCredential、StorageSharedKeyCredential、サービスへの要求を認証するための |
| url | エンコードされた URL 文字列値。 |
メソッド
継承されたメソッド
コンストラクターの詳細
DataLakeDirectoryClient(string, Pipeline)
URL とパイプラインから DataLakePathClient のインスタンスを作成します。
new DataLakeDirectoryClient(url: string, pipeline: Pipeline)パラメーター
- url
-
string
"https://myaccount.dfs.core.windows.net/filesystem/directory" など、Azure Storage データ レイク パス (ディレクトリまたはファイル) を指すクライアント文字列。または "https://myaccount.dfs.core.windows.net/filesystem/file"。 "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString" など、AnonymousCredential を使用している場合は SAS を追加できます。
- pipeline
- Pipeline
newPipeline() を呼び出して既定のパイプラインを作成するか、カスタマイズされたパイプラインを提供します。
DataLakeDirectoryClient(string, StorageSharedKeyCredential | AnonymousCredential | TokenCredential, StoragePipelineOptions)
URL と資格情報から DataLakePathClient のインスタンスを作成します。
new DataLakeDirectoryClient(url: string, credential?: StorageSharedKeyCredential | AnonymousCredential | TokenCredential, options?: StoragePipelineOptions)パラメーター
- url
-
string
"https://myaccount.dfs.core.windows.net/filesystem/directory" など、Azure Storage データ レイク パス (ディレクトリまたはファイル) を指すクライアント文字列。または "https://myaccount.dfs.core.windows.net/filesystem/file"。 "https://myaccount.dfs.core.windows.net/filesystem/directory?sasString" など、AnonymousCredential を使用している場合は SAS を追加できます。
- credential
-
StorageSharedKeyCredential | AnonymousCredential | TokenCredential
AnonymousCredential、StorageSharedKeyCredential、サービスへの要求を認証するための @azure/identity パッケージの資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。
- options
- StoragePipelineOptions
随意。 HTTP パイプラインを構成するためのオプション。
プロパティの詳細
fileSystemName
現在のファイル システムの名前。
string fileSystemNameプロパティ値
string
name
現在のパス (ディレクトリまたはファイル) の名前。
string nameプロパティ値
string
継承されたプロパティの詳細
accountName
accountName: stringプロパティ値
string
credential
AnonymousCredential、StorageSharedKeyCredential、サービスへの要求を認証するための @azure/identity パッケージの資格情報など。 TokenCredential インターフェイスを実装するオブジェクトを指定することもできます。 指定しない場合は、AnonymousCredential が使用されます。
credential: StorageSharedKeyCredential | AnonymousCredential | TokenCredentialプロパティ値
url
エンコードされた URL 文字列値。
url: stringプロパティ値
string
メソッドの詳細
create(DirectoryCreateOptions)
ディレクトリを作成します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create を参照してください
function create(options?: DirectoryCreateOptions): Promise<DirectoryCreateResponse>パラメーター
- options
- DirectoryCreateOptions
随意。 ディレクトリを作成するときのオプション。
戻り値
Promise<DirectoryCreateResponse>
create(PathResourceTypeModel, PathCreateOptions)
ディレクトリを作成します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create を参照してください
function create(resourceType: PathResourceTypeModel, options?: PathCreateOptions): Promise<PathCreateResponse>パラメーター
- resourceType
- PathResourceTypeModel
リソースの種類。DataLakeDirectoryClient の場合は "directory" である必要があります。
- options
- PathCreateOptions
随意。 ディレクトリを作成するときのオプション。
戻り値
Promise<PathCreateResponse>
createIfNotExists(DirectoryCreateIfNotExistsOptions)
ディレクトリがまだ存在しない場合は作成します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create を参照してください
function createIfNotExists(options?: DirectoryCreateIfNotExistsOptions): Promise<DirectoryCreateIfNotExistsResponse>パラメーター
戻り値
Promise<DirectoryCreateIfNotExistsResponse>
createIfNotExists(PathResourceTypeModel, PathCreateIfNotExistsOptions)
ディレクトリがまだ存在しない場合は作成します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create を参照してください
function createIfNotExists(resourceType: PathResourceTypeModel, options?: PathCreateIfNotExistsOptions): Promise<PathCreateIfNotExistsResponse>パラメーター
- resourceType
- PathResourceTypeModel
リソースの種類。DataLakeDirectoryClient の場合は "directory" である必要があります。
- options
- PathCreateIfNotExistsOptions
戻り値
Promise<PathCreateIfNotExistsResponse>
generateSasStringToSign(DirectoryGenerateSasUrlOptions)
渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI に署名する文字列を生成します。
https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
function generateSasStringToSign(options: DirectoryGenerateSasUrlOptions): stringパラメーター
- options
- DirectoryGenerateSasUrlOptions
省略可能なパラメーター。
戻り値
string
このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。
generateSasUrl(DirectoryGenerateSasUrlOptions)
共有キー資格情報を使用して構築されたクライアントでのみ使用できます。
渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI を生成します。 SAS は、クライアントの共有キー資格情報によって署名されます。
https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
function generateSasUrl(options: DirectoryGenerateSasUrlOptions): Promise<string>パラメーター
- options
- DirectoryGenerateSasUrlOptions
省略可能なパラメーター。
戻り値
Promise<string>
このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。
generateUserDelegationSasStringToSign(DirectoryGenerateSasUrlOptions, UserDelegationKey)
SAS で渡されるクライアント プロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI に署名する文字列を生成します。このパラメーターは、入力ユーザー委任キーによって署名されます。
https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
function generateUserDelegationSasStringToSign(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): stringパラメーター
- options
- DirectoryGenerateSasUrlOptions
省略可能なパラメーター。
- userDelegationKey
- UserDelegationKey
blobServiceClient.getUserDelegationKey() の戻り値
戻り値
string
このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。
generateUserDelegationSasUrl(DirectoryGenerateSasUrlOptions, UserDelegationKey)
渡されたクライアントのプロパティとパラメーターに基づいて、サービス Shared Access Signature (SAS) URI を生成します。 SAS は、入力ユーザー委任キーによって署名されます。
https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas を参照してください
function generateUserDelegationSasUrl(options: DirectoryGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): Promise<string>パラメーター
- options
- DirectoryGenerateSasUrlOptions
省略可能なパラメーター。
- userDelegationKey
- UserDelegationKey
blobServiceClient.getUserDelegationKey() の戻り値
戻り値
Promise<string>
このクライアントによって表されるリソースへの URI と、生成された SAS トークンで構成される SAS URI。
getFileClient(string)
現在のディレクトリの下に DataLakeFileClient オブジェクトを作成します。
function getFileClient(fileName: string): DataLakeFileClientパラメーター
- fileName
-
string
戻り値
getSubdirectoryClient(string)
現在のディレクトリの下に DataLakeDirectoryClient オブジェクトを作成します。
function getSubdirectoryClient(subdirectoryName: string): DataLakeDirectoryClientパラメーター
- subdirectoryName
-
string
サブディレクトリ名。
戻り値
継承済みメソッドの詳細
delete(boolean, PathDeleteOptions)
現在のパス (ディレクトリまたはファイル) を削除します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete を参照してください
function delete(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteResponse>パラメーター
- recursive
-
boolean
必須で、リソースがディレクトリの場合にのみ有効です。 "true" の場合、ディレクトリの下にあるすべてのパスが削除されます。
- options
- PathDeleteOptions
随意。 パスを削除するときのオプション。
戻り値
Promise<PathDeleteResponse>
dataLakePathClient.delete
deleteIfExists(boolean, PathDeleteOptions)
現在のパス (ディレクトリまたはファイル) が存在する場合は削除します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/delete を参照してください
function deleteIfExists(recursive?: boolean, options?: PathDeleteOptions): Promise<PathDeleteIfExistsResponse>パラメーター
- recursive
-
boolean
必須で、リソースがディレクトリの場合にのみ有効です。 "true" の場合、ディレクトリの下にあるすべてのパスが削除されます。
- options
- PathDeleteOptions
戻り値
Promise<PathDeleteIfExistsResponse>
exists(PathExistsOptions)
このクライアントによって表される Data Lake ファイルが存在する場合は true を返します。それ以外の場合は false。
注: 既存のファイルは他のクライアントまたはアプリケーションによって削除される可能性があるため、この関数は注意して使用してください。 その逆も同様に、この関数の完了後に、他のクライアントまたはアプリケーションによって新しいファイルが追加される可能性があります。
function exists(options?: PathExistsOptions): Promise<boolean>パラメーター
- options
- PathExistsOptions
オプションを [Exists]\(存在\) 操作に設定します。
戻り値
Promise<boolean>
DataLakePathClient.existsから継承
getAccessControl(PathGetAccessControlOptions)
パス (ファイルのディレクトリ) のアクセス制御データを返します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/getproperties を参照してください
function getAccessControl(options?: PathGetAccessControlOptions): Promise<PathGetAccessControlResponse>パラメーター
- options
- PathGetAccessControlOptions
随意。 ファイル アクセス制御を取得するときのオプション。
戻り値
Promise<PathGetAccessControlResponse>
getDataLakeLeaseClient(string)
パス (ディレクトリまたはファイル) のリースを管理する DataLakeLeaseClient を取得します。
function getDataLakeLeaseClient(proposeLeaseId?: string): DataLakeLeaseClientパラメーター
- proposeLeaseId
-
string
随意。 最初に提案されたリース ID。
戻り値
getProperties(PathGetPropertiesOptions)
パス (ディレクトリまたはファイル) のすべてのユーザー定義メタデータ、標準 HTTP プロパティ、およびシステム プロパティを返します。
警告: 応答で返される metadata オブジェクトのキーは、最初に大文字が含まれていた場合でも小文字になります。 これは、includeMetadata オプションを使用してパスを一覧表示する DataLakeFileSystemClient のメソッドによって返されるメタデータ キーとは異なり、元の大文字と小文字が保持されます。
https://docs.microsoft.com/en-us/rest/api/storageservices/get-blob-properties を参照してください
function getProperties(options?: PathGetPropertiesOptions): Promise<PathGetPropertiesResponse>パラメーター
- options
- PathGetPropertiesOptions
随意。 パス プロパティを取得するときのオプション。
戻り値
Promise<PathGetPropertiesResponse>
dataLakePathClient.getProperties から継承された
move(string, PathMoveOptions)
同じファイル システム内でディレクトリまたはファイルを移動します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create を参照してください
function move(destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>パラメーター
- destinationPath
-
string
"directory" やファイル パス "directory/file" などの宛先ディレクトリ パス。 destinationPath が SAS で認証されている場合は、"directory/file?sasToken" のような宛先パスに SAS を追加します。
- options
- PathMoveOptions
随意。 ディレクトリまたはファイルを移動するときのオプション。
戻り値
Promise<PathMoveResponse>
move(string, string, PathMoveOptions)
ディレクトリまたはファイルを別のファイル システムに移動します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/create を参照してください
function move(destinationFileSystem: string, destinationPath: string, options?: PathMoveOptions): Promise<PathMoveResponse>パラメーター
- destinationFileSystem
-
string
"filesystem" のような宛先ファイル システム。
- destinationPath
-
string
"directory" やファイル パス "directory/file" などの宛先ディレクトリ パス。destinationPath が SAS で認証されている場合は、"directory/file?sasToken" のような宛先パスに SAS を追加します。
- options
- PathMoveOptions
随意。 ディレクトリまたはファイルを移動するときのオプション。
戻り値
Promise<PathMoveResponse>
removeAccessControlRecursive(RemovePathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
パスとサブ パスのアクセス制御を削除します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update を参照してください
function removeAccessControlRecursive(acl: RemovePathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>パラメーター
ファイルまたはディレクトリの POSIX アクセス制御リスト。
随意。 オプション
戻り値
setAccessControl(PathAccessControlItem[], PathSetAccessControlOptions)
パス (ファイルのディレクトリ) のアクセス制御データを設定します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update を参照してください
function setAccessControl(acl: PathAccessControlItem[], options?: PathSetAccessControlOptions): Promise<PathSetAccessControlResponse>パラメーター
- acl
ファイルまたはディレクトリの POSIX アクセス制御リスト。
- options
- PathSetAccessControlOptions
随意。 パス アクセス制御を設定するときのオプション。
戻り値
Promise<PathSetAccessControlResponse>
setAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
パスとサブ パスのアクセス制御を設定します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update を参照してください
function setAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>パラメーター
- acl
ファイルまたはディレクトリの POSIX アクセス制御リスト。
随意。 オプション
戻り値
setHttpHeaders(PathHttpHeaders, PathSetHttpHeadersOptions)
パス (ディレクトリまたはファイル) にシステム プロパティを設定します。
値が指定されていない場合、または指定された BLOB HTTP ヘッダーに値が指定されていない場合、値のないこれらの BLOB HTTP ヘッダーはクリアされます。
https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-properties を参照してください
function setHttpHeaders(httpHeaders: PathHttpHeaders, options?: PathSetHttpHeadersOptions): Promise<PathSetHttpHeadersResponse>パラメーター
- httpHeaders
- PathHttpHeaders
- options
- PathSetHttpHeadersOptions
戻り値
Promise<PathSetHttpHeadersResponse>
dataLakePathClient.setHttpHeaders
setMetadata(Metadata, PathSetMetadataOptions)
指定したパス (ファイルのディレクトリ) のユーザー定義メタデータを 1 つ以上の名前と値のペアとして設定します。
オプションが指定されていない場合、またはパラメーターにメタデータが定義されていない場合は、パス メタデータが削除されます。
https://docs.microsoft.com/en-us/rest/api/storageservices/set-blob-metadata を参照してください
function setMetadata(metadata?: Metadata, options?: PathSetMetadataOptions): Promise<PathSetMetadataResponse>パラメーター
- metadata
- Metadata
随意。 既存のメタデータをこの値に置き換えます。 値が指定されていない場合、既存のメタデータは削除されます。
- options
- PathSetMetadataOptions
随意。 パス メタデータを設定するときのオプション。
戻り値
Promise<PathSetMetadataResponse>
setPermissions(PathPermissions, PathSetPermissionsOptions)
パスに対するファイルのアクセス許可を設定します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update を参照してください
function setPermissions(permissions: PathPermissions, options?: PathSetPermissionsOptions): Promise<PathSetPermissionsResponse>パラメーター
- permissions
- PathPermissions
ファイル所有者、ファイル所有グループなどの POSIX アクセス許可。
- options
- PathSetPermissionsOptions
随意。 パスのアクセス許可を設定するときのオプション。
戻り値
Promise<PathSetPermissionsResponse>
toDirectoryClient()
現在のパスがディレクトリの場合は、現在の DataLakePathClient を DataLakeDirectoryClient に変換します。
function toDirectoryClient(): DataLakeDirectoryClient戻り値
toFileClient()
現在のパスがファイルの場合は、現在の DataLakePathClient を DataLakeFileClient に変換します。
function toFileClient(): DataLakeFileClient戻り値
updateAccessControlRecursive(PathAccessControlItem[], PathChangeAccessControlRecursiveOptions)
パスとサブ パスのアクセス制御を変更します。
https://docs.microsoft.com/en-us/rest/api/storageservices/datalakestoragegen2/path/update を参照してください
function updateAccessControlRecursive(acl: PathAccessControlItem[], options?: PathChangeAccessControlRecursiveOptions): Promise<PathChangeAccessControlRecursiveResponse>パラメーター
- acl
ファイルまたはディレクトリの POSIX アクセス制御リスト。
随意。 オプション