FileShares interface
Interface représentant un FileShares.
Méthodes
| create(string, string, string, File |
Crée un nouveau partage sous le compte spécifié, comme décrit par le corps de la demande. La ressource de partage inclut des métadonnées et propriétés pour ce partage. Elle ne comprend pas la liste des fichiers contenus dans le partage. |
| delete(string, string, string, File |
Supprime le partage spécifié sous son compte. |
| get(string, string, string, File |
Obtient les propriétés d’un partage spécifié. |
| lease(string, string, string, File |
L’opération Lease Share établit et gère un verrou sur un partage pour les opérations de suppression. La durée du verrou peut être de 15 à 60 secondes, ou peut être infinie. |
| list(string, string, File |
Répertorie tous les partages. |
| restore(string, string, string, Deleted |
Restaurer un partage de fichiers dans un délai de conservation valide si la suppression réversible de partage est activée |
| update(string, string, string, File |
Mises à jour les propriétés de partage comme spécifié dans le corps de la requête. Les propriétés non mentionnées dans la demande ne seront pas modifiées. La mise à jour échoue si le partage spécifié n’existe pas déjà. |
Détails de la méthode
create(string, string, string, FileShare, FileSharesCreateOptionalParams)
Crée un nouveau partage sous le compte spécifié, comme décrit par le corps de la demande. La ressource de partage inclut des métadonnées et propriétés pour ce partage. Elle ne comprend pas la liste des fichiers contenus dans le partage.
function create(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams): Promise<FileShare>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.
- shareName
-
string
Nom du partage de fichiers dans le compte de stockage spécifié. Les noms de partages de fichiers doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.
- fileShare
- FileShare
Propriétés du partage de fichiers à créer.
- options
- FileSharesCreateOptionalParams
Paramètres d’options.
Retours
Promise<FileShare>
delete(string, string, string, FileSharesDeleteOptionalParams)
Supprime le partage spécifié sous son compte.
function delete(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.
- shareName
-
string
Nom du partage de fichiers dans le compte de stockage spécifié. Les noms de partages de fichiers doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.
- options
- FileSharesDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, FileSharesGetOptionalParams)
Obtient les propriétés d’un partage spécifié.
function get(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.
- shareName
-
string
Nom du partage de fichiers dans le compte de stockage spécifié. Les noms de partages de fichiers doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.
- options
- FileSharesGetOptionalParams
Paramètres d’options.
Retours
Promise<FileShare>
lease(string, string, string, FileSharesLeaseOptionalParams)
L’opération Lease Share établit et gère un verrou sur un partage pour les opérations de suppression. La durée du verrou peut être de 15 à 60 secondes, ou peut être infinie.
function lease(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams): Promise<FileSharesLeaseResponse>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.
- shareName
-
string
Nom du partage de fichiers dans le compte de stockage spécifié. Les noms de partages de fichiers doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.
- options
- FileSharesLeaseOptionalParams
Paramètres d’options.
Retours
Promise<FileSharesLeaseResponse>
list(string, string, FileSharesListOptionalParams)
Répertorie tous les partages.
function list(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams): PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.
- options
- FileSharesListOptionalParams
Paramètres d’options.
Retours
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)
Restaurer un partage de fichiers dans un délai de conservation valide si la suppression réversible de partage est activée
function restore(resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.
- shareName
-
string
Nom du partage de fichiers dans le compte de stockage spécifié. Les noms de partages de fichiers doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.
- deletedShare
- DeletedShare
Partage supprimé à restaurer.
- options
- FileSharesRestoreOptionalParams
Paramètres d’options.
Retours
Promise<void>
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)
Mises à jour les propriétés de partage comme spécifié dans le corps de la requête. Les propriétés non mentionnées dans la demande ne seront pas modifiées. La mise à jour échoue si le partage spécifié n’existe pas déjà.
function update(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams): Promise<FileShare>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources dans l’abonnement de l’utilisateur. Le nom ne respecte pas la casse.
- accountName
-
string
Nom du compte de stockage au sein du groupe de ressources spécifié. Ce nom doit comprendre entre 3 et 24 caractères, uniquement des lettres en minuscules et des nombres.
- shareName
-
string
Nom du partage de fichiers dans le compte de stockage spécifié. Les noms de partages de fichiers doivent comporter entre 3 et 63 caractères et utiliser des nombres, des minuscules et des tirets (-) uniquement. Chaque tiret (-) doit être immédiatement précédé et suivi d'une lettre ou d'un chiffre.
- fileShare
- FileShare
Propriétés à mettre à jour pour le partage de fichiers.
- options
- FileSharesUpdateOptionalParams
Paramètres d’options.
Retours
Promise<FileShare>