Share class

Пакет:: @azure/storage-file

Класс, представляющий общую папку.

Конструкторы

Создайте общую папку.

Методы

create(Models.ShareCreateOptionalParams)	Создает новую общую папку под указанной учетной записью. Если общий ресурс с тем же именем уже существует, операция завершается ошибкой.
create(ServiceCallback<void>)
create(ShareCreateOptionalParams, ServiceCallback<void>)
createPermission(Permission, Models.ShareCreatePermissionOptionalParams)	Создайте разрешение (дескриптор безопасности).
createPermission(Permission, ServiceCallback<void>)
createPermission(Permission, ShareCreatePermissionOptionalParams, ServiceCallback<void>)
createSnapshot(Models.ShareCreateSnapshotOptionalParams)	Создает моментальный снимок общего ресурса только для чтения.
createSnapshot(ServiceCallback<void>)
createSnapshot(ShareCreateSnapshotOptionalParams, ServiceCallback<void>)
deleteMethod(Models.ShareDeleteMethodOptionalParams)	Операция помечает указанный общий ресурс или моментальный снимок общего ресурса для удаления. Моментальный снимок общего ресурса или общий доступ, а также все файлы, содержащиеся в нем, позже удаляются во время сборки мусора.
deleteMethod(ServiceCallback<void>)
deleteMethod(ShareDeleteMethodOptionalParams, ServiceCallback<void>)
getAccessPolicy(Models.ShareGetAccessPolicyOptionalParams)	Возвращает сведения о хранимых политиках доступа, указанных в общей папке.
getAccessPolicy(ServiceCallback<SignedIdentifier[]>)
getAccessPolicy(ShareGetAccessPolicyOptionalParams, ServiceCallback<SignedIdentifier[]>)
getPermission(string, Models.ShareGetPermissionOptionalParams)	Возвращает разрешение (дескриптор безопасности) для заданного ключа.
getPermission(string, ServiceCallback<Permission>)
getPermission(string, ShareGetPermissionOptionalParams, ServiceCallback<Permission>)
getProperties(Models.ShareGetPropertiesOptionalParams)	Возвращает все пользовательские метаданные и системные свойства для указанного моментального снимка общего ресурса или общего ресурса. Возвращенные данные не включают список файлов общей папки.
getProperties(ServiceCallback<void>)
getProperties(ShareGetPropertiesOptionalParams, ServiceCallback<void>)
getStatistics(Models.ShareGetStatisticsOptionalParams)	Извлекает статистику, связанную с общим ресурсом.
getStatistics(ServiceCallback<ShareStats>)
getStatistics(ShareGetStatisticsOptionalParams, ServiceCallback<ShareStats>)
setAccessPolicy(Models.ShareSetAccessPolicyOptionalParams)	Задает хранимую политику доступа для использования с подписанными URL-адресами.
setAccessPolicy(ServiceCallback<void>)
setAccessPolicy(ShareSetAccessPolicyOptionalParams, ServiceCallback<void>)
setMetadata(Models.ShareSetMetadataOptionalParams)	Задает одну или несколько определяемых пользователем пар name-value для указанной общей папки.
setMetadata(ServiceCallback<void>)
setMetadata(ShareSetMetadataOptionalParams, ServiceCallback<void>)
setQuota(Models.ShareSetQuotaOptionalParams)	Задает квоту для указанной общей папки.
setQuota(ServiceCallback<void>)
setQuota(ShareSetQuotaOptionalParams, ServiceCallback<void>)

Сведения о конструкторе

Создайте общую папку.

new Share(client: StorageClientContext)

Параметры

client: StorageClientContext

Ссылка на клиент службы.

Сведения о методе

Создает новую общую папку под указанной учетной записью. Если общий ресурс с тем же именем уже существует, операция завершается ошибкой.

function create(options?: Models.ShareCreateOptionalParams)

Параметры

