ICosmosDBAccounts Interface

Definition

Entry point to Cosmos DB management API.

public interface ICosmosDBAccounts : Microsoft.Azure.Management.ResourceManager.Fluent.Core.CollectionActions.ISupportsBatchCreation<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBAccount>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.CollectionActions.ISupportsCreating<Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IBlank>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.CollectionActions.ISupportsDeletingById, Microsoft.Azure.Management.ResourceManager.Fluent.Core.CollectionActions.ISupportsDeletingByResourceGroup, Microsoft.Azure.Management.ResourceManager.Fluent.Core.CollectionActions.ISupportsGettingById<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBAccount>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.CollectionActions.ISupportsGettingByResourceGroup<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBAccount>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.CollectionActions.ISupportsListing<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBAccount>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.CollectionActions.ISupportsListingByResourceGroup<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBAccount>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasInner<Microsoft.Azure.Management.CosmosDB.Fluent.IDatabaseAccountsOperations>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IHasManager<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBManager>
type ICosmosDBAccounts = interface
    interface IBeta
    interface ISupportsCreating<IBlank>
    interface IHasManager<ICosmosDBManager>
    interface IHasInner<IDatabaseAccountsOperations>
    interface ISupportsBatchCreation<ICosmosDBAccount>
    interface ISupportsGettingById<ICosmosDBAccount>
    interface ISupportsDeletingById
    interface ISupportsDeletingByResourceGroup
    interface ISupportsListing<ICosmosDBAccount>
    interface ISupportsListingByResourceGroup<ICosmosDBAccount>
    interface ISupportsGettingByResourceGroup<ICosmosDBAccount>
Public Interface ICosmosDBAccounts
Implements IBeta, IHasInner(Of IDatabaseAccountsOperations), IHasManager(Of ICosmosDBManager), ISupportsBatchCreation(Of ICosmosDBAccount), ISupportsCreating(Of IBlank), ISupportsDeletingById, ISupportsDeletingByResourceGroup, ISupportsGettingById(Of ICosmosDBAccount), ISupportsGettingByResourceGroup(Of ICosmosDBAccount), ISupportsListing(Of ICosmosDBAccount), ISupportsListingByResourceGroup(Of ICosmosDBAccount)
Derived
Implements

Remarks

(Beta: This functionality is in preview and as such is subject to change in non-backwards compatible ways in future releases, including removal, regardless of any compatibility expectations set by the containing library version number.).

Properties

Inner (Inherited from IHasInner<T>)
Manager

Gets the manager client type of this resource type.

(Inherited from IHasManager<ManagerT>)

Methods

Create(ICreatable<IFluentResourceT>[])

Creates a set (batch) of resources.

(Inherited from ISupportsBatchCreation<IFluentResourceT>)
Create(IEnumerable<ICreatable<IFluentResourceT>>)

Creates a set (batch) of resources.

(Inherited from ISupportsBatchCreation<IFluentResourceT>)
CreateAsync(IEnumerable<ICreatable<IFluentResourceT>>, CancellationToken)

Creates a set (batch) of resources.

(Inherited from ISupportsBatchCreation<IFluentResourceT>)
Define(String) (Inherited from ISupportsCreating<T>)
DeleteById(String)

Deletes a resource from Azure, identifying it by its resource ID.

(Inherited from ISupportsDeletingById)
DeleteByIdAsync(String, CancellationToken)

Deletes a resource from Azure, identifying it by its resource ID.

(Inherited from ISupportsDeletingById)
DeleteByResourceGroup(String, String)

Deletes a resource from Azure, identifying it by its name and its resource group.

(Inherited from ISupportsDeletingByResourceGroup)
DeleteByResourceGroupAsync(String, String, CancellationToken)

Deletes a resource from Azure, identifying it by its name and its resource group.

(Inherited from ISupportsDeletingByResourceGroup)
FailoverPriorityChange(String, String, IList<Location>)

Changes the failover priority for the Azure CosmosDB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

FailoverPriorityChangeAsync(String, String, IList<Location>, CancellationToken)

Changes the failover priority for the Azure CosmosDB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.

GetById(String)

Gets the information about a resource from Azure based on the resource id.

(Inherited from ISupportsGettingById<T>)
GetByIdAsync(String, CancellationToken)

Gets the information about a resource from Azure based on the resource id.

(Inherited from ISupportsGettingById<T>)
GetByResourceGroup(String, String)

Gets the information about a resource from Azure based on the resource name and the name of its resource group.

(Inherited from ISupportsGettingByResourceGroup<T>)
GetByResourceGroupAsync(String, String, CancellationToken)

Gets the information about a resource from Azure based on the resource name and the name of its resource group.

(Inherited from ISupportsGettingByResourceGroup<T>)
List()

Lists all the resources of the specified type in the currently selected subscription.

(Inherited from ISupportsListing<T>)
ListAsync(Boolean, CancellationToken)

Lists all the resources of the specified type in the currently selected subscription.

(Inherited from ISupportsListing<T>)
ListByResourceGroup(String)

Lists resources of the specified type in the specified resource group.

(Inherited from ISupportsListingByResourceGroup<T>)
ListByResourceGroupAsync(String, Boolean, CancellationToken)

Lists resources of the specified type in the specified resource group.

(Inherited from ISupportsListingByResourceGroup<T>)
ListConnectionStrings(String, String)

Lists the connection strings for the specified Azure CosmosDB database account.

ListConnectionStringsAsync(String, String, CancellationToken)

Lists the connection strings for the specified Azure CosmosDB database account.

ListKeys(String, String)

Lists the access keys for the specified Azure CosmosDB database account.

ListKeysAsync(String, String, CancellationToken)

Lists the access keys for the specified Azure CosmosDB database account.

ListReadOnlyKeys(String, String)

Lists the read-only access keys for the specified Azure CosmosDB database account.

ListReadOnlyKeysAsync(String, String, CancellationToken)

Lists the read-only access keys for the specified Azure CosmosDB database account.

RegenerateKey(String, String, String)

Regenerates an access key for the specified Azure CosmosDB database account.

RegenerateKeyAsync(String, String, String, CancellationToken)

Regenerates an access key for the specified Azure CosmosDB database account.

Applies to