Partager via


FileSharedAccessSignature Classe

Fournit une fabrique pour la création de jetons de signature de fichier et de partage d’accès avec un nom de compte et une clé de compte communs. Les utilisateurs peuvent utiliser la fabrique ou construire le service approprié et utiliser directement la méthode generate_*_shared_access_signature.

Héritage
FileSharedAccessSignature

Constructeur

FileSharedAccessSignature(account_name, account_key)

Paramètres

Nom Description
account_name
Obligatoire
str

Nom du compte de stockage utilisé pour générer les signatures d’accès partagé.

account_key
Obligatoire
str

Clé d’accès pour générer les signatures d’accès aux partages.

Méthodes

generate_account

Génère une signature d’accès partagé pour le compte. Utilisez la signature retournée avec le paramètre sas_token du service ou pour créer un objet de compte.

generate_file

Génère une signature d’accès partagé pour le fichier. Utilisez la signature retournée avec le paramètre sas_token de FileService.

generate_share

Génère une signature d’accès partagé pour le partage. Utilisez la signature retournée avec le paramètre sas_token de FileService.

generate_account

Génère une signature d’accès partagé pour le compte. Utilisez la signature retournée avec le paramètre sas_token du service ou pour créer un objet de compte.

generate_account(services, resource_types, permission, expiry, start=None, ip=None, protocol=None)

Paramètres

Nom Description
services
Obligatoire
<xref:Services>

Spécifie les services accessibles avec la sap du compte. Vous pouvez combiner des valeurs pour fournir l’accès à plusieurs services.

resource_types
Obligatoire
<xref:ResourceTypes>

Spécifie les types de ressources accessibles avec la sap du compte. Vous pouvez combiner des valeurs pour fournir l’accès à plusieurs types de ressources.

permission
Obligatoire
<xref:AccountPermissions>

Autorisations associées à la signature d'accès partagé. L'utilisateur est limité aux opérations autorisées par les autorisations. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée. Vous pouvez combiner des valeurs pour fournir plusieurs autorisations.

expiry
Obligatoire

Heure à laquelle la signature d’accès partagé devient non valide. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée. Azure convertit toujours les valeurs en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC.

start

Heure à laquelle la signature d’accès partagé devient valide. En cas d'omission, l'heure de début de cet appel est supposée être l'heure à laquelle le service de stockage reçoit la demande. Azure convertit toujours les valeurs en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC.

valeur par défaut: None
ip
str

Spécifie une adresse IP ou une plage d’adresses IP à partir de laquelle accepter les demandes. Si l’adresse IP d’où provient la demande ne correspond pas à l’adresse IP ou à la plage d’adresses spécifiée sur le jeton SAP, la demande n’est pas authentifiée. Par exemple, la spécification de sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la sap limite la demande à ces adresses IP.

valeur par défaut: None
protocol
str

Spécifie le protocole autorisé pour une requête effectuée. La valeur par défaut est https,http. Pour les valeurs possibles, consultez Protocol.

valeur par défaut: None

generate_file

Génère une signature d’accès partagé pour le fichier. Utilisez la signature retournée avec le paramètre sas_token de FileService.