options: Models.ShareCreateOptionalParams

Возвращаемое значение

Promise<Models.ShareCreateResponse>

Обещание<Models.ShareCreateResponse>

function create(callback: ServiceCallback<void>)

Параметры

callback: ServiceCallback<void>

Обратный вызов

function create(options: ShareCreateOptionalParams, callback: ServiceCallback<void>)

Параметры

options: ShareCreateOptionalParams

Необязательные параметры

callback: ServiceCallback<void>

Обратный вызов

Создайте разрешение (дескриптор безопасности).

function createPermission(permission: Permission, options?: Models.ShareCreatePermissionOptionalParams)

Параметры

permission: Permission

Разрешения (дескриптор безопасности), описанные в SDDL.

options: Models.ShareCreatePermissionOptionalParams

Возвращаемое значение

Promise<Models.ShareCreatePermissionResponse>

Обещание<Models.ShareCreatePermissionResponse>

function createPermission(permission: Permission, callback: ServiceCallback<void>)

Параметры

permission: Permission

Разрешения (дескриптор безопасности), описанные в SDDL.

callback: ServiceCallback<void>

Обратный вызов

function createPermission(permission: Permission, options: ShareCreatePermissionOptionalParams, callback: ServiceCallback<void>)

Параметры

permission: Permission

Разрешения (дескриптор безопасности), описанные в SDDL.

options: ShareCreatePermissionOptionalParams

Необязательные параметры

callback: ServiceCallback<void>

Обратный вызов

Создает моментальный снимок общего ресурса только для чтения.

function createSnapshot(options?: Models.ShareCreateSnapshotOptionalParams)

Параметры

options: Models.ShareCreateSnapshotOptionalParams

Возвращаемое значение

Promise<Models.ShareCreateSnapshotResponse>

Обещание<Models.ShareCreateSnapshotResponse>

function createSnapshot(callback: ServiceCallback<void>)

Параметры

callback: ServiceCallback<void>

Обратный вызов

function createSnapshot(options: ShareCreateSnapshotOptionalParams, callback: ServiceCallback<void>)

Параметры

options: ShareCreateSnapshotOptionalParams

Необязательные параметры

callback: ServiceCallback<void>

Обратный вызов

Операция помечает указанный общий ресурс или моментальный снимок общего ресурса для удаления. Моментальный снимок общего ресурса или общий доступ, а также все файлы, содержащиеся в нем, позже удаляются во время сборки мусора.

function deleteMethod(options?: Models.ShareDeleteMethodOptionalParams)

Параметры

options: Models.ShareDeleteMethodOptionalParams

Возвращаемое значение

Promise<Models.ShareDeleteResponse>

Обещание<Models.ShareDeleteResponse>

function deleteMethod(callback: ServiceCallback<void>)

Параметры

callback: ServiceCallback<void>

Обратный вызов

function deleteMethod(options: ShareDeleteMethodOptionalParams, callback: ServiceCallback<void>)

Параметры

options: ShareDeleteMethodOptionalParams

Необязательные параметры

callback: ServiceCallback<void>

Обратный вызов

Возвращает сведения о хранимых политиках доступа, указанных в общей папке.

function getAccessPolicy(options?: Models.ShareGetAccessPolicyOptionalParams)

Параметры

options: Models.ShareGetAccessPolicyOptionalParams

Возвращаемое значение

Promise<Models.ShareGetAccessPolicyResponse>

Обещание<Models.ShareGetAccessPolicyResponse>

function getAccessPolicy(callback: ServiceCallback<SignedIdentifier[]>)

Параметры

callback: ServiceCallback<SignedIdentifier[]>

Обратный вызов

function getAccessPolicy(options: ShareGetAccessPolicyOptionalParams, callback: ServiceCallback<SignedIdentifier[]>)

Параметры

options: ShareGetAccessPolicyOptionalParams

Необязательные параметры

callback: ServiceCallback<SignedIdentifier[]>

