FileShares interface
Interface voor bestandsshares.
Methoden
| create(string, string, string, File |
Hiermee maakt u een nieuwe share onder het opgegeven account, zoals wordt beschreven door de aanvraagbody. De shareresource bevat metagegevens en eigenschappen voor die share. Het bevat geen lijst met de bestanden die zijn opgenomen in de share. |
| delete(string, string, string, File |
Hiermee verwijdert u de opgegeven share onder het account. |
| get(string, string, string, File |
Hiermee haalt u eigenschappen van een opgegeven share op. |
| lease(string, string, string, File |
Met de leasesharebewerking wordt een vergrendeling voor een share voor verwijderingsbewerkingen vastgesteld en beheerd. De vergrendelingsduur kan 15 tot 60 seconden zijn of kan oneindig zijn. |
| list(string, string, File |
Een lijst met alle shares. |
| restore(string, string, string, Deleted |
Een bestandsshare binnen een geldige bewaarperiode herstellen als voorlopig verwijderen van delen is ingeschakeld |
| update(string, string, string, File |
Updates delen eigenschappen zoals opgegeven in de aanvraagbody. Eigenschappen die niet in de aanvraag worden vermeld, worden niet gewijzigd. Bijwerken mislukt als de opgegeven share nog niet bestaat. |
Methodedetails
create(string, string, string, FileShare, FileSharesCreateOptionalParams)
Hiermee maakt u een nieuwe share onder het opgegeven account, zoals wordt beschreven door de aanvraagbody. De shareresource bevat metagegevens en eigenschappen voor die share. Het bevat geen lijst met de bestanden die zijn opgenomen in de share.
function create(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams): Promise<FileShare>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig.
- accountName
-
string
De naam van het opslagaccount binnen de opgegeven resourcegroep. Namen van opslagaccounts mogen tussen de 3 en 24 tekens lang zijn en mogen alleen cijfers en kleine letters gebruiken.
- shareName
-
string
De naam van de bestandsshare in het opgegeven opslagaccount. Namen van bestandsshares moeten tussen 3 en 63 tekens lang zijn en mogen alleen cijfers, kleine letters en streepjes (-) bevatten. Elk streepje (-) moet direct worden voorafgegaan door een letter of cijfer.
- fileShare
- FileShare
Eigenschappen van de bestandsshare die u wilt maken.
- options
- FileSharesCreateOptionalParams
De optiesparameters.
Retouren
Promise<FileShare>
delete(string, string, string, FileSharesDeleteOptionalParams)
Hiermee verwijdert u de opgegeven share onder het account.
function delete(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig.
- accountName
-
string
De naam van het opslagaccount binnen de opgegeven resourcegroep. Namen van opslagaccounts mogen tussen de 3 en 24 tekens lang zijn en mogen alleen cijfers en kleine letters gebruiken.
- shareName
-
string
De naam van de bestandsshare in het opgegeven opslagaccount. Namen van bestandsshares moeten tussen 3 en 63 tekens lang zijn en mogen alleen cijfers, kleine letters en streepjes (-) bevatten. Elk streepje (-) moet direct worden voorafgegaan door een letter of cijfer.
- options
- FileSharesDeleteOptionalParams
De optiesparameters.
Retouren
Promise<void>
get(string, string, string, FileSharesGetOptionalParams)
Hiermee haalt u eigenschappen van een opgegeven share op.
function get(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig.
- accountName
-
string
De naam van het opslagaccount binnen de opgegeven resourcegroep. Namen van opslagaccounts mogen tussen de 3 en 24 tekens lang zijn en mogen alleen cijfers en kleine letters gebruiken.
- shareName
-
string
De naam van de bestandsshare in het opgegeven opslagaccount. Namen van bestandsshares moeten tussen 3 en 63 tekens lang zijn en mogen alleen cijfers, kleine letters en streepjes (-) bevatten. Elk streepje (-) moet direct worden voorafgegaan door een letter of cijfer.
- options
- FileSharesGetOptionalParams
De optiesparameters.
Retouren
Promise<FileShare>
lease(string, string, string, FileSharesLeaseOptionalParams)
Met de leasesharebewerking wordt een vergrendeling voor een share voor verwijderingsbewerkingen vastgesteld en beheerd. De vergrendelingsduur kan 15 tot 60 seconden zijn of kan oneindig zijn.
function lease(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams): Promise<FileSharesLeaseResponse>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig.
- accountName
-
string
De naam van het opslagaccount binnen de opgegeven resourcegroep. Namen van opslagaccounts mogen tussen de 3 en 24 tekens lang zijn en mogen alleen cijfers en kleine letters gebruiken.
- shareName
-
string
De naam van de bestandsshare in het opgegeven opslagaccount. Namen van bestandsshares moeten tussen 3 en 63 tekens lang zijn en mogen alleen cijfers, kleine letters en streepjes (-) bevatten. Elk streepje (-) moet direct worden voorafgegaan door een letter of cijfer.
- options
- FileSharesLeaseOptionalParams
De optiesparameters.
Retouren
Promise<FileSharesLeaseResponse>
list(string, string, FileSharesListOptionalParams)
Een lijst met alle shares.
function list(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams): PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig.
- accountName
-
string
De naam van het opslagaccount binnen de opgegeven resourcegroep. Namen van opslagaccounts mogen tussen de 3 en 24 tekens lang zijn en mogen alleen cijfers en kleine letters gebruiken.
- options
- FileSharesListOptionalParams
De optiesparameters.
Retouren
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)
Een bestandsshare binnen een geldige bewaarperiode herstellen als voorlopig verwijderen van delen is ingeschakeld
function restore(resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams): Promise<void>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig.
- accountName
-
string
De naam van het opslagaccount binnen de opgegeven resourcegroep. Namen van opslagaccounts mogen tussen de 3 en 24 tekens lang zijn en mogen alleen cijfers en kleine letters gebruiken.
- shareName
-
string
De naam van de bestandsshare in het opgegeven opslagaccount. Namen van bestandsshares moeten tussen 3 en 63 tekens lang zijn en mogen alleen cijfers, kleine letters en streepjes (-) bevatten. Elk streepje (-) moet direct worden voorafgegaan door een letter of cijfer.
- deletedShare
- DeletedShare
De verwijderde share die moet worden hersteld.
- options
- FileSharesRestoreOptionalParams
De optiesparameters.
Retouren
Promise<void>
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)
Updates delen eigenschappen zoals opgegeven in de aanvraagbody. Eigenschappen die niet in de aanvraag worden vermeld, worden niet gewijzigd. Bijwerken mislukt als de opgegeven share nog niet bestaat.
function update(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams): Promise<FileShare>
Parameters
- resourceGroupName
-
string
De naam van de resourcegroep binnen het abonnement van de gebruiker. De naam is niet hoofdlettergevoelig.
- accountName
-
string
De naam van het opslagaccount binnen de opgegeven resourcegroep. Namen van opslagaccounts mogen tussen de 3 en 24 tekens lang zijn en mogen alleen cijfers en kleine letters gebruiken.
- shareName
-
string
De naam van de bestandsshare in het opgegeven opslagaccount. Namen van bestandsshares moeten tussen 3 en 63 tekens lang zijn en mogen alleen cijfers, kleine letters en streepjes (-) bevatten. Elk streepje (-) moet direct worden voorafgegaan door een letter of cijfer.
- fileShare
- FileShare
Eigenschappen die moeten worden bijgewerkt voor de bestandsshare.
- options
- FileSharesUpdateOptionalParams
De optiesparameters.
Retouren
Promise<FileShare>