Share via


BlobContainerCollection Class

Definition

A class representing a collection of BlobContainerResource and their operations. Each BlobContainerResource in the collection will belong to the same instance of BlobServiceResource. To get a BlobContainerCollection instance call the GetBlobContainers method from an instance of BlobServiceResource.

public class BlobContainerCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.Storage.BlobContainerResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.Storage.BlobContainerResource>
type BlobContainerCollection = class
    inherit ArmCollection
    interface seq<BlobContainerResource>
    interface IEnumerable
    interface IAsyncEnumerable<BlobContainerResource>
Public Class BlobContainerCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of BlobContainerResource), IEnumerable(Of BlobContainerResource)
Inheritance
BlobContainerCollection
Implements

Constructors

BlobContainerCollection()

Initializes a new instance of the BlobContainerCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, BlobContainerData, CancellationToken)

Creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
  • Operation Id: BlobContainers_Create
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
CreateOrUpdateAsync(WaitUntil, String, BlobContainerData, CancellationToken)

Creates a new container under the specified account as described by request body. The container resource includes metadata and properties for that container. It does not include a list of the blobs contained by the container.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
  • Operation Id: BlobContainers_Create
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
  • Operation Id: BlobContainers_Get
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
  • Operation Id: BlobContainers_Get
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
Get(String, CancellationToken)

Gets properties of a specified container.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
  • Operation Id: BlobContainers_Get
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
GetAll(Nullable<Int32>, String, Nullable<BlobContainerState>, CancellationToken)

Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers
  • Operation Id: BlobContainers_List
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
GetAll(String, String, Nullable<BlobContainerState>, CancellationToken)

Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers
  • Operation Id: BlobContainers_List
  • Default Api Version: 2022-09-01
  • Resource: BlobContainerResource
GetAllAsync(Nullable<Int32>, String, Nullable<BlobContainerState>, CancellationToken)

Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers
  • Operation Id: BlobContainers_List
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
GetAllAsync(String, String, Nullable<BlobContainerState>, CancellationToken)

Lists all containers and does not support a prefix like data plane. Also SRP today does not return continuation token.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers
  • Operation Id: BlobContainers_List
  • Default Api Version: 2022-09-01
  • Resource: BlobContainerResource
GetAsync(String, CancellationToken)

Gets properties of a specified container.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
  • Operation Id: BlobContainers_Get
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
  • Operation Id: BlobContainers_Get
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}/blobServices/default/containers/{containerName}
  • Operation Id: BlobContainers_Get
  • Default Api Version: 2023-05-01
  • Resource: BlobContainerResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<BlobContainerResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<BlobContainerResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to