Container class
Class representing a Container.
Constructors
| Container(Storage |
Create a Container. |
Methods
Constructor Details
Container(StorageClientContext)
Create a Container.
new Container(client: StorageClientContext)Parameters
- client
- StorageClientContext
Reference to the service client.
Method Details
acquireLease(ContainerAcquireLeaseOptionalParams, ServiceCallback<void>)
function acquireLease(options: ContainerAcquireLeaseOptionalParams, callback: ServiceCallback<void>)Parameters
The optional parameters
- callback
-
ServiceCallback<void>
The callback
acquireLease(Models.ContainerAcquireLeaseOptionalParams)
[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
function acquireLease(options?: Models.ContainerAcquireLeaseOptionalParams)Parameters
- options
- Models.ContainerAcquireLeaseOptionalParams
Returns
Promise<Models.ContainerAcquireLeaseResponse>
Promise<Models.ContainerAcquireLeaseResponse>
acquireLease(ServiceCallback<void>)
function acquireLease(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
breakLease(ContainerBreakLeaseOptionalParams, ServiceCallback<void>)
function breakLease(options: ContainerBreakLeaseOptionalParams, callback: ServiceCallback<void>)Parameters
The optional parameters
- callback
-
ServiceCallback<void>
The callback
breakLease(Models.ContainerBreakLeaseOptionalParams)
[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
function breakLease(options?: Models.ContainerBreakLeaseOptionalParams)Parameters
- options
- Models.ContainerBreakLeaseOptionalParams
Returns
Promise<Models.ContainerBreakLeaseResponse>
Promise<Models.ContainerBreakLeaseResponse>
breakLease(ServiceCallback<void>)
function breakLease(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
changeLease(string, string, ContainerChangeLeaseOptionalParams, ServiceCallback<void>)
function changeLease(leaseId: string, proposedLeaseId: string, options: ContainerChangeLeaseOptionalParams, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- proposedLeaseId
-
string
Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
changeLease(string, string, Models.ContainerChangeLeaseOptionalParams)
[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
function changeLease(leaseId: string, proposedLeaseId: string, options?: Models.ContainerChangeLeaseOptionalParams)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- proposedLeaseId
-
string
Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats.
- options
- Models.ContainerChangeLeaseOptionalParams
Returns
Promise<Models.ContainerChangeLeaseResponse>
Promise<Models.ContainerChangeLeaseResponse>
changeLease(string, string, ServiceCallback<void>)
function changeLease(leaseId: string, proposedLeaseId: string, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- proposedLeaseId
-
string
Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats.
- callback
-
ServiceCallback<void>
The callback
create(ContainerCreateOptionalParams, ServiceCallback<void>)
function create(options: ContainerCreateOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- ContainerCreateOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
create(Models.ContainerCreateOptionalParams)
creates a new container under the specified account. If the container with the same name already exists, the operation fails
function create(options?: Models.ContainerCreateOptionalParams)Parameters
- options
- Models.ContainerCreateOptionalParams
Returns
Promise<Models.ContainerCreateResponse>
Promise<Models.ContainerCreateResponse>
create(ServiceCallback<void>)
function create(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(ContainerDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(options: ContainerDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parameters
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(Models.ContainerDeleteMethodOptionalParams)
operation marks the specified container for deletion. The container and any blobs contained within it are later deleted during garbage collection
function deleteMethod(options?: Models.ContainerDeleteMethodOptionalParams)Parameters
- options
- Models.ContainerDeleteMethodOptionalParams
Returns
Promise<Models.ContainerDeleteResponse>
Promise<Models.ContainerDeleteResponse>
deleteMethod(ServiceCallback<void>)
function deleteMethod(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
getAccessPolicy(ContainerGetAccessPolicyOptionalParams, ServiceCallback<SignedIdentifier[]>)
function getAccessPolicy(options: ContainerGetAccessPolicyOptionalParams, callback: ServiceCallback<SignedIdentifier[]>)Parameters
The optional parameters
- callback
-
ServiceCallback<SignedIdentifier[]>
The callback
getAccessPolicy(Models.ContainerGetAccessPolicyOptionalParams)
gets the permissions for the specified container. The permissions indicate whether container data may be accessed publicly.
function getAccessPolicy(options?: Models.ContainerGetAccessPolicyOptionalParams)Parameters
- options
- Models.ContainerGetAccessPolicyOptionalParams
Returns
Promise<Models.ContainerGetAccessPolicyResponse>
Promise<Models.ContainerGetAccessPolicyResponse>
getAccessPolicy(ServiceCallback<SignedIdentifier[]>)
function getAccessPolicy(callback: ServiceCallback<SignedIdentifier[]>)Parameters
- callback
-
ServiceCallback<SignedIdentifier[]>
The callback
getAccountInfo(msRest.RequestOptionsBase)
Returns the sku name and account kind
function getAccountInfo(options?: msRest.RequestOptionsBase)Parameters
- options
- msRest.RequestOptionsBase
Returns
Promise<Models.ContainerGetAccountInfoResponse>
Promise<Models.ContainerGetAccountInfoResponse>
getAccountInfo(RequestOptionsBase, ServiceCallback<void>)
function getAccountInfo(options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- options
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getAccountInfo(ServiceCallback<void>)
function getAccountInfo(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
getProperties(ContainerGetPropertiesOptionalParams, ServiceCallback<void>)
function getProperties(options: ContainerGetPropertiesOptionalParams, callback: ServiceCallback<void>)Parameters
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getProperties(Models.ContainerGetPropertiesOptionalParams)
returns all user-defined metadata and system properties for the specified container. The data returned does not include the container's list of blobs
function getProperties(options?: Models.ContainerGetPropertiesOptionalParams)Parameters
- options
- Models.ContainerGetPropertiesOptionalParams
Returns
Promise<Models.ContainerGetPropertiesResponse>
Promise<Models.ContainerGetPropertiesResponse>
getProperties(ServiceCallback<void>)
function getProperties(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
listBlobFlatSegment(ContainerListBlobFlatSegmentOptionalParams, ServiceCallback<ListBlobsFlatSegmentResponse>)
function listBlobFlatSegment(options: ContainerListBlobFlatSegmentOptionalParams, callback: ServiceCallback<ListBlobsFlatSegmentResponse>)Parameters
The optional parameters
- callback
-
ServiceCallback<ListBlobsFlatSegmentResponse>
The callback
listBlobFlatSegment(Models.ContainerListBlobFlatSegmentOptionalParams)
[Update] The List Blobs operation returns a list of the blobs under the specified container
function listBlobFlatSegment(options?: Models.ContainerListBlobFlatSegmentOptionalParams)Parameters
- options
- Models.ContainerListBlobFlatSegmentOptionalParams
Returns
Promise<Models.ContainerListBlobFlatSegmentResponse>
Promise<Models.ContainerListBlobFlatSegmentResponse>
listBlobFlatSegment(ServiceCallback<ListBlobsFlatSegmentResponse>)
function listBlobFlatSegment(callback: ServiceCallback<ListBlobsFlatSegmentResponse>)Parameters
- callback
-
ServiceCallback<ListBlobsFlatSegmentResponse>
The callback
listBlobHierarchySegment(string, ContainerListBlobHierarchySegmentOptionalParams, ServiceCallback<ListBlobsHierarchySegmentResponse>)
function listBlobHierarchySegment(delimiter: string, options: ContainerListBlobHierarchySegmentOptionalParams, callback: ServiceCallback<ListBlobsHierarchySegmentResponse>)Parameters
- delimiter
-
string
When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.
The optional parameters
- callback
-
ServiceCallback<ListBlobsHierarchySegmentResponse>
The callback
listBlobHierarchySegment(string, Models.ContainerListBlobHierarchySegmentOptionalParams)
[Update] The List Blobs operation returns a list of the blobs under the specified container
function listBlobHierarchySegment(delimiter: string, options?: Models.ContainerListBlobHierarchySegmentOptionalParams)Parameters
- delimiter
-
string
When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.
- options
- Models.ContainerListBlobHierarchySegmentOptionalParams
Returns
Promise<Models.ContainerListBlobHierarchySegmentResponse>
Promise<Models.ContainerListBlobHierarchySegmentResponse>
listBlobHierarchySegment(string, ServiceCallback<ListBlobsHierarchySegmentResponse>)
function listBlobHierarchySegment(delimiter: string, callback: ServiceCallback<ListBlobsHierarchySegmentResponse>)Parameters
- delimiter
-
string
When the request includes this parameter, the operation returns a BlobPrefix element in the response body that acts as a placeholder for all blobs whose names begin with the same substring up to the appearance of the delimiter character. The delimiter may be a single character or a string.
- callback
-
ServiceCallback<ListBlobsHierarchySegmentResponse>
The callback
releaseLease(string, ContainerReleaseLeaseOptionalParams, ServiceCallback<void>)
function releaseLease(leaseId: string, options: ContainerReleaseLeaseOptionalParams, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
releaseLease(string, Models.ContainerReleaseLeaseOptionalParams)
[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
function releaseLease(leaseId: string, options?: Models.ContainerReleaseLeaseOptionalParams)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- options
- Models.ContainerReleaseLeaseOptionalParams
Returns
Promise<Models.ContainerReleaseLeaseResponse>
Promise<Models.ContainerReleaseLeaseResponse>
releaseLease(string, ServiceCallback<void>)
function releaseLease(leaseId: string, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- callback
-
ServiceCallback<void>
The callback
renewLease(string, ContainerRenewLeaseOptionalParams, ServiceCallback<void>)
function renewLease(leaseId: string, options: ContainerRenewLeaseOptionalParams, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
renewLease(string, Models.ContainerRenewLeaseOptionalParams)
[Update] establishes and manages a lock on a container for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite
function renewLease(leaseId: string, options?: Models.ContainerRenewLeaseOptionalParams)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- options
- Models.ContainerRenewLeaseOptionalParams
Returns
Promise<Models.ContainerRenewLeaseResponse>
Promise<Models.ContainerRenewLeaseResponse>
renewLease(string, ServiceCallback<void>)
function renewLease(leaseId: string, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- callback
-
ServiceCallback<void>
The callback
setAccessPolicy(ContainerSetAccessPolicyOptionalParams, ServiceCallback<void>)
function setAccessPolicy(options: ContainerSetAccessPolicyOptionalParams, callback: ServiceCallback<void>)Parameters
The optional parameters
- callback
-
ServiceCallback<void>
The callback
setAccessPolicy(Models.ContainerSetAccessPolicyOptionalParams)
sets the permissions for the specified container. The permissions indicate whether blobs in a container may be accessed publicly.
function setAccessPolicy(options?: Models.ContainerSetAccessPolicyOptionalParams)Parameters
- options
- Models.ContainerSetAccessPolicyOptionalParams
Returns
Promise<Models.ContainerSetAccessPolicyResponse>
Promise<Models.ContainerSetAccessPolicyResponse>
setAccessPolicy(ServiceCallback<void>)
function setAccessPolicy(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
setMetadata(ContainerSetMetadataOptionalParams, ServiceCallback<void>)
function setMetadata(options: ContainerSetMetadataOptionalParams, callback: ServiceCallback<void>)Parameters
The optional parameters
- callback
-
ServiceCallback<void>
The callback
setMetadata(Models.ContainerSetMetadataOptionalParams)
operation sets one or more user-defined name-value pairs for the specified container.
function setMetadata(options?: Models.ContainerSetMetadataOptionalParams)Parameters
- options
- Models.ContainerSetMetadataOptionalParams
Returns
Promise<Models.ContainerSetMetadataResponse>
Promise<Models.ContainerSetMetadataResponse>
setMetadata(ServiceCallback<void>)
function setMetadata(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
