Share via

ShareClient Clase

  • Referencia

Un cliente para interactuar con un recurso compartido específico, aunque es posible que ese recurso compartido aún no exista.

En el caso de las operaciones relacionadas con un directorio o archivo específicos de este recurso compartido, los clientes de esas entidades también se pueden recuperar mediante las get_directory_client funciones y get_file_client .

Para obtener más configuración opcional, haga clic aquí.

Herencia
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin
ShareClient

Constructor

ShareClient(account_url: str, share_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)

Parámetros

account_url
str
Requerido

Identificador URI de la cuenta de almacenamiento. Para crear un cliente dado el URI completo al recurso compartido, use el from_share_url método classmethod.

share_name
str
Requerido

Nombre del recurso compartido con el que se va a interactuar.

snapshot
str
valor predeterminado: None

Instantánea de recurso compartido opcional en la que se va a operar. Puede ser la cadena de identificador de instantánea o la respuesta devuelta desde create_snapshot.

credential
valor predeterminado: None

Credenciales con las que se va a autenticar. Esto es opcional si la dirección URL de la cuenta ya tiene un token de SAS. El valor puede ser una cadena de token de SAS, una instancia de AzureSasCredential o AzureNamedKeyCredential de azure.core.credentials, una clave de acceso compartido de cuenta o una instancia de una clase TokenCredentials de azure.identity. Si el URI del recurso ya contiene un token de SAS, se omitirá en favor de una credencial explícita.

  • excepto en el caso de AzureSasCredential, donde los tokens de SAS en conflicto generarán un valor ValueError. Si usa una instancia de AzureNamedKeyCredential, "name" debe ser el nombre de la cuenta de almacenamiento y "key" debe ser la clave de la cuenta de almacenamiento.
token_intent
Literal['backup']

Necesario cuando se usa TokenCredential para la autenticación y se omite para otras formas de autenticación. Especifica la intención de todas las solicitudes al usar la autenticación TokenCredential . Los valores posibles son:

backup: especifica que las solicitudes están pensadas para las operaciones de tipo de copia de seguridad o administrador, lo que significa que se omiten todas las ACL de archivos o directorios y se conceden permisos completos. El usuario también debe tener el permiso RBAC necesario.

allow_trailing_dot
bool

Si es true, el punto final no se recortará del URI de destino.

allow_source_trailing_dot
bool

Si es true, el punto final no se recortará del URI de origen.

api_version
str

La versión de la API de storage que se va a usar para las solicitudes. El valor predeterminado es la versión de servicio más reciente que es compatible con el SDK actual. Establecer en una versión anterior puede dar lugar a una compatibilidad de características reducida.

Novedades de la versión 12.1.0.

secondary_hostname
str

El nombre de host del punto de conexión secundario.

max_range_size
int

Tamaño máximo del intervalo usado para una carga de archivos. El valor predeterminado es 4*1024*1024.

Métodos

acquire_lease

Solicita una nueva concesión.

Si el recurso compartido no tiene una concesión activa, el servicio compartido crea una concesión en el recurso compartido y devuelve una nueva concesión.

Novedades de la versión 12.5.0.
close

Este método consiste en cerrar los sockets abiertos por el cliente. No es necesario usarse cuando se usa con un administrador de contextos.
create_directory

Crea un directorio en el recurso compartido y devuelve un cliente para interactuar con el directorio.
create_permission_for_share

Cree un permiso (un descriptor de seguridad) en el nivel de recurso compartido.

Este "permiso" se puede usar para los archivos o directorios del recurso compartido. Si ya existe un 'permiso', devolverá la clave de ella; de lo contrario, creará un nuevo permiso en el nivel de recurso compartido y devolverá su clave.
create_share

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

Crea una instantánea del recurso compartido.

Una instantánea es una versión de solo lectura de un recurso compartido que se toma en un momento dado. Se puede leer, copiar o eliminar, pero no modificar. Las instantáneas proporcionan una manera de realizar una copia de seguridad de un recurso compartido tal y como aparece en un momento dado.

