azure-docs-sdk-java/legacy/docs-ref-autogen/com.microsoft.azure.managem...

259 строки
25 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.management.storage.BlobContainers"
fullName: "com.microsoft.azure.management.storage.BlobContainers"
name: "BlobContainers"
nameWithType: "BlobContainers"
summary: "Type representing Blob<wbr>Containers."
syntax: "public interface **BlobContainers**"
methods:
- uid: "com.microsoft.azure.management.storage.BlobContainers.clearLegalHoldAsync(java.lang.String,java.lang.String,java.lang.String,java.util.List<java.lang.String>)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.clearLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags)"
name: "clearLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags)"
nameWithType: "BlobContainers.clearLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags)"
summary: "Clears legal hold tags."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case insensitive."
name: "resourceGroupName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number."
name: "containerName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP."
name: "tags"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public abstract Observable<LegalHold> clearLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags)"
desc: "Clears legal hold tags. Clearing the same or non-existent tag results in an idempotent operation. ClearLegalHold clears out only the specified tags in the request."
returns:
description: "the observable for the request"
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.storage.LegalHold?alt=com.microsoft.azure.management.storage.LegalHold&text=LegalHold\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.storage.BlobContainers.defineContainer(java.lang.String)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.defineContainer(String name)"
name: "defineContainer(String name)"
nameWithType: "BlobContainers.defineContainer(String name)"
summary: "Begins definition for a new Container resource."
modifiers:
- "abstract"
parameters:
- description: "resource name."
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract BlobContainer.DefinitionStages.Blank defineContainer(String name)"
desc: "Begins definition for a new Container resource."
returns:
description: "the first stage of the new Container definition."
type: "<xref href=\"com.microsoft.azure.management.storage.BlobContainer.DefinitionStages.Blank?alt=com.microsoft.azure.management.storage.BlobContainer.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.storage.BlobContainers.defineImmutabilityPolicy(java.lang.String)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.defineImmutabilityPolicy(String name)"
name: "defineImmutabilityPolicy(String name)"
nameWithType: "BlobContainers.defineImmutabilityPolicy(String name)"
summary: "Begins definition for a new Immutability<wbr>Policy resource."
modifiers:
- "abstract"
parameters:
- description: "resource name."
name: "name"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract ImmutabilityPolicy.DefinitionStages.Blank defineImmutabilityPolicy(String name)"
desc: "Begins definition for a new ImmutabilityPolicy resource."
returns:
description: "the first stage of the new ImmutabilityPolicy definition."
type: "<xref href=\"com.microsoft.azure.management.storage.ImmutabilityPolicy.DefinitionStages.Blank?alt=com.microsoft.azure.management.storage.ImmutabilityPolicy.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.storage.BlobContainers.deleteAsync(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.deleteAsync(String resourceGroupName, String accountName, String containerName)"
name: "deleteAsync(String resourceGroupName, String accountName, String containerName)"
nameWithType: "BlobContainers.deleteAsync(String resourceGroupName, String accountName, String containerName)"
summary: "Deletes specified container under its account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case insensitive."
name: "resourceGroupName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number."
name: "containerName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Completable deleteAsync(String resourceGroupName, String accountName, String containerName)"
desc: "Deletes specified container under its account."
returns:
description: "the observable for the request"
type: "<xref href=\"rx.Completable?alt=rx.Completable&text=Completable\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.storage.BlobContainers.deleteImmutabilityPolicyAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.deleteImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch)"
name: "deleteImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch)"
nameWithType: "BlobContainers.deleteImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch)"
summary: "Aborts an unlocked immutability policy."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case insensitive."
name: "resourceGroupName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number."
name: "containerName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied."
name: "ifMatch"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Completable deleteImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch)"
desc: "Aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, only way is to delete the container after deleting all blobs inside the container."
returns:
description: "the observable for the request"
type: "<xref href=\"rx.Completable?alt=rx.Completable&text=Completable\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.storage.BlobContainers.extendImmutabilityPolicyAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String,int)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.extendImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch, int immutabilityPeriodSinceCreationInDays)"
name: "extendImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch, int immutabilityPeriodSinceCreationInDays)"
nameWithType: "BlobContainers.extendImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch, int immutabilityPeriodSinceCreationInDays)"
summary: "Extends the immutability<wbr>Period<wbr>Since<wbr>Creation<wbr>InDays of a locked immutability<wbr>Policy."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case insensitive."
name: "resourceGroupName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number."
name: "containerName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied."
name: "ifMatch"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The immutability period for the blobs in the container since the policy creation, in days."
name: "immutabilityPeriodSinceCreationInDays"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Observable<ImmutabilityPolicy> extendImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch, int immutabilityPeriodSinceCreationInDays)"
desc: "Extends the immutabilityPeriodSinceCreationInDays of a locked immutabilityPolicy. The only action allowed on a Locked policy will be this action. ETag in If-Match is required for this operation."
returns:
description: "the observable for the request"
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.storage.ImmutabilityPolicy?alt=com.microsoft.azure.management.storage.ImmutabilityPolicy&text=ImmutabilityPolicy\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.storage.BlobContainers.getAsync(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.getAsync(String resourceGroupName, String accountName, String containerName)"
name: "getAsync(String resourceGroupName, String accountName, String containerName)"
nameWithType: "BlobContainers.getAsync(String resourceGroupName, String accountName, String containerName)"
summary: "Gets properties of a specified container."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case insensitive."
name: "resourceGroupName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number."
name: "containerName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Observable<BlobContainer> getAsync(String resourceGroupName, String accountName, String containerName)"
desc: "Gets properties of a specified container."
returns:
description: "the observable for the request"
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.storage.BlobContainer?alt=com.microsoft.azure.management.storage.BlobContainer&text=BlobContainer\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.storage.BlobContainers.getImmutabilityPolicyAsync(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.getImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName)"
name: "getImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName)"
nameWithType: "BlobContainers.getImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName)"
summary: "Gets the existing immutability policy along with the corresponding ETag in response headers and body."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case insensitive."
name: "resourceGroupName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number."
name: "containerName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Observable<ImmutabilityPolicy> getImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName)"
desc: "Gets the existing immutability policy along with the corresponding ETag in response headers and body."
returns:
description: "the observable for the request"
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.storage.ImmutabilityPolicy?alt=com.microsoft.azure.management.storage.ImmutabilityPolicy&text=ImmutabilityPolicy\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.storage.BlobContainers.listAsync(java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.listAsync(String resourceGroupName, String accountName)"
name: "listAsync(String resourceGroupName, String accountName)"
nameWithType: "BlobContainers.listAsync(String resourceGroupName, String accountName)"
summary: "Lists all containers and does not support a prefix like data plane."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case insensitive."
name: "resourceGroupName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Observable<ListContainerItem> listAsync(String resourceGroupName, String accountName)"
desc: "Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token."
returns:
description: "the observable for the request"
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.storage.ListContainerItem?alt=com.microsoft.azure.management.storage.ListContainerItem&text=ListContainerItem\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.storage.BlobContainers.lockImmutabilityPolicyAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.lockImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch)"
name: "lockImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch)"
nameWithType: "BlobContainers.lockImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch)"
summary: "Sets the Immutability<wbr>Policy to Locked state."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case insensitive."
name: "resourceGroupName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number."
name: "containerName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The entity state (ETag) version of the immutability policy to update. A value of \"*\" can be used to apply the operation only if the immutability policy already exists. If omitted, this operation will always be applied."
name: "ifMatch"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Observable<ImmutabilityPolicy> lockImmutabilityPolicyAsync(String resourceGroupName, String accountName, String containerName, String ifMatch)"
desc: "Sets the ImmutabilityPolicy to Locked state. The only action allowed on a Locked policy is ExtendImmutabilityPolicy action. ETag in If-Match is required for this operation."
returns:
description: "the observable for the request"
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.storage.ImmutabilityPolicy?alt=com.microsoft.azure.management.storage.ImmutabilityPolicy&text=ImmutabilityPolicy\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.storage.BlobContainers.setLegalHoldAsync(java.lang.String,java.lang.String,java.lang.String,java.util.List<java.lang.String>)"
fullName: "com.microsoft.azure.management.storage.BlobContainers.setLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags)"
name: "setLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags)"
nameWithType: "BlobContainers.setLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags)"
summary: "Sets legal hold tags."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case insensitive."
name: "resourceGroupName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "The name of the blob container within the specified storage account. Blob container names must be between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-) character must be immediately preceded and followed by a letter or number."
name: "containerName"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- description: "Each tag should be 3 to 23 alphanumeric characters and is normalized to lower case at SRP."
name: "tags"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public abstract Observable<LegalHold> setLegalHoldAsync(String resourceGroupName, String accountName, String containerName, List<String> tags)"
desc: "Sets legal hold tags. Setting the same tag results in an idempotent operation. SetLegalHold follows an append pattern and does not clear out the existing tags that are not specified in the request."
returns:
description: "the observable for the request"
type: "<xref href=\"rx.Observable?alt=rx.Observable&text=Observable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.storage.LegalHold?alt=com.microsoft.azure.management.storage.LegalHold&text=LegalHold\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Type representing BlobContainers."
metadata: {}
package: "com.microsoft.azure.management.storage"
artifact: com.microsoft.azure:azure-mgmt-storage:1.41.4