ShareServiceClient Clase

Un cliente para interactuar con el servicio de recursos compartidos de archivos en el nivel de cuenta.

Este cliente proporciona operaciones para recuperar y configurar las propiedades de la cuenta, así como enumerar, crear y eliminar recursos compartidos dentro de la cuenta. En el caso de las operaciones relacionadas con un recurso compartido específico, también se puede recuperar un cliente para esa entidad mediante la get_share_client función .

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

Herencia

azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin

ShareServiceClient

Constructor

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

Parámetros

account_url

str

Requerido

Dirección URL de la cuenta de almacenamiento del recurso compartido de archivos. Cualquier otra entidad incluida en la ruta de acceso de dirección URL (por ejemplo, recurso compartido o archivo) se descartará. Esta dirección URL se puede autenticar opcionalmente con un token de SAS.

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.

Ejemplos

Cree el cliente del servicio compartido con la dirección URL y la credencial.

   from azure.storage.fileshare import ShareServiceClient
   share_service_client = ShareServiceClient(
       account_url=self.account_url,
       credential=self.access_key
   )

Métodos

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_share	Crea un nuevo recurso compartido en la cuenta especificada. Si ya existe un recurso compartido con el mismo nombre, se produce un error en la operación. Devuelve un cliente con el que interactuar con el recurso compartido recién creado.
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 ShareServiceClient a partir de una cadena de conexión.
get_service_properties	Obtiene las propiedades del servicio Recurso compartido de archivos de una cuenta de almacenamiento, incluido Azure Storage Analytics.
get_share_client	Obtener un cliente para interactuar con el recurso compartido especificado. El recurso compartido aún no necesita existir.
list_shares	Devuelve la paginación automática iterable de ShareProperties de tipo dict en la cuenta especificada. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio y se detendrá cuando se devuelvan todos los recursos compartidos.
set_service_properties	Establece las propiedades del servicio recurso compartido de archivos de una cuenta de almacenamiento, incluido Azure Storage Analytics. Si un elemento (por ejemplo, hour_metrics) se deja como None, se conserva la configuración existente en el servicio para esa funcionalidad.
undelete_share	Restaura el recurso compartido eliminado temporalmente. La operación solo se realizará correctamente si se usa dentro del número de días especificado establecido en la directiva de retención de eliminación. Novedad de la versión 12.2.0: esta operación se introdujo en la versión de API "2019-12-12".

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_share

Crea un nuevo recurso compartido en la cuenta especificada. Si ya existe un recurso compartido con el mismo nombre, se produce un error en la operación. Devuelve un cliente con el que interactuar con el recurso compartido recién creado.

create_share(share_name: str, **kwargs) -> ShareClient

Parámetros

share_name

str

Requerido

Nombre del recurso compartido que se va a crear.

metadata

dict(str,str)

Un dict con pares de name_value que se van a asociar al recurso compartido como metadatos. Ejemplo:{'Category':'test'}

quota

int

Cuota en bytes.

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

ShareClient para el recurso compartido recién creado.

Tipo de valor devuelto

ShareClient

Ejemplos

Cree un recurso compartido en el servicio de recursos compartidos de archivos.

   file_service.create_share(share_name="fileshare1")

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(share_name: ShareProperties | str, delete_snapshots: bool | None = False, **kwargs) -> None

Parámetros

share_name

str o ShareProperties

Requerido

Recurso compartido que se va a eliminar. Puede ser el nombre del recurso compartido o una instancia de ShareProperties.

delete_snapshots

bool

Requerido

Indica si se van a eliminar instantáneas.

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í.

Tipo de valor devuelto

None

Ejemplos

Elimine un recurso compartido en el servicio de recursos compartidos de archivos.

   file_service.delete_share(share_name="fileshare1")

from_connection_string

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

from_connection_string(conn_str: str, 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.

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 de servicio de recurso compartido de archivos.

Tipo de valor devuelto

ShareServiceClient

Ejemplos

Cree el cliente de servicio compartido con la cadena de conexión.

   from azure.storage.fileshare import ShareServiceClient
   share_service_client = ShareServiceClient.from_connection_string(self.connection_string)

get_service_properties

Obtiene las propiedades del servicio Recurso compartido de archivos de una cuenta de almacenamiento, incluido Azure Storage Analytics.

get_service_properties(**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 un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.

Devoluciones

Diccionario que contiene propiedades del servicio de archivos, como el registro de análisis, métricas de hora y minuto, reglas de cors, etc.

Tipo de valor devuelto

Dict[str, Any]

Ejemplos

Obtiene las propiedades del servicio de recurso compartido de archivos.

   properties = file_service.get_service_properties()

get_share_client

Obtener un cliente para interactuar con el recurso compartido especificado. El recurso compartido aún no necesita existir.

get_share_client(share: ShareProperties | str, snapshot: Dict[str, Any] | str | None = None) -> ShareClient

Parámetros

share

str o ShareProperties

Requerido

Recurso compartido. Puede ser el nombre del recurso compartido o una instancia de ShareProperties.

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 <xref:azure.storage.fileshare.create_snapshot>.

Devoluciones

Un objeto ShareClient.

Tipo de valor devuelto

ShareClient

Ejemplos

Obtiene el cliente de recurso compartido.

   from azure.storage.fileshare import ShareServiceClient
   file_service = ShareServiceClient.from_connection_string(self.connection_string)

   # Get a share client to interact with a specific share
   share = file_service.get_share_client("fileshare2")

list_shares

Devuelve la paginación automática iterable de ShareProperties de tipo dict en la cuenta especificada. El generador seguirá de forma diferida los tokens de continuación devueltos por el servicio y se detendrá cuando se devuelvan todos los recursos compartidos.

list_shares(name_starts_with: str | None = None, include_metadata: bool | None = False, include_snapshots: bool | None = False, **kwargs) -> ItemPaged[ShareProperties]

Parámetros

name_starts_with

str

Requerido

Filtra los resultados para devolver solo recursos compartidos cuyos nombres comienzan por el name_starts_with especificado.

include_metadata

bool

Requerido

Especifica que los metadatos de recurso compartido se devuelven en la respuesta.

include_snapshots

bool

Requerido

Especifica que la instantánea de recurso compartido se devuelve en la respuesta.

include_deleted

bool

Especifica que los recursos compartidos eliminados se devuelven en la respuesta. Esto solo es para la cuenta habilitada para la eliminación temporal de recursos compartidos.

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

Iterable (paginación automática) de ShareProperties.

Tipo de valor devuelto

ItemPaged[ShareProperties]

Ejemplos

Enumerar recursos compartidos en el servicio de recursos compartidos de archivos.

   # List the shares in the file service
   my_shares = list(file_service.list_shares())

   # Print the shares
   for share in my_shares:
       print(share)

set_service_properties

Establece las propiedades del servicio recurso compartido de archivos de una cuenta de almacenamiento, incluido Azure Storage Analytics. Si un elemento (por ejemplo, hour_metrics) se deja como None, se conserva la configuración existente en el servicio para esa funcionalidad.

set_service_properties(hour_metrics: Metrics | None = None, minute_metrics: Metrics | None = None, cors: List[CorsRule] | None = None, protocol: ShareProtocolSettings | None = None, **kwargs) -> None

Parámetros

hour_metrics

Metrics

Requerido

La configuración de métricas de hora proporciona un resumen de las estadísticas de solicitud agrupadas por API en agregados por hora para los archivos.

minute_metrics

Metrics

Requerido

La configuración de métricas por minuto proporciona estadísticas de solicitud para cada minuto para los archivos.

cors

list(CorsRule)

Requerido

Puede incluir hasta cinco elementos CorsRule en la lista. Si se especifica una lista vacía, se eliminarán todas las reglas de CORS y CORS se deshabilitará para el servicio.

protocol

ShareProtocolSettings

Requerido

Establece la configuración del protocolo

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

Ejemplos

Establece las propiedades del servicio de recursos compartidos de archivos.

   # Create service properties
   from azure.storage.fileshare import Metrics, CorsRule, RetentionPolicy

   # Create metrics for requests statistics
   hour_metrics = Metrics(enabled=True, include_apis=True, retention_policy=RetentionPolicy(enabled=True, days=5))
   minute_metrics = Metrics(enabled=True, include_apis=True,
                            retention_policy=RetentionPolicy(enabled=True, days=5))

   # Create CORS rules
   cors_rule1 = CorsRule(['www.xyz.com'], ['GET'])
   allowed_origins = ['www.xyz.com', "www.ab.com", "www.bc.com"]
   allowed_methods = ['GET', 'PUT']
   max_age_in_seconds = 500
   exposed_headers = ["x-ms-meta-data*", "x-ms-meta-source*", "x-ms-meta-abc", "x-ms-meta-bcd"]
   allowed_headers = ["x-ms-meta-data*", "x-ms-meta-target*", "x-ms-meta-xyz", "x-ms-meta-foo"]
   cors_rule2 = CorsRule(
       allowed_origins,
       allowed_methods,
       max_age_in_seconds=max_age_in_seconds,
       exposed_headers=exposed_headers,
       allowed_headers=allowed_headers)

   cors = [cors_rule1, cors_rule2]

   # Set the service properties
   file_service.set_service_properties(hour_metrics, minute_metrics, cors)

undelete_share

Restaura el recurso compartido eliminado temporalmente.

La operación solo se realizará correctamente si se usa dentro del número de días especificado establecido en la directiva de retención de eliminación.

Novedad de la versión 12.2.0: esta operación se introdujo en la versión de API "2019-12-12".

undelete_share(deleted_share_name: str, deleted_share_version: str, **kwargs: Any) -> ShareClient

Parámetros

deleted_share_name

str

Requerido

Especifica el nombre del recurso compartido eliminado que se va a restaurar.

deleted_share_version

str

Requerido

Especifica la versión del recurso compartido eliminado que se va a restaurar.

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

ShareClient para el recurso compartido no eliminado.

Tipo de valor devuelto

ShareClient

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