Una instantánea de un recurso compartido tiene el mismo nombre que el recurso compartido base desde el que se toma la instantánea, con un valor DateTime anexado para indicar la hora a la que se tomó la instantánea.
delete_directory

Marca el directorio para su eliminación. El directorio se elimina posteriormente durante la recolección de elementos no utilizados.
delete_share

Marca el recurso compartido especificado para su eliminación. El recurso compartido se elimina posteriormente durante la recolección de elementos no utilizados.
from_connection_string

Cree ShareClient a partir de una cadena de conexión.
from_share_url
get_directory_client

Obtenga un cliente para interactuar con el directorio especificado. El directorio aún no debe existir.
get_file_client

Obtener un cliente para interactuar con el archivo especificado. El archivo aún no existe.
get_permission_for_share

Obtenga un permiso (un descriptor de seguridad) para una clave determinada.

Este "permiso" se puede usar para los archivos o directorios del recurso compartido.
get_share_access_policy

Obtiene los permisos para el recurso compartido. Los permisos indican si se puede acceder a los archivos de un recurso compartido públicamente.
get_share_properties

Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el recurso compartido especificado. Los datos devueltos no incluyen la lista de archivos o directorios de los recursos compartidos.
get_share_stats

Obtiene el tamaño aproximado de los datos almacenados en el recurso compartido en bytes.

Tenga en cuenta que es posible que este valor no incluya todos los archivos creados recientemente o de nuevo tamaño.
list_directories_and_files

Enumera los directorios y los archivos en el recurso compartido.
set_share_access_policy

Establece los permisos para el recurso compartido o las directivas de acceso almacenadas que se pueden usar con firmas de acceso compartido. Los permisos indican si se puede acceder a los archivos de un recurso compartido públicamente.
set_share_metadata

Establece los metadatos del recurso compartido.

Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntados al recurso compartido. Para quitar todos los metadatos del recurso compartido, llame a esta operación sin dict de metadatos.
set_share_properties

Establece las propiedades del recurso compartido.

Novedades de la versión 12.4.0.
set_share_quota

Establece la cuota del recurso compartido.

acquire_lease

Solicita una nueva concesión.

Si el recurso compartido no tiene una concesión activa, el servicio compartido crea una concesión en el recurso compartido y devuelve una nueva concesión.

Novedades de la versión 12.5.0.

acquire_lease(**kwargs: Any) -> ShareLeaseClient

Parámetros

lease_duration
int

Especifica la duración de la concesión, en segundos, o bien un valor negativo (-1) para una concesión que no expira nunca. Un concesión no infinita puede durar entre 15 y 60 segundos. No se puede cambiar una duración de concesión mediante renovación o cambio. El valor predeterminado es -1 (concesión infinita).

lease_id
str

Identificador de concesión propuesto, con formato de cadena de GUID. El servicio compartido devuelve 400 (solicitud no válida) si el identificador de concesión propuesto no tiene el formato correcto.

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Objeto ShareLeaseClient.

Tipo de valor devuelto

ShareLeaseClient

Ejemplos

Adquirir una concesión en un recurso compartido.


   share.create_directory("mydir")
   lease = share.acquire_lease()
   share.get_share_properties(lease=lease)
   share.delete_share(lease=lease)

close

Este método consiste en cerrar los sockets abiertos por el cliente. No es necesario usarse cuando se usa con un administrador de contextos.

close()

create_directory

Crea un directorio en el recurso compartido y devuelve un cliente para interactuar con el directorio.

create_directory(directory_name: str, **kwargs: Any) -> ShareDirectoryClient

Parámetros

directory_name
str
Requerido

Nombre del directorio.

metadata

Pares nombre-valor asociados al directorio como metadatos.

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

ShareDirectoryClient

Tipo de valor devuelto

ShareDirectoryClient

create_permission_for_share

Cree un permiso (un descriptor de seguridad) en el nivel de recurso compartido.

Este "permiso" se puede usar para los archivos o directorios del recurso compartido. Si ya existe un 'permiso', devolverá la clave de ella; de lo contrario, creará un nuevo permiso en el nivel de recurso compartido y devolverá su clave.