Обратный вызов

Возвращает разрешение (дескриптор безопасности) для заданного ключа.

function getPermission(filePermissionKey: string, options?: Models.ShareGetPermissionOptionalParams)

Параметры

filePermissionKey: string

Ключ разрешения, заданного для каталога или файла. Примечание. Необходимо указать только один из разрешений x-ms-file-permission или x-ms-file-permission-key.

options: Models.ShareGetPermissionOptionalParams

Возвращаемое значение

Promise<Models.ShareGetPermissionResponse>

Обещание<Models.ShareGetPermissionResponse>

function getPermission(filePermissionKey: string, callback: ServiceCallback<Permission>)

Параметры

filePermissionKey: string

callback: ServiceCallback<Permission>

Обратный вызов

function getPermission(filePermissionKey: string, options: ShareGetPermissionOptionalParams, callback: ServiceCallback<Permission>)

Параметры

filePermissionKey: string

options: ShareGetPermissionOptionalParams

Необязательные параметры

callback: ServiceCallback<Permission>

Обратный вызов

Возвращает все пользовательские метаданные и системные свойства для указанного моментального снимка общего ресурса или общего ресурса. Возвращенные данные не включают список файлов общей папки.

function getProperties(options?: Models.ShareGetPropertiesOptionalParams)

Параметры

options: Models.ShareGetPropertiesOptionalParams

Возвращаемое значение

Promise<Models.ShareGetPropertiesResponse>

Обещание<Models.ShareGetPropertiesResponse>

function getProperties(callback: ServiceCallback<void>)

Параметры

callback: ServiceCallback<void>

Обратный вызов

function getProperties(options: ShareGetPropertiesOptionalParams, callback: ServiceCallback<void>)

Параметры

options: ShareGetPropertiesOptionalParams

Необязательные параметры

callback: ServiceCallback<void>

Обратный вызов

Извлекает статистику, связанную с общим ресурсом.

function getStatistics(options?: Models.ShareGetStatisticsOptionalParams)

Параметры

options: Models.ShareGetStatisticsOptionalParams

Возвращаемое значение

Promise<Models.ShareGetStatisticsResponse>

Обещание<Models.ShareGetStatisticsResponse>

function getStatistics(callback: ServiceCallback<ShareStats>)

Параметры

callback: ServiceCallback<ShareStats>

Обратный вызов

function getStatistics(options: ShareGetStatisticsOptionalParams, callback: ServiceCallback<ShareStats>)

Параметры

options: ShareGetStatisticsOptionalParams

Необязательные параметры

callback: ServiceCallback<ShareStats>

Обратный вызов

Задает хранимую политику доступа для использования с подписанными URL-адресами.

function setAccessPolicy(options?: Models.ShareSetAccessPolicyOptionalParams)

Параметры

options: Models.ShareSetAccessPolicyOptionalParams

Возвращаемое значение

Promise<Models.ShareSetAccessPolicyResponse>

Обещание<Models.ShareSetAccessPolicyResponse>

function setAccessPolicy(callback: ServiceCallback<void>)

Параметры

callback: ServiceCallback<void>

Обратный вызов

function setAccessPolicy(options: ShareSetAccessPolicyOptionalParams, callback: ServiceCallback<void>)

Параметры

options: ShareSetAccessPolicyOptionalParams

Необязательные параметры

callback: ServiceCallback<void>

Обратный вызов

Задает одну или несколько определяемых пользователем пар name-value для указанной общей папки.

function setMetadata(options?: Models.ShareSetMetadataOptionalParams)

Параметры

options: Models.ShareSetMetadataOptionalParams

Возвращаемое значение

Promise<Models.ShareSetMetadataResponse>

Обещание<Models.ShareSetMetadataResponse>

function setMetadata(callback: ServiceCallback<void>)

Параметры

callback: ServiceCallback<void>

Обратный вызов

function setMetadata(options: ShareSetMetadataOptionalParams, callback: ServiceCallback<void>)

Параметры

options: ShareSetMetadataOptionalParams

Необязательные параметры

callback: ServiceCallback<void>

Обратный вызов

Задает квоту для указанной общей папки.

function setQuota(options?: Models.ShareSetQuotaOptionalParams)

Параметры

options: Models.ShareSetQuotaOptionalParams

Возвращаемое значение

Promise<Models.ShareSetQuotaResponse>

Обещание<Models.ShareSetQuotaResponse>

function setQuota(callback: ServiceCallback<void>)

Параметры

callback: ServiceCallback<void>

Обратный вызов

function setQuota(options: ShareSetQuotaOptionalParams, callback: ServiceCallback<void>)

Параметры

options: ShareSetQuotaOptionalParams

Необязательные параметры

callback: ServiceCallback<void>

Обратный вызов

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

Share class

Конструкторы

Методы

Сведения о конструкторе

Share(StorageClientContext)

Параметры

Сведения о методе

create(Models.ShareCreateOptionalParams)

Параметры

Возвращаемое значение

create(ServiceCallback<void>)

Параметры

create(ShareCreateOptionalParams, ServiceCallback<void>)

Параметры

createPermission(Permission, Models.ShareCreatePermissionOptionalParams)

Параметры

Возвращаемое значение

createPermission(Permission, ServiceCallback<void>)

Параметры

createPermission(Permission, ShareCreatePermissionOptionalParams, ServiceCallback<void>)

Параметры

createSnapshot(Models.ShareCreateSnapshotOptionalParams)

Параметры

Возвращаемое значение

createSnapshot(ServiceCallback<void>)

Параметры

createSnapshot(ShareCreateSnapshotOptionalParams, ServiceCallback<void>)

Параметры

deleteMethod(Models.ShareDeleteMethodOptionalParams)

Параметры

Возвращаемое значение

deleteMethod(ServiceCallback<void>)

Параметры

deleteMethod(ShareDeleteMethodOptionalParams, ServiceCallback<void>)

Параметры

getAccessPolicy(Models.ShareGetAccessPolicyOptionalParams)

Параметры

Возвращаемое значение

getAccessPolicy(ServiceCallback<SignedIdentifier[]>)

Параметры

getAccessPolicy(ShareGetAccessPolicyOptionalParams, ServiceCallback<SignedIdentifier[]>)

Параметры

getPermission(string, Models.ShareGetPermissionOptionalParams)

Параметры

Возвращаемое значение

getPermission(string, ServiceCallback<Permission>)

Параметры

getPermission(string, ShareGetPermissionOptionalParams, ServiceCallback<Permission>)

Параметры

getProperties(Models.ShareGetPropertiesOptionalParams)

Параметры

Возвращаемое значение

getProperties(ServiceCallback<void>)

Параметры

getProperties(ShareGetPropertiesOptionalParams, ServiceCallback<void>)

Параметры

getStatistics(Models.ShareGetStatisticsOptionalParams)

Параметры

Возвращаемое значение

getStatistics(ServiceCallback<ShareStats>)

Параметры

getStatistics(ShareGetStatisticsOptionalParams, ServiceCallback<ShareStats>)

Параметры

setAccessPolicy(Models.ShareSetAccessPolicyOptionalParams)

Параметры

Возвращаемое значение

setAccessPolicy(ServiceCallback<void>)

Параметры

setAccessPolicy(ShareSetAccessPolicyOptionalParams, ServiceCallback<void>)

Параметры

setMetadata(Models.ShareSetMetadataOptionalParams)

Параметры

Возвращаемое значение

setMetadata(ServiceCallback<void>)

Параметры

setMetadata(ShareSetMetadataOptionalParams, ServiceCallback<void>)

Параметры

setQuota(Models.ShareSetQuotaOptionalParams)

Параметры