BlobContainers interface
Gränssnitt som representerar en BlobContainers.
Metoder
| begin |
Den här åtgärden migrerar en blobcontainer från containernivå WORM till en container som är oföränderlig på objektnivå. Krav kräver en princip för oföränderlighet på containernivå, antingen i låst eller olåst tillstånd, versionshantering på kontonivå måste aktiveras och det bör inte finnas något juridiskt undantag för containern. |
| begin |
Den här åtgärden migrerar en blobcontainer från containernivå WORM till en container som är oföränderlig på objektnivå. Krav kräver en princip för oföränderlighet på containernivå, antingen i låst eller olåst tillstånd, versionshantering på kontonivå måste aktiveras och det bör inte finnas något juridiskt undantag för containern. |
| clear |
Rensar taggar för bevarande av juridiska skäl. Om samma eller icke-befintliga tagg rensas resulterar det i en idempotent åtgärd. ClearLegalHold rensar endast de angivna taggarna i begäran. |
| create(string, string, string, Blob |
Skapar en ny container under det angivna kontot enligt beskrivningen i begärandetexten. Containerresursen innehåller metadata och egenskaper för containern. Den innehåller inte en lista över de blobar som finns i containern. |
| create |
Skapar eller uppdaterar en olåst oföränderlighetsprincip. ETag i If-Match respekteras om det anges men inte krävs för den här åtgärden. |
| delete(string, string, string, Blob |
Tar bort den angivna containern under dess konto. |
| delete |
Avbryter en olåst oföränderlighetsprincip. Svaret för borttagning har oföränderlighetPeriodSinceCreationInDays inställt på 0. ETag i If-Match krävs för den här åtgärden. Det är inte tillåtet att ta bort en låst oföränderlighetsprincip. Det enda sättet är att ta bort containern när du har tagit bort alla utgångna blobbar i den principlåsta containern. |
| extend |
Utökar oföränderlighetPeriodSinceCreationInDays för en låst oföränderlighetPolicy. Den enda åtgärd som tillåts för en låst princip är den här åtgärden. ETag i If-Match krävs för den här åtgärden. |
| get(string, string, string, Blob |
Hämtar egenskaper för en angiven container. |
| get |
Hämtar den befintliga oföränderlighetsprincipen tillsammans med motsvarande ETag i svarshuvuden och brödtext. |
| lease(string, string, string, Blob |
Åtgärden Lease Container etablerar och hanterar ett lås på en container för borttagningsåtgärder. Låsvaraktigheten kan vara mellan 15 och 60 sekunder, eller så kan den vara oändlig. |
| list(string, string, Blob |
Visar en lista över alla containrar och stöder inte ett prefix som dataplanet. Även SRP idag returnerar inte fortsättningstoken. |
| lock |
Anger ImmutabilityPolicy till Låst tillstånd. Den enda åtgärd som tillåts för en låst princip är Åtgärden ExtendImmutabilityPolicy. ETag i If-Match krävs för den här åtgärden. |
| set |
Anger taggar för bevarande av juridiska skäl. Om du anger samma tagg resulterar det i en idempotent-åtgärd. SetLegalHold följer ett tilläggsmönster och rensar inte bort befintliga taggar som inte anges i begäran. |
| update(string, string, string, Blob |
Uppdaterar containeregenskaperna enligt beskrivningen i begärandetexten. Egenskaper som inte anges i begäran ändras inte. Uppdateringen misslyckas om den angivna containern inte redan finns. |
Metodinformation
beginObjectLevelWorm(string, string, string, BlobContainersObjectLevelWormOptionalParams)
Den här åtgärden migrerar en blobcontainer från containernivå WORM till en container som är oföränderlig på objektnivå. Krav kräver en princip för oföränderlighet på containernivå, antingen i låst eller olåst tillstånd, versionshantering på kontonivå måste aktiveras och det bör inte finnas något juridiskt undantag för containern.
function beginObjectLevelWorm(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
Alternativparametrarna.
Returer
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginObjectLevelWormAndWait(string, string, string, BlobContainersObjectLevelWormOptionalParams)
Den här åtgärden migrerar en blobcontainer från containernivå WORM till en container som är oföränderlig på objektnivå. Krav kräver en princip för oföränderlighet på containernivå, antingen i låst eller olåst tillstånd, versionshantering på kontonivå måste aktiveras och det bör inte finnas något juridiskt undantag för containern.
function beginObjectLevelWormAndWait(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersObjectLevelWormOptionalParams): Promise<void>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
Alternativparametrarna.
Returer
Promise<void>
clearLegalHold(string, string, string, LegalHold, BlobContainersClearLegalHoldOptionalParams)
Rensar taggar för bevarande av juridiska skäl. Om samma eller icke-befintliga tagg rensas resulterar det i en idempotent åtgärd. ClearLegalHold rensar endast de angivna taggarna i begäran.
function clearLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersClearLegalHoldOptionalParams): Promise<LegalHold>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
- legalHold
- LegalHold
Egenskapen LegalHold som ska rensas från en blobcontainer.
Alternativparametrarna.
Returer
Promise<LegalHold>
create(string, string, string, BlobContainer, BlobContainersCreateOptionalParams)
Skapar en ny container under det angivna kontot enligt beskrivningen i begärandetexten. Containerresursen innehåller metadata och egenskaper för containern. Den innehåller inte en lista över de blobar som finns i containern.
function create(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersCreateOptionalParams): Promise<BlobContainer>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
- blobContainer
- BlobContainer
Egenskaper för blobcontainern som ska skapas.
Alternativparametrarna.
Returer
Promise<BlobContainer>
createOrUpdateImmutabilityPolicy(string, string, string, BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams)
Skapar eller uppdaterar en olåst oföränderlighetsprincip. ETag i If-Match respekteras om det anges men inte krävs för den här åtgärden.
function createOrUpdateImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersCreateOrUpdateImmutabilityPolicyOptionalParams): Promise<BlobContainersCreateOrUpdateImmutabilityPolicyResponse>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
Alternativparametrarna.
Returer
delete(string, string, string, BlobContainersDeleteOptionalParams)
Tar bort den angivna containern under dess konto.
function delete(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersDeleteOptionalParams): Promise<void>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
Alternativparametrarna.
Returer
Promise<void>
deleteImmutabilityPolicy(string, string, string, string, BlobContainersDeleteImmutabilityPolicyOptionalParams)
Avbryter en olåst oföränderlighetsprincip. Svaret för borttagning har oföränderlighetPeriodSinceCreationInDays inställt på 0. ETag i If-Match krävs för den här åtgärden. Det är inte tillåtet att ta bort en låst oföränderlighetsprincip. Det enda sättet är att ta bort containern när du har tagit bort alla utgångna blobbar i den principlåsta containern.
function deleteImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersDeleteImmutabilityPolicyOptionalParams): Promise<BlobContainersDeleteImmutabilityPolicyResponse>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
- ifMatch
-
string
Entitetstillståndsversionen (ETag) av den oföränderlighetsprincip som ska uppdateras måste returneras till servern för alla uppdateringsåtgärder. ETag-värdet måste innehålla inledande och avslutande dubbla citattecken som returneras av tjänsten.
Alternativparametrarna.
Returer
extendImmutabilityPolicy(string, string, string, string, BlobContainersExtendImmutabilityPolicyOptionalParams)
Utökar oföränderlighetPeriodSinceCreationInDays för en låst oföränderlighetPolicy. Den enda åtgärd som tillåts för en låst princip är den här åtgärden. ETag i If-Match krävs för den här åtgärden.
function extendImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersExtendImmutabilityPolicyOptionalParams): Promise<BlobContainersExtendImmutabilityPolicyResponse>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
- ifMatch
-
string
Entitetstillståndsversionen (ETag) av den oföränderlighetsprincip som ska uppdateras måste returneras till servern för alla uppdateringsåtgärder. ETag-värdet måste innehålla inledande och avslutande dubbla citattecken som returneras av tjänsten.
Alternativparametrarna.
Returer
get(string, string, string, BlobContainersGetOptionalParams)
Hämtar egenskaper för en angiven container.
function get(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetOptionalParams): Promise<BlobContainer>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
- options
- BlobContainersGetOptionalParams
Alternativparametrarna.
Returer
Promise<BlobContainer>
getImmutabilityPolicy(string, string, string, BlobContainersGetImmutabilityPolicyOptionalParams)
Hämtar den befintliga oföränderlighetsprincipen tillsammans med motsvarande ETag i svarshuvuden och brödtext.
function getImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersGetImmutabilityPolicyOptionalParams): Promise<BlobContainersGetImmutabilityPolicyResponse>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
Alternativparametrarna.
Returer
lease(string, string, string, BlobContainersLeaseOptionalParams)
Åtgärden Lease Container etablerar och hanterar ett lås på en container för borttagningsåtgärder. Låsvaraktigheten kan vara mellan 15 och 60 sekunder, eller så kan den vara oändlig.
function lease(resourceGroupName: string, accountName: string, containerName: string, options?: BlobContainersLeaseOptionalParams): Promise<LeaseContainerResponse>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
Alternativparametrarna.
Returer
Promise<LeaseContainerResponse>
list(string, string, BlobContainersListOptionalParams)
Visar en lista över alla containrar och stöder inte ett prefix som dataplanet. Även SRP idag returnerar inte fortsättningstoken.
function list(resourceGroupName: string, accountName: string, options?: BlobContainersListOptionalParams): PagedAsyncIterableIterator<ListContainerItem, ListContainerItem[], PageSettings>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- options
- BlobContainersListOptionalParams
Alternativparametrarna.
Returer
lockImmutabilityPolicy(string, string, string, string, BlobContainersLockImmutabilityPolicyOptionalParams)
Anger ImmutabilityPolicy till Låst tillstånd. Den enda åtgärd som tillåts för en låst princip är Åtgärden ExtendImmutabilityPolicy. ETag i If-Match krävs för den här åtgärden.
function lockImmutabilityPolicy(resourceGroupName: string, accountName: string, containerName: string, ifMatch: string, options?: BlobContainersLockImmutabilityPolicyOptionalParams): Promise<BlobContainersLockImmutabilityPolicyResponse>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
- ifMatch
-
string
Entitetstillståndsversionen (ETag) av den oföränderlighetsprincip som ska uppdateras måste returneras till servern för alla uppdateringsåtgärder. ETag-värdet måste innehålla inledande och avslutande dubbla citattecken som returneras av tjänsten.
Alternativparametrarna.
Returer
setLegalHold(string, string, string, LegalHold, BlobContainersSetLegalHoldOptionalParams)
Anger taggar för bevarande av juridiska skäl. Om du anger samma tagg resulterar det i en idempotent-åtgärd. SetLegalHold följer ett tilläggsmönster och rensar inte bort befintliga taggar som inte anges i begäran.
function setLegalHold(resourceGroupName: string, accountName: string, containerName: string, legalHold: LegalHold, options?: BlobContainersSetLegalHoldOptionalParams): Promise<LegalHold>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
- legalHold
- LegalHold
Egenskapen LegalHold som ska anges till en blobcontainer.
Alternativparametrarna.
Returer
Promise<LegalHold>
update(string, string, string, BlobContainer, BlobContainersUpdateOptionalParams)
Uppdaterar containeregenskaperna enligt beskrivningen i begärandetexten. Egenskaper som inte anges i begäran ändras inte. Uppdateringen misslyckas om den angivna containern inte redan finns.
function update(resourceGroupName: string, accountName: string, containerName: string, blobContainer: BlobContainer, options?: BlobContainersUpdateOptionalParams): Promise<BlobContainer>
Parametrar
- resourceGroupName
-
string
Namnet på resursgruppen i användarens prenumeration. Namnet är skiftlägesokänsligt.
- accountName
-
string
Namnet på lagringskontot i den angivna resursgruppen. Lagringskontonamn måste vara mellan 3 och 24 tecken långa och endast använda siffror och gemener.
- containerName
-
string
Namnet på blobcontainern i det angivna lagringskontot. Blobcontainernamn måste vara mellan 3 och 63 tecken långa och endast använda siffror, gemener och bindestreck (-). Varje bindestreck (-) tecken måste omedelbart föregås och följas av en bokstav eller siffra.
- blobContainer
- BlobContainer
Egenskaper som ska uppdateras för blobcontainern.
Alternativparametrarna.
Returer
Promise<BlobContainer>