ShareDirectoryClient Clase
Un cliente para interactuar con un directorio específico, aunque es posible que aún no exista.
En el caso de las operaciones relacionadas con un subdirectorio o archivo específicos de este recurso compartido, los clientes de esas entidades también se pueden recuperar mediante las get_subdirectory_client funciones y get_file_client .
Para obtener más configuración opcional, haga clic aquí.
- Herencia
-
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixinShareDirectoryClient
Constructor
ShareDirectoryClient(account_url: str, share_name: str, directory_path: 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
Identificador URI de la cuenta de almacenamiento. Para crear un cliente dado el URI completo al directorio, use la from_directory_url clasemethod.
- directory_path
- str
Ruta de acceso del directorio con el que se va a interactuar. Si se especifica, este valor invalidará un valor de directorio especificado en la dirección URL del directorio.
- snapshot
- str
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
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
.
- audience
- str
Audiencia que se va a usar al solicitar tokens para la autenticación de Azure Active Directory. Solo tiene un efecto cuando la credencial es de tipo TokenCredential. El valor podría ser https://storage.azure.com/ (valor predeterminado) o https://.file.core.windows.net.
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. |
close_all_handles |
Cierre los identificadores de archivo abiertos. Esta operación se bloqueará hasta que el servicio haya cerrado todos los identificadores abiertos. |
close_handle |
Cierre un identificador de archivo abierto. |
create_directory |
Crea un nuevo directorio en el directorio al que hace referencia el cliente. |
create_subdirectory |
Crea un subdirectorio y devuelve un cliente para interactuar con el subdirectorio. |
delete_directory |
Marca el directorio para su eliminación. El directorio se elimina posteriormente durante la recolección de elementos no utilizados. |
delete_file |
Marca el archivo especificado para su eliminación. El archivo se elimina posteriormente durante la recolección de elementos no utilizados. |
delete_subdirectory |
Elimina un subdirectorio. |
exists |
Devuelve True si existe un directorio y devuelve False de lo contrario. |
from_connection_string |
Cree ShareDirectoryClient a partir de una cadena de conexión. |
from_directory_url |
Cree un objeto ShareDirectoryClient a partir de una dirección URL de directorio. |
get_directory_properties |
Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el directorio especificado. Los datos devueltos no incluyen la lista de archivos del directorio. |
get_file_client |
Obtener un cliente para interactuar con un archivo específico. El archivo aún no existe. |
get_subdirectory_client |
Obtener un cliente para interactuar con un subdirectorio específico. El subdirectorio aún no debe existir. |
list_directories_and_files |
Enumera todos los directorios y archivos en el directorio . |
list_handles |
Enumera los identificadores abiertos en un directorio o en un archivo en el directorio . |
rename_directory |
Cambie el nombre del directorio de origen. :p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes o str :keyword file_creation_time: Hora de creación del directorio. :p aramtype file_creation_time:~datetime.datetime o str :keyword file_last_write_time: Hora de última escritura del archivo. :p aramtype file_last_write_time:~datetime.datetime o str :keyword file_change_time: Cambiar la hora del directorio. Si no se especifica, la hora de cambio se establecerá en la fecha y hora actuales. Novedad de la versión 12.8.0: este parámetro se introdujo en la versión de API "2021-06-08". |
set_directory_metadata |
Establece los metadatos del directorio. Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntados al directorio. Para quitar todos los metadatos del directorio, llame a esta operación con un dict de metadatos vacío. |
set_http_headers |
Establece encabezados HTTP en el directorio. |
upload_file |
Crea un nuevo archivo en el directorio y devuelve shareFileClient para interactuar con el archivo. |
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()
close_all_handles
Cierre los identificadores de archivo abiertos.
Esta operación se bloqueará hasta que el servicio haya cerrado todos los identificadores abiertos.
close_all_handles(recursive: bool = False, **kwargs: Any) -> Dict[str, int]
Parámetros
- recursive
- bool
Boolean que especifica si la operación debe aplicarse al directorio especificado por el cliente, sus archivos, sus subdirectorios y sus archivos. El valor predeterminado es False.
- 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
Número de identificadores cerrados (puede ser 0 si no se encontró el identificador especificado) y el número de identificadores no se pudo cerrar en un dict.
Tipo de valor devuelto
close_handle
Cierre un identificador de archivo abierto.
close_handle(handle: str | Handle, **kwargs: Any) -> Dict[str, 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 un seguimiento ni se valida en el cliente. Para configurar tiempos de espera de red del lado cliente, consulte aquí.
Devoluciones
Número de identificadores cerrados (puede ser 0 si no se encontró el identificador especificado) y el número de identificadores no se pudo cerrar en un dict.
Tipo de valor devuelto
create_directory
Crea un nuevo directorio en el directorio al que hace referencia el cliente.
create_directory(**kwargs: Any) -> Dict[str, Any]
Parámetros
- file_attributes
- NTFSAttributes
Atributos del sistema de archivos para archivos y directorios. Si no se establece, el valor predeterminado sería "none" y los atributos se establecerán en "Archive". Este es un ejemplo para cuando el tipo var es str: 'Temporal|Archive'. file_attributes valor no distingue mayúsculas de minúsculas.
Hora de última escritura del directorio. Valor predeterminado: "now".
- file_permission
- str
Si se especifica el permiso (descriptor de seguridad) se establecerá para el directorio o archivo. Este encabezado se puede usar si el tamaño del permiso es <= 8 KB, se usará el encabezado file-permission-key. Valor predeterminado: Heredar. Si SDDL se especifica como entrada, debe tener propietario, grupo y dacl. Nota: Solo se debe especificar uno de los permisos de archivo o la clave de permiso de archivo.
- file_permission_key
- str
Clave del permiso que se va a establecer para el directorio o archivo. Nota: Solo se debe especificar uno de los permisos de archivo o la clave de permiso de archivo.
Cambiar la hora del directorio. Si no se especifica, la hora de cambio se establecerá en la fecha y hora actuales.
Novedad de la versión 12.8.0: este parámetro se introdujo en la versión de API "2021-06-08".
- 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
Dict de propiedad actualizada por directorio (Etag y última modificación).
Tipo de valor devuelto
Ejemplos
Crea un directorio.
my_directory.create_directory()
create_subdirectory
Crea un subdirectorio y devuelve un cliente para interactuar con el subdirectorio.
create_subdirectory(directory_name: str, **kwargs) -> ShareDirectoryClient
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í.
Devoluciones
ShareDirectoryClient
Tipo de valor devuelto
Ejemplos
Cree un subdirectorio.
# Create the directory
parent_dir.create_directory()
# Create a subdirectory
subdir = parent_dir.create_subdirectory("subdir")
delete_directory
Marca el directorio para su eliminación. El directorio se elimina posteriormente durante la recolección de elementos no utilizados.
delete_directory(**kwargs: Any) -> None
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í.
Tipo de valor devuelto
Ejemplos
Elimina un directorio.
my_directory.delete_directory()
delete_file
Marca el archivo especificado para su eliminación. El archivo se elimina posteriormente durante la recolección de elementos no utilizados.
delete_file(file_name: str, **kwargs: Any | None) -> None
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í.
Tipo de valor devuelto
Ejemplos
Elimine un archivo en un directorio.
# Delete the file in the directory
my_directory.delete_file(file_name="sample")
delete_subdirectory
Elimina un subdirectorio.
delete_subdirectory(directory_name: str, **kwargs) -> None
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í.
Tipo de valor devuelto
Ejemplos
Elimine un subdirectorio.
parent_dir.delete_subdirectory("subdir")
exists
Devuelve True si existe un directorio y devuelve False de lo contrario.
exists(**kwargs: Any) -> bool
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í.
Devoluciones
True si el directorio existe, False en caso contrario.
Tipo de valor devuelto
from_connection_string
Cree ShareDirectoryClient a partir de una cadena de conexión.
from_connection_string(conn_str: str, share_name: str, directory_path: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parámetros
- credential
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.
- audience
- str
Audiencia que se va a usar al solicitar tokens para la autenticación de Azure Active Directory. Solo tiene un efecto cuando la credencial es de tipo TokenCredential. El valor podría ser https://storage.azure.com/ (valor predeterminado) o https://.file.core.windows.net.
Devoluciones
Un cliente de directorio.
Tipo de valor devuelto
from_directory_url
Cree un objeto ShareDirectoryClient a partir de una dirección URL de directorio.
from_directory_url(directory_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parámetros
- snapshot
- str
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
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.
- audience
- str
Audiencia que se va a usar al solicitar tokens para la autenticación de Azure Active Directory. Solo tiene un efecto cuando la credencial es de tipo TokenCredential. El valor podría ser https://storage.azure.com/ (valor predeterminado) o https://.file.core.windows.net.
Devoluciones
Un cliente de directorio.
Tipo de valor devuelto
get_directory_properties
Devuelve todos los metadatos definidos por el usuario y las propiedades del sistema para el directorio especificado. Los datos devueltos no incluyen la lista de archivos del directorio.
get_directory_properties(**kwargs: Any) -> DirectoryProperties
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í.
Devoluciones
DirectoryProperties
Tipo de valor devuelto
get_file_client
Obtener un cliente para interactuar con un archivo específico.
El archivo aún no existe.
get_file_client(file_name: str, **kwargs: Any) -> ShareFileClient
Parámetros
Devoluciones
Un cliente de archivos.
Tipo de valor devuelto
get_subdirectory_client
Obtener un cliente para interactuar con un subdirectorio específico.
El subdirectorio aún no debe existir.
get_subdirectory_client(directory_name: str, **kwargs: Any) -> ShareDirectoryClient
Parámetros
Devoluciones
Un cliente de directorio.
Tipo de valor devuelto
Ejemplos
Obtiene el cliente subdirectorio.
# Get a directory client and create the directory
parent = share.get_directory_client("dir1")
parent.create_directory()
# Get a subdirectory client and create the subdirectory "dir1/dir2"
subdirectory = parent.get_subdirectory_client("dir2")
subdirectory.create_directory()
list_directories_and_files
Enumera todos los directorios y archivos en el directorio .
list_directories_and_files(name_starts_with: str | None = None, **kwargs: Any) -> ItemPaged
Parámetros
- name_starts_with
- str
Filtra los resultados para devolver solo entidades cuyos nombres comienzan por el prefijo especificado.
Incluya este parámetro para especificar uno o varios conjuntos de datos que se van a incluir en la respuesta. Los posibles valores str son "marcas de tiempo", "Etag", "Attributes", "PermissionKey".
Novedad 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, se devolverá el identificador de archivo en los resultados enumerados.
Novedad 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 ni se valida en el cliente. Para configurar los tiempos de espera de red del lado cliente, consulte aquí.
Devoluciones
Iterable de paginación automática de DirectoryProperties y FileProperties
Tipo de valor devuelto
Ejemplos
Enumerar directorios y archivos.
# List the directories and files under the parent directory
my_list = list(parent_dir.list_directories_and_files())
print(my_list)
list_handles
Enumera los identificadores abiertos en un directorio o en un archivo en el directorio .
list_handles(recursive: bool = False, **kwargs: Any) -> ItemPaged[Handle]
Parámetros
- recursive
- bool
Boolean que especifica si la operación debe aplicarse al directorio especificado por el cliente, sus archivos, sus subdirectorios y sus archivos. El valor predeterminado es False.
- 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 de paginación automática de Handle
Tipo de valor devuelto
rename_directory
Cambie el nombre del directorio de origen.
:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes o str :keyword file_creation_time:
Hora de creación del directorio.
:p aramtype file_creation_time:~datetime.datetime o str :keyword file_last_write_time:
Hora de última escritura del archivo.
:p aramtype file_last_write_time:~datetime.datetime o str :keyword file_change_time:
Cambiar la hora del directorio. Si no se especifica, la hora de cambio se establecerá en la fecha y hora actuales.
Novedad de la versión 12.8.0: este parámetro se introdujo en la versión de API "2021-06-08".
rename_directory(new_name: str, **kwargs: Any) -> ShareDirectoryClient
Parámetros
Par nombre-valor que se va a asociar a un objeto de almacenamiento de archivos.
- destination_lease
- ShareLeaseClient o str
Necesario si el archivo de destino tiene una concesión activa. El valor puede ser un objeto ShareLeaseClient o el identificador de concesión como una cadena.
Devoluciones
Nuevo cliente de directorio.
Tipo de valor devuelto
set_directory_metadata
Establece los metadatos del directorio.
Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntados al directorio. Para quitar todos los metadatos del directorio, llame a esta operación con un dict de metadatos vacío.
set_directory_metadata(metadata: Dict[str, Any], **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
Dict de propiedad actualizada por directorio (Etag y última modificación).
Tipo de valor devuelto
set_http_headers
Establece encabezados HTTP en el directorio.
set_http_headers(file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'preserve', file_last_write_time: str | datetime | None = 'preserve', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]
Parámetros
- file_attributes
- NTFSAttributes
Atributos del sistema de archivos para archivos y directorios. Si no se establece, indica la conservación de los valores existentes. Este es un ejemplo para cuando el tipo var es str: 'Temporal|Archivo'
Hora de creación del archivo Valor predeterminado: Conservar.
Hora de última escritura del archivo Valor predeterminado: Conservar.
- file_permission
- str
Si se especifica el permiso (descriptor de seguridad) se establecerá para el directorio o archivo. Este encabezado se puede usar si el tamaño del permiso es <= 8 KB; de lo contrario, se usará el encabezado x-ms-file-permission-key. Valor predeterminado: Heredar. Si SDDL se especifica como entrada, debe tener propietario, grupo y dacl. Nota: Solo se debe especificar una de las claves x-ms-file-permission o x-ms-file-permission-key.
- permission_key
- str
Clave del permiso que se va a establecer para el directorio o archivo. Nota: Solo se debe especificar una de las claves x-ms-file-permission o x-ms-file-permission-key.
Cambiar la hora del directorio. Si no se especifica, la hora de cambio se establecerá en la fecha y hora actuales.
Novedad de la versión 12.8.0: este parámetro se introdujo en la versión de API "2021-06-08".
- 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
Dict de propiedad actualizada por archivo (Etag y última modificación).
Tipo de valor devuelto
upload_file
Crea un nuevo archivo en el directorio y devuelve shareFileClient para interactuar con el archivo.
upload_file(file_name: str, data: bytes | str | Iterable | IO, length: int | None = None, **kwargs) -> ShareFileClient
Parámetros
- data
Contenido del archivo.
- content_settings
- ContentSettings
Objeto ContentSettings usado para establecer propiedades de archivo. Se usa para establecer el tipo de contenido, la codificación, el idioma, la disposición, md5 y el control de caché.
- validate_content
- bool
Si es true, calcula un hash MD5 para cada intervalo del archivo. El servicio de almacenamiento comprueba el hash del contenido que ha llegado con el hash que se envió. Esto es principalmente útil para detectar bitflips en la conexión si el uso de http en lugar de https como https (valor predeterminado) ya se validará. Tenga en cuenta que este hash MD5 no se almacena con el archivo .
- max_concurrency
- int
Número máximo de conexiones paralelas que se van a usar.
Devolución de llamada para realizar un seguimiento del progreso de una carga de larga duración. La firma es function(current: int, total: Optional[int]) donde current es el número de bytes transferidos hasta ahora, y total es el tamaño del blob o None si se desconoce el tamaño.
- 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í.
- encoding
- str
El valor predeterminado es UTF-8.
Devoluciones
ShareFileClient
Tipo de valor devuelto
Ejemplos
Cargue un archivo en un directorio.
# Upload a file to the directory
with open(SOURCE_FILE, "rb") as source:
my_directory.upload_file(file_name="sample", data=source)
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
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
Azure SDK for Python
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de