create_permission_for_share(file_permission: str, **kwargs: Any) -> str

Parámetros

file_permission
str
Requerido

Permiso de archivo, un SDDL portátil

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Una clave de permiso de archivo

Tipo de valor devuelto

str

create_share

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

create_share(**kwargs: Any) -> Dict[str, Any]

Parámetros

metadata
dict(str,str)

Pares nombre-valor asociados al recurso compartido como metadatos.

quota
int

Cuota que se va a asignar.

access_tier

Especifica el nivel de acceso del recurso compartido. Valores posibles: "TransactionOptimized", "Hot", "Cool"

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

protocols
str o ShareProtocols

Protocolos para habilitar en el recurso compartido. Solo se puede habilitar un protocolo en el recurso compartido.

root_squash
str o ShareRootSquash

Squash raíz que se va a establecer en el recurso compartido. Solo es válido para recursos compartidos NFS. Entre los valores posibles se incluyen: "NoRootSquash", "RootSquash", "AllSquash".

Devoluciones

Dict de propiedades actualizadas por recurso compartido (Etag y última modificación).

Tipo de valor devuelto

Dict[str, Any]

Ejemplos

Crea un recurso compartido de archivos.


   # Create share with Access Tier set to Hot
   share.create_share(access_tier=ShareAccessTier("Hot"))

create_snapshot

Crea una instantánea del recurso compartido.

Una instantánea es una versión de solo lectura de un recurso compartido que se toma en un momento dado. Se puede leer, copiar o eliminar, pero no modificar. Las instantáneas proporcionan una manera de realizar una copia de seguridad de un recurso compartido tal y como aparece en un momento dado.

Una instantánea de un recurso compartido tiene el mismo nombre que el recurso compartido base desde el que se toma la instantánea, con un valor DateTime anexado para indicar la hora a la que se tomó la instantánea.

create_snapshot(**kwargs: Any | None) -> Dict[str, Any]

Parámetros

metadata
dict(str,str)

Pares nombre-valor asociados al recurso compartido como metadatos.

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Dict de propiedad actualizada por recurso compartido (id. de instantánea, Etag y última modificación).

Tipo de valor devuelto

dict[str, Any]

Ejemplos

Crea una instantánea del recurso compartido de archivos.


   share.create_snapshot()

delete_directory

Marca el directorio para su eliminación. El directorio se elimina posteriormente durante la recolección de elementos no utilizados.

delete_directory(directory_name: str, **kwargs: Any) -> None

Parámetros

directory_name
str
Requerido

Nombre del directorio.

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Tipo de valor devuelto

None

delete_share

Marca el recurso compartido especificado para su eliminación. El recurso compartido se elimina posteriormente durante la recolección de elementos no utilizados.

delete_share(delete_snapshots: bool | None = False, **kwargs) -> None

Parámetros

delete_snapshots
bool
Requerido

Indica si se van a eliminar instantáneas.

lease

Obligatorio si el recurso compartido tiene una concesión activa. El valor puede ser un objeto ShareLeaseClient o el identificador de concesión como una cadena.

Novedad de la versión 12.5.0.

Este argumento de palabra clave se introdujo en la versión de API "2020-08-04".

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Ejemplos

Elimina el recurso compartido y las instantáneas.


   share.delete_share(delete_snapshots=True)

from_connection_string

Cree ShareClient a partir de una cadena de conexión.

from_connection_string(conn_str: str, share_name: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parámetros

conn_str
str
Requerido

Cadena de conexión a una cuenta de Azure Storage.

share_name
str
Requerido

Nombre del recurso compartido.

snapshot
str
valor predeterminado: None

Instantánea de recurso compartido opcional en la que se va a operar. Puede ser la cadena de identificador de instantánea o la respuesta devuelta de create_snapshot.

credential
valor predeterminado: None

Credenciales con las que se va a autenticar. Esto es opcional si la dirección URL de la cuenta ya tiene un token de SAS. El valor puede ser una cadena de token de SAS, una instancia de AzureSasCredential o AzureNamedKeyCredential de azure.core.credentials, una clave de acceso compartido de cuenta o una instancia de una clase TokenCredentials de azure.identity. Si el URI del recurso ya contiene un token de SAS, se omitirá en favor de una credencial explícita.

  • excepto en el caso de AzureSasCredential, donde los tokens de SAS en conflicto generarán un valor ValueError. Si usa una instancia de AzureNamedKeyCredential, "name" debe ser el nombre de la cuenta de almacenamiento y "key" debe ser la clave de la cuenta de almacenamiento.

Devoluciones

Un cliente compartido.

Tipo de valor devuelto

ShareClient

Ejemplos

Obtiene el cliente compartido de la cadena de conexión.


   from azure.storage.fileshare import ShareClient
   share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")

from_share_url 

from_share_url(share_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parámetros

share_url
str
Requerido

Identificador URI completo del recurso compartido.

snapshot
str
valor predeterminado: None

Instantánea de recurso compartido opcional en la que se va a operar. Puede ser la cadena de identificador de instantánea o la respuesta devuelta de create_snapshot.

credential
valor predeterminado: None

Credenciales con las que se va a autenticar. Esto es opcional si la dirección URL de la cuenta ya tiene un token de SAS. El valor puede ser una cadena de token de SAS, una instancia de AzureSasCredential o AzureNamedKeyCredential de azure.core.credentials, una clave de acceso compartido de cuenta o una instancia de una clase TokenCredentials de azure.identity. Si el URI del recurso ya contiene un token de SAS, se omitirá en favor de una credencial explícita.

  • excepto en el caso de AzureSasCredential, donde los tokens de SAS en conflicto generarán un valor ValueError. Si usa una instancia de AzureNamedKeyCredential, "name" debe ser el nombre de la cuenta de almacenamiento y "key" debe ser la clave de la cuenta de almacenamiento.

Devoluciones

Un cliente compartido.

Tipo de valor devuelto

ShareClient

get_directory_client

Obtenga un cliente para interactuar con el directorio especificado. El directorio aún no debe existir.

get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient

Parámetros

directory_path
str
valor predeterminado: None

Ruta de acceso al directorio especificado.

Devoluciones

Un cliente de directorio.

Tipo de valor devuelto

ShareDirectoryClient

get_file_client

Obtener un cliente para interactuar con el archivo especificado. El archivo aún no existe.

get_file_client(file_path: str) -> ShareFileClient

Parámetros

file_path
str
Requerido

Ruta de acceso al archivo especificado.

Devoluciones

Un cliente de archivos.

Tipo de valor devuelto

ShareFileClient

get_permission_for_share

Obtenga un permiso (un descriptor de seguridad) para una clave determinada.

Este "permiso" se puede usar para los archivos o directorios del recurso compartido.

get_permission_for_share(permission_key: str, **kwargs: Any) -> str

Parámetros

permission_key
str
Requerido

Clave del permiso de archivo que se va a recuperar

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Un permiso de archivo (un SDDL portátil)

Tipo de valor devuelto

str

get_share_access_policy

Obtiene los permisos para el recurso compartido. Los permisos indican si se puede acceder a los archivos de un recurso compartido públicamente.

get_share_access_policy(**kwargs: Any) -> Dict[str, Any]

Parámetros

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

lease

Obligatorio si el recurso compartido tiene una concesión activa. El valor puede ser un objeto ShareLeaseClient o el identificador de concesión como una cadena.

Novedad de la versión 12.5.0.

Este argumento de palabra clave se introdujo en la versión de API "2020-08-04".

Devoluciones

Información de la directiva de acceso en un dict.

Tipo de valor devuelto

dict[str, Any]

get_share_properties

Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el recurso compartido especificado. Los datos devueltos no incluyen la lista de archivos o directorios de los recursos compartidos.

get_share_properties(**kwargs: Any) -> ShareProperties

Parámetros

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

lease

Obligatorio si el recurso compartido tiene una concesión activa. El valor puede ser un objeto ShareLeaseClient o el identificador de concesión como una cadena.

Novedad de la versión 12.5.0.

Este argumento de palabra clave se introdujo en la versión de API "2020-08-04".

Devoluciones

Propiedades de recurso compartido.

Tipo de valor devuelto

ShareProperties

Ejemplos

Obtiene las propiedades del recurso compartido.


   properties = share.get_share_properties()

get_share_stats

Obtiene el tamaño aproximado de los datos almacenados en el recurso compartido en bytes.

Tenga en cuenta que es posible que este valor no incluya todos los archivos creados recientemente o de nuevo tamaño.

get_share_stats(**kwargs: Any) -> int

Parámetros

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.

lease

Obligatorio si el recurso compartido tiene una concesión activa. El valor puede ser un objeto ShareLeaseClient o el identificador de concesión como una cadena.

Novedad de la versión 12.5.0.

Este argumento de palabra clave se introdujo en la versión de API "2020-08-04".

Devoluciones

Tamaño aproximado de los datos (en bytes) almacenados en el recurso compartido.

Tipo de valor devuelto

int

list_directories_and_files

Enumera los directorios y los archivos en el recurso compartido.

list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]

Parámetros

directory_name
str
Requerido

Nombre de un directorio.

name_starts_with
str
Requerido

Filtra los resultados para devolver solo los directorios cuyos nombres comienzan con el prefijo especificado.

marker
str
Requerido

Un token de continuación opaco. Este valor se puede recuperar del campo next_marker de un objeto generador anterior. Si se especifica, este generador comenzará a devolver resultados desde este punto.

include
list[str]

Incluya este parámetro para especificar uno o varios conjuntos de datos que se van a incluir en la respuesta. Los valores str posibles son "marcas de tiempo", "Etag", "Attributes", "PermissionKey".

Novedades de la versión 12.6.0.

Este argumento de palabra clave se introdujo en la versión de API "2020-10-02".

include_extended_info
bool

Si se establece en true, el identificador de archivo se devolverá en los resultados enumerados.

Novedades de la versión 12.6.0.

Este argumento de palabra clave se introdujo en la versión de API "2020-10-02".

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Iterable de paginación automática de DirectoryProperties y FileProperties de tipo dict

Tipo de valor devuelto

Iterable[Dict[str,str]]

Ejemplos

Enumera los directorios y archivos del recurso compartido.


   # Create a directory in the share
   dir_client = share.create_directory("mydir")

   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source_file:
       dir_client.upload_file(file_name="sample", data=source_file)

   # List files in the directory
   my_files = list(share.list_directories_and_files(directory_name="mydir"))
   print(my_files)

set_share_access_policy

Establece los permisos para el recurso compartido o las directivas de acceso almacenadas que se pueden usar con firmas de acceso compartido. Los permisos indican si se puede acceder a los archivos de un recurso compartido públicamente.

set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]

Parámetros

signed_identifiers
dict(str, AccessPolicy)
Requerido

Diccionario de directivas de acceso que se van a asociar al recurso compartido. El diccionario puede contener hasta 5 elementos. Un diccionario vacío borrará las directivas de acceso establecidas en el servicio.

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

lease

Obligatorio si el recurso compartido tiene una concesión activa. El valor puede ser un objeto ShareLeaseClient o el identificador de concesión como una cadena.

Novedades de la versión 12.5.0.

Este argumento de palabra clave se introdujo en la versión de API "2020-08-04".

Devoluciones

Dict de propiedades actualizadas por recurso compartido (Etag y última modificación).

Tipo de valor devuelto

dict(str, Any)

set_share_metadata

Establece los metadatos del recurso compartido.

Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntados al recurso compartido. Para quitar todos los metadatos del recurso compartido, llame a esta operación sin dict de metadatos.

set_share_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parámetros

metadata
dict(str, str)
Requerido

Pares nombre-valor asociados al recurso compartido como metadatos.

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

lease

Obligatorio si el recurso compartido tiene una concesión activa. El valor puede ser un objeto ShareLeaseClient o el identificador de concesión como una cadena.

Novedades de la versión 12.5.0.

Este argumento de palabra clave se introdujo en la versión de API "2020-08-04".

Devoluciones

Dict de propiedades actualizadas por recurso compartido (Etag y última modificación).

Tipo de valor devuelto

dict(str, Any)

Ejemplos

Establece los metadatos del recurso compartido.


   data = {'category': 'test'}
   share.set_share_metadata(metadata=data)

set_share_properties

Establece las propiedades del recurso compartido.

Novedades de la versión 12.4.0.

set_share_properties(**kwargs: Any) -> Dict[str, Any]

Parámetros

access_tier
str o <xref:azure.storage.fileshare.models.ShareAccessTier>

Especifica el nivel de acceso del recurso compartido. Valores posibles: "TransactionOptimized", "Hot" y "Cool"

quota
int

Especifica el tamaño máximo del recurso compartido en gigabytes. Debe ser mayor que 0 y menor o igual que 5 TB.

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

root_squash
str o ShareRootSquash

Squash raíz que se va a establecer en el recurso compartido. Solo es válido para recursos compartidos NFS. Entre los valores posibles se incluyen: "NoRootSquash", "RootSquash", "AllSquash".

lease

Obligatorio si el recurso compartido tiene una concesión activa. El valor puede ser un objeto ShareLeaseClient o el identificador de concesión como una cadena.

Devoluciones

Dict de propiedades actualizadas por recurso compartido (Etag y última modificación).

Tipo de valor devuelto

dict(str, Any)

Ejemplos

Establece las propiedades del recurso compartido.


   # Set the tier for the first share to Hot
   share1.set_share_properties(access_tier="Hot")
   # Set the quota for the first share to 3
   share1.set_share_properties(quota=3)
   # Set the tier for the second share to Cool and quota to 2
   share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)

   # Get the shares' properties
   print(share1.get_share_properties().access_tier)
   print(share1.get_share_properties().quota)
   print(share2.get_share_properties().access_tier)
   print(share2.get_share_properties().quota)

set_share_quota

Establece la cuota del recurso compartido.

set_share_quota(quota: int, **kwargs: Any) -> Dict[str, Any]

Parámetros

quota
int
Requerido

Especifica el tamaño máximo del recurso compartido en gigabytes. Debe ser mayor que 0 y menor o igual que 5 TB.

timeout
int

Establece el tiempo de espera del lado servidor para la operación en segundos. Para más información, consulte https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Este valor no se realiza un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

lease

Obligatorio si el recurso compartido tiene una concesión activa. El valor puede ser un objeto ShareLeaseClient o el identificador de concesión como una cadena.

Novedades de la versión 12.5.0.

Este argumento de palabra clave se introdujo en la versión de API "2020-08-04".

Devoluciones

Dict de propiedades actualizadas por recurso compartido (Etag y última modificación).

Tipo de valor devuelto

dict(str, Any)

Ejemplos

Establece la cuota de recursos compartidos.


   # Set the quota for the share to 1GB
   share.set_share_quota(quota=1)

Atributos

api_version

La versión de la API de storage que se usa para las solicitudes.

location_mode

Modo de ubicación que el cliente está usando actualmente.

De forma predeterminada, será "principal". Entre las opciones se incluyen "primary" y "secondary".

primary_endpoint

Dirección URL completa del punto de conexión principal.

primary_hostname

Nombre de host del punto de conexión principal.

secondary_endpoint

Dirección URL completa del punto de conexión secundario si está configurada.

Si no está disponible, se generará un valor ValueError. Para especificar explícitamente un nombre de host secundario, use el argumento opcional secondary_hostname palabra clave en la creación de instancias.

Excepciones

ValueError

secondary_hostname

El nombre de host del punto de conexión secundario.

Si no está disponible, será Ninguno. Para especificar explícitamente un nombre de host secundario, use el argumento opcional secondary_hostname palabra clave en la creación de instancias.

url

Dirección URL completa del punto de conexión a esta entidad, incluido el token de SAS si se usa.

Puede ser el punto de conexión principal o el punto de conexión secundario en función del actual location_mode. :returns: la dirección URL completa del punto de conexión a esta entidad, incluido el token de SAS si se usa. :rtype: str