ShareURL class

Paquete:: @azure/storage-file

Un shareURL representa una dirección URL al recurso compartido de Azure Storage que le permite manipular sus directorios y archivos.

Extends: StorageURL

Constructores

ShareURL(string, Pipeline)

Crea una instancia de ShareURL.

Propiedades

pipeline	Canalización de directiva de solicitud.
url	Valor de cadena de dirección URL.

Métodos

create(Aborter, IShareCreateOptions)	Crea un nuevo recurso compartido en la cuenta especificada. Si el recurso compartido con el mismo nombre ya existe, se produce un error en la operación.
createPermission(Aborter, string)	Crea un permiso de archivo (un descriptor de seguridad) en el nivel de recurso compartido. El descriptor de seguridad creado se puede usar para los archivos o directorios del recurso compartido.
createSnapshot(Aborter, IShareCreateSnapshotOptions)	Crea una instantánea de solo lectura de un recurso compartido.
delete(Aborter, IShareDeleteMethodOptions)	Marca el recurso compartido especificado para su eliminación. El recurso compartido y los directorios o archivos contenidos en él se eliminan posteriormente durante la recolección de elementos no utilizados.
fromServiceURL(ServiceURL, string)	Crea un objeto ShareURL a partir de ServiceURL
getAccessPolicy(Aborter)	Obtiene los permisos para el recurso compartido especificado. Los permisos indican si se puede acceder a los datos compartidos públicamente. ADVERTENCIA: La fecha de JavaScript podría perder precisión al analizar la cadena de inicio y expiración. Por ejemplo, new Date("2018-12-31T03:44:23.8827891Z").toISOString() obtendrá "2018-12-31T03:44:23.882Z".
getPermission(Aborter, string)	Obtiene el lenguaje de definición de descriptores de seguridad (SDDL) de una clave de permiso de archivo determinada que indica un descriptor de seguridad.
getProperties(Aborter)	Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el recurso compartido especificado.
getStatistics(Aborter)	Recupera estadísticas relacionadas con el recurso compartido.
newPipeline(Credential, INewPipelineOptions)	Método estático que se usa para crear un nuevo objeto Pipeline con credential proporcionado.
setAccessPolicy(Aborter, ISignedIdentifier[])	Establece los permisos para el recurso compartido especificado. Los permisos indican si se puede acceder públicamente a directorios o archivos de un recurso compartido. Al establecer permisos para un recurso compartido, se reemplazan los permisos existentes. Si no se proporciona shareAcl, se quitará la ACL del recurso compartido existente.
setMetadata(Aborter, IMetadata)	Establece uno o varios pares nombre-valor definidos por el usuario para el recurso compartido especificado. Si no se proporciona ninguna opción o ningún metadato definido en el parámetro option, se quitarán los metadatos del recurso compartido.
setQuota(Aborter, number)	Establece la cuota del recurso compartido especificado.
withPipeline(Pipeline)	Crea un nuevo objeto ShareURL idéntico al origen, pero con la canalización de directiva de solicitud especificada.
withSnapshot(string)	Crea un nuevo objeto ShareURL idéntico al origen, pero con la marca de tiempo de instantánea especificada. Proporcione "" quitará la instantánea y devolverá una dirección URL al recurso compartido base.

Detalles del constructor

ShareURL(string, Pipeline)

Crea una instancia de ShareURL.

new ShareURL(url: string, pipeline: Pipeline)

Parámetros

url: string

Cadena de dirección URL que apunta al recurso compartido de archivos de Azure Storage, como "https://myaccount.file.core.windows.net/share". Puede anexar una SAS si usa AnonymousCredential, como "https://myaccount.file.core.windows.net/share?sasString".

pipeline: Pipeline

Llame a StorageURL.newPipeline() para crear una canalización predeterminada o proporcionar una canalización personalizada.

Detalles de las propiedades

pipeline

Canalización de directiva de solicitud.

pipeline: Pipeline

Valor de propiedad

Pipeline

url

Valor de cadena de dirección URL.

url: string

Valor de propiedad

string

Detalles del método

create(Aborter, IShareCreateOptions)

Crea un nuevo recurso compartido en la cuenta especificada. Si el recurso compartido con el mismo nombre ya existe, se produce un error en la operación.

function create(aborter: Aborter, options?: IShareCreateOptions)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

options: IShareCreateOptions

Devoluciones

Promise<Models.ShareCreateResponse>

createPermission(Aborter, string)

Crea un permiso de archivo (un descriptor de seguridad) en el nivel de recurso compartido. El descriptor de seguridad creado se puede usar para los archivos o directorios del recurso compartido.

function createPermission(aborter: Aborter, filePermission: string)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

filePermission: string

Permiso de archivo descrito en SDDL

Devoluciones

Promise<Models.ShareCreatePermissionResponse>

createSnapshot(Aborter, IShareCreateSnapshotOptions)

Crea una instantánea de solo lectura de un recurso compartido.

function createSnapshot(aborter: Aborter, options?: IShareCreateSnapshotOptions)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

options: IShareCreateSnapshotOptions

Devoluciones

Promise<Models.ShareCreateSnapshotResponse>

delete(Aborter, IShareDeleteMethodOptions)

Marca el recurso compartido especificado para su eliminación. El recurso compartido y los directorios o archivos contenidos en él se eliminan posteriormente durante la recolección de elementos no utilizados.

function delete(aborter: Aborter, options?: IShareDeleteMethodOptions)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

options: IShareDeleteMethodOptions

Devoluciones

Promise<Models.ShareDeleteResponse>

fromServiceURL(ServiceURL, string)

Crea un objeto ShareURL a partir de ServiceURL

static function fromServiceURL(serviceURL: ServiceURL, shareName: string)

Parámetros

serviceURL: ServiceURL

shareName: string

Devoluciones

ShareURL

getAccessPolicy(Aborter)

Obtiene los permisos para el recurso compartido especificado. Los permisos indican si se puede acceder a los datos compartidos públicamente. ADVERTENCIA: La fecha de JavaScript podría perder precisión al analizar la cadena de inicio y expiración. Por ejemplo, new Date("2018-12-31T03:44:23.8827891Z").toISOString() obtendrá "2018-12-31T03:44:23.882Z".

function getAccessPolicy(aborter: Aborter)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

Devoluciones

Promise<ShareGetAccessPolicyResponse>

getPermission(Aborter, string)

Obtiene el lenguaje de definición de descriptores de seguridad (SDDL) de una clave de permiso de archivo determinada que indica un descriptor de seguridad.

function getPermission(aborter: Aborter, filePermissionKey: string)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

filePermissionKey: string

Clave de permiso de archivo que indica el descriptor de seguridad del permiso.

Devoluciones

Promise<Models.ShareGetPermissionResponse>

getProperties(Aborter)

Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el recurso compartido especificado.

function getProperties(aborter: Aborter)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

Devoluciones

Promise<Models.ShareGetPropertiesResponse>

getStatistics(Aborter)

Recupera estadísticas relacionadas con el recurso compartido.

function getStatistics(aborter: Aborter)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

Devoluciones

Promise<ShareGetStatisticsResponse>

newPipeline(Credential, INewPipelineOptions)

Método estático que se usa para crear un nuevo objeto Pipeline con credential proporcionado.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

Parámetros

credential: Credential

Por ejemplo, AnonymousCredential, SharedKeyCredential.

pipelineOptions: INewPipelineOptions

Devoluciones

Pipeline

Nuevo objeto Pipeline.

setAccessPolicy(Aborter, ISignedIdentifier[])

Establece los permisos para el recurso compartido especificado. Los permisos indican si se puede acceder públicamente a directorios o archivos de un recurso compartido. Al establecer permisos para un recurso compartido, se reemplazan los permisos existentes. Si no se proporciona shareAcl, se quitará la ACL del recurso compartido existente.

function setAccessPolicy(aborter: Aborter, shareAcl?: ISignedIdentifier[])

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

shareAcl: ISignedIdentifier[]

Devoluciones

Promise<Models.ShareSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

Establece uno o varios pares nombre-valor definidos por el usuario para el recurso compartido especificado. Si no se proporciona ninguna opción o ningún metadato definido en el parámetro option, se quitarán los metadatos del recurso compartido.

function setMetadata(aborter: Aborter, metadata?: IMetadata)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

metadata: IMetadata

Devoluciones

Promise<Models.ShareSetMetadataResponse>

setQuota(Aborter, number)

Establece la cuota del recurso compartido especificado.

function setQuota(aborter: Aborter, quotaInGB: number)

Parámetros

aborter: Aborter

Cree una nueva instancia de Aborter con Aborter.none o Aborter.timeout(), documentos goto de Aborter para obtener más ejemplos sobre la cancelación de solicitudes.

quotaInGB: number

Especifica el tamaño máximo del recurso compartido en gigabytes.

Devoluciones

Promise<Models.ShareSetQuotaResponse>

withPipeline(Pipeline)

Crea un nuevo objeto ShareURL idéntico al origen, pero con la canalización de directiva de solicitud especificada.

function withPipeline(pipeline: Pipeline)

Parámetros

pipeline: Pipeline

Devoluciones

ShareURL

withSnapshot(string)

Crea un nuevo objeto ShareURL idéntico al origen, pero con la marca de tiempo de instantánea especificada. Proporcione "" quitará la instantánea y devolverá una dirección URL al recurso compartido base.

function withSnapshot(snapshot: string)

Parámetros

snapshot: string

Devoluciones

ShareURL

Nuevo objeto ShareURL idéntico al origen, pero con la marca de tiempo de instantánea especificada

Comentarios

¿Le ha resultado útil esta página?

Compartir a través de

ShareURL class

Constructores

Propiedades

Métodos

Detalles del constructor

ShareURL(string, Pipeline)

Parámetros

Detalles de las propiedades

pipeline

Valor de propiedad

url

Valor de propiedad

Detalles del método

create(Aborter, IShareCreateOptions)

Parámetros

Devoluciones

createPermission(Aborter, string)

Parámetros

Devoluciones

createSnapshot(Aborter, IShareCreateSnapshotOptions)

Parámetros

Devoluciones

delete(Aborter, IShareDeleteMethodOptions)

Parámetros

Devoluciones

fromServiceURL(ServiceURL, string)

Parámetros

Devoluciones

getAccessPolicy(Aborter)

Parámetros

Devoluciones

getPermission(Aborter, string)

Parámetros

Devoluciones

getProperties(Aborter)

Parámetros

Devoluciones

getStatistics(Aborter)

Parámetros

Devoluciones

newPipeline(Credential, INewPipelineOptions)

Parámetros

Devoluciones

setAccessPolicy(Aborter, ISignedIdentifier[])

Parámetros

Devoluciones

setMetadata(Aborter, IMetadata)

Parámetros

Devoluciones

setQuota(Aborter, number)

Parámetros

Devoluciones

withPipeline(Pipeline)

Parámetros

Devoluciones

withSnapshot(string)

Parámetros

Devoluciones

Comentarios