generate_file(share_name, directory_name=None, file_name=None, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Paramètres

Nom Description
share_name
Obligatoire
str

Nom du partage.

directory_name
str

Nom du répertoire. Les jetons SAP ne pouvant pas être créés pour les répertoires, ce paramètre ne doit être présent que si file_name est fourni.

valeur par défaut: None
file_name
str

Nom du fichier.

valeur par défaut: None
permission

Autorisations associées à la signature d'accès partagé. L'utilisateur est limité aux opérations autorisées par les autorisations. Les autorisations doivent être triées en lecture, création, écriture, suppression, liste. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée.

valeur par défaut: None
expiry

Heure à laquelle la signature d’accès partagé devient non valide. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée. Azure convertit toujours les valeurs en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC.

valeur par défaut: None
start

Heure à laquelle la signature d’accès partagé devient valide. En cas d'omission, l'heure de début de cet appel est supposée être l'heure à laquelle le service de stockage reçoit la demande. Azure convertit toujours les valeurs en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC.

valeur par défaut: None
id
str

Valeur unique d’une longueur maximale de 64 caractères qui correspond à une stratégie d’accès stockée. Pour créer une stratégie d’accès stockée, utilisez set_file_service_properties.

valeur par défaut: None
ip
str

Spécifie une adresse IP ou une plage d’adresses IP à partir de laquelle accepter les demandes. Si l’adresse IP d’où provient la demande ne correspond pas à l’adresse IP ou à la plage d’adresses spécifiée sur le jeton SAP, la demande n’est pas authentifiée. Par exemple, la spécification de sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la sap limite la demande à ces adresses IP.

valeur par défaut: None
protocol
str

Spécifie le protocole autorisé pour une requête effectuée. La valeur par défaut est https,http. Pour les valeurs possibles, consultez Protocol.

valeur par défaut: None
cache_control
str

Valeur d’en-tête de réponse pour Cache-Control lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None
content_disposition
str

Valeur d’en-tête de réponse pour Content-Disposition lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None
content_encoding
str

Valeur d’en-tête de réponse pour Content-Encoding lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None
content_language
str

Valeur d’en-tête de réponse pour Content-Language lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None
content_type
str

Valeur d’en-tête de réponse pour Content-Type lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None

generate_share

Génère une signature d’accès partagé pour le partage. Utilisez la signature retournée avec le paramètre sas_token de FileService.

generate_share(share_name, permission=None, expiry=None, start=None, id=None, ip=None, protocol=None, cache_control=None, content_disposition=None, content_encoding=None, content_language=None, content_type=None)

Paramètres

Nom Description
share_name
Obligatoire
str

Nom du partage.

permission

Autorisations associées à la signature d'accès partagé. L'utilisateur est limité aux opérations autorisées par les autorisations. Les autorisations doivent être triées en lecture, création, écriture, suppression, liste. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée.

valeur par défaut: None
expiry

Heure à laquelle la signature d’accès partagé devient non valide. Obligatoire, sauf si un ID fait référence à une stratégie d’accès stockée qui contient ce champ. Ce champ doit être omis s'il a été spécifié dans une stratégie d'accès stockée associée. Azure convertit toujours les valeurs en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC.

valeur par défaut: None
start

Heure à laquelle la signature d’accès partagé devient valide. En cas d'omission, l'heure de début de cet appel est supposée être l'heure à laquelle le service de stockage reçoit la demande. Azure convertit toujours les valeurs en UTC. Si une date est transmise sans informations de fuseau horaire, elle est supposée être UTC.

valeur par défaut: None
id
str

Valeur unique d’une longueur maximale de 64 caractères qui correspond à une stratégie d’accès stockée. Pour créer une stratégie d’accès stockée, utilisez set_file_service_properties.

valeur par défaut: None
ip
str

Spécifie une adresse IP ou une plage d’adresses IP à partir de laquelle accepter les demandes. Si l’adresse IP d’où provient la demande ne correspond pas à l’adresse IP ou à la plage d’adresses spécifiée sur le jeton SAP, la demande n’est pas authentifiée. Par exemple, la spécification de sip=168.1.5.65 ou sip=168.1.5.60-168.1.5.70 sur la sap limite la demande à ces adresses IP.

valeur par défaut: None
protocol
str

Spécifie le protocole autorisé pour une requête effectuée. La valeur par défaut est https,http. Pour les valeurs possibles, consultez Protocol.

valeur par défaut: None
cache_control
str

Valeur d’en-tête de réponse pour Cache-Control lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None
content_disposition
str

Valeur d’en-tête de réponse pour Content-Disposition lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None
content_encoding
str

Valeur d’en-tête de réponse pour Content-Encoding lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None
content_language
str

Valeur d’en-tête de réponse pour Content-Language lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None
content_type
str

Valeur d’en-tête de réponse pour Content-Type lorsque la ressource est accessible à l’aide de cette signature d’accès partagé.

valeur par défaut: None