IDefinition Interface
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Grouping of cosmos db definition stages.
public interface IDefinition : Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IBlank, Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithCreate, Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithGroup, Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithKind, Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithWriteReplication, Microsoft.Azure.Management.ResourceManager.Fluent.Core.GroupableResource.Definition.IWithCreatableResourceGroup<Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithKind>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.GroupableResource.Definition.IWithExistingResourceGroup<Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithKind>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.GroupableResource.Definition.IWithGroup<Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithKind>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.GroupableResource.Definition.IWithNewResourceGroup<Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithKind>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.IBeta, Microsoft.Azure.Management.ResourceManager.Fluent.Core.Resource.Definition.IDefinitionWithRegion<Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithGroup>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.Resource.Definition.IDefinitionWithTags<Microsoft.Azure.Management.CosmosDB.Fluent.CosmosDBAccount.Definition.IWithCreate>, Microsoft.Azure.Management.ResourceManager.Fluent.Core.ResourceActions.ICreatable<Microsoft.Azure.Management.CosmosDB.Fluent.ICosmosDBAccount>type IDefinition = interface
interface IBlank
interface IDefinitionWithRegion<IWithGroup>
interface IWithGroup
interface IWithGroup<IWithKind>
interface IWithExistingResourceGroup<IWithKind>
interface IWithNewResourceGroup<IWithKind>
interface IWithCreatableResourceGroup<IWithKind>
interface IWithKind
interface IWithKindBeta
interface IBeta
interface IWithWriteReplication
interface IWithReadReplication
interface IWithChildResource
interface IWithCreate
interface ICreatable<ICosmosDBAccount>
interface IIndexable
interface IWithConsistencyPolicy
interface IWithIpRangeFilter
interface IWithVirtualNetworkRule
interface IWithMultipleLocations
interface IWithConnector
interface IWithKeyBasedMetadataWriteAccess
interface IWithPrivateEndpointConnection
interface IWithAutomaticFailover
interface IWithKeyVault
interface IDefinitionWithTags<IWithCreate>Public Interface IDefinition
Implements IBeta, IBlank, ICreatable(Of ICosmosDBAccount), IDefinitionWithRegion(Of IWithGroup), IDefinitionWithTags(Of IWithCreate), IWithCreatableResourceGroup(Of IWithKind), IWithCreate, IWithExistingResourceGroup(Of IWithKind), IWithGroup, IWithGroup(Of IWithKind), IWithKind, IWithNewResourceGroup(Of IWithKind), IWithWriteReplication- Derived
- Implements
-
IBlank IWithAutomaticFailover IWithChildResource IWithConnector IWithConsistencyPolicy IWithCreate IWithGroup IWithIpRangeFilter IWithKeyBasedMetadataWriteAccess IWithKeyVault IWithKind IWithKindBeta IWithMultipleLocations IWithPrivateEndpointConnection IWithReadReplication IWithVirtualNetworkRule IWithWriteReplication IWithCreatableResourceGroup<IWithKind> IWithCreatableResourceGroup<T> IWithExistingResourceGroup<IWithKind> IWithExistingResourceGroup<T> IWithGroup<IWithKind> IWithNewResourceGroup<IWithKind> IWithNewResourceGroup<T> IBeta IDefinitionWithRegion<IWithGroup> IDefinitionWithTags<IWithCreate> ICreatable<ICosmosDBAccount> IIndexable
Properties
| Key | (Inherited from IIndexable) |
| Name |
Gets the name of the creatable resource. (Inherited from ICreatable<T>) |
Methods
| Create() |
Execute the create request. (Inherited from ICreatable<T>) |
| CreateAsync(CancellationToken, Boolean) |
Puts the request into the queue and allow the HTTP client to execute it when system resources are available. (Inherited from ICreatable<T>) |
| DefineNewCassandraKeyspace(String) |
Defines a new Cassandra keyspace. (Inherited from IWithChildResource) |
| DefineNewGremlinDatabase(String) |
Defines a new Gremlin Database. (Inherited from IWithChildResource) |
| DefineNewMongoDB(String) |
Defines a new Mongo database. (Inherited from IWithChildResource) |
| DefineNewPrivateEndpointConnection(String) |
Starts the definition of a private endpoint connection to be attached to the cosmos db account. (Inherited from IWithPrivateEndpointConnection) |
| DefineNewSqlDatabase(String) |
Defines a new SQL database. (Inherited from IWithChildResource) |
| DefineNewTable(String) |
Defines a new Table Database. (Inherited from IWithChildResource) |
| WithAutomaticFailoverEnabled(Boolean) |
Specifies whether automatic failover is enabled for this cosmos db account. (Inherited from IWithAutomaticFailover) |
| WithBoundedStalenessConsistency(Int64, Int32) |
The bounded staleness consistency policy for the CosmosDB account. (Inherited from IWithConsistencyPolicy) |
| WithCassandraConnector(ConnectorOffer) |
Specifies a connector offer for cassandra connector. (Inherited from IWithConnector) |
| WithDataModelAzureTable() |
Creates an Azure Table CosmosDB account. (Inherited from IWithKindBeta) |
| WithDataModelCassandra() |
Creates a Cassandra CosmosDB account. (Inherited from IWithKindBeta) |
| WithDataModelGremlin() |
Creates a Gremlin CosmosDB account. (Inherited from IWithKindBeta) |
| WithDataModelMongoDB() |
Creates a MongoDB CosmosDB account. (Inherited from IWithKindBeta) |
| WithDataModelSql() |
Creates a SQL CosmosDB account. (Inherited from IWithKindBeta) |
| WithDefaultWriteReplication() |
Sets the write location same as the CosmosDB account location. (Inherited from IWithWriteReplication) |
| WithDisableKeyBaseMetadataWriteAccess(Boolean) |
Specifies whether metadata write access should be disabled. (Inherited from IWithKeyBasedMetadataWriteAccess) |
| WithEventualConsistency() |
The eventual consistency policy for the CosmosDB account. (Inherited from IWithConsistencyPolicy) |
| WithExistingResourceGroup(IResourceGroup) |
Associates the resource with an existing resource group. (Inherited from IWithExistingResourceGroup<T>) |
| WithExistingResourceGroup(String) |
Associates the resource with an existing resource group. (Inherited from IWithExistingResourceGroup<T>) |
| WithIpRangeFilter(String) |
CosmosDB Firewall Support: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. IP addresses/ranges must be comma separated and must not contain any spaces. (Inherited from IWithIpRangeFilter) |
| WithKeyVault(String) |
Specifies a key vault uri for this cosmos db account. (Inherited from IWithKeyVault) |
| WithKind(DatabaseAccountKind, Capability[]) |
The database account kind for the CosmosDB account. (Inherited from IWithKindBeta) |
| WithKind(String) |
The database account kind for the CosmosDB account. (Inherited from IWithKind) |
| WithMultipleWriteLocationsEnabled(Boolean) |
Specifies whether multiple write locations are enabled for this cosmos db account. (Inherited from IWithMultipleLocations) |
| WithNewResourceGroup() | (Inherited from IWithNewResourceGroup<T>) |
| WithNewResourceGroup(ICreatable<IResourceGroup>) |
Creates a new resource group to put the resource in, based on the definition specified. (Inherited from IWithCreatableResourceGroup<T>) |
| WithNewResourceGroup(String) | (Inherited from IWithNewResourceGroup<T>) |
| WithReadReplication(Region, Nullable<Boolean>) |
Sets a read location for the CosmosDB account. (Inherited from IWithReadReplication) |
| WithRegion(Region) |
Specifies the region for the resource. (Inherited from IDefinitionWithRegion<T>) |
| WithRegion(String) |
Specifies the region for the resource by name. (Inherited from IDefinitionWithRegion<T>) |
| WithSessionConsistency() |
The session consistency policy for the CosmosDB account. (Inherited from IWithConsistencyPolicy) |
| WithStrongConsistency() |
The strong consistency policy for the CosmosDB account. (Inherited from IWithConsistencyPolicy) |
| WithTag(String, String) |
Adds a tag to the resource. (Inherited from IDefinitionWithTags<T>) |
| WithTags(IDictionary<String,String>) |
Specifies tags for the resource as a {@link Map}. (Inherited from IDefinitionWithTags<T>) |
| WithVirtualNetworkFilterEnabled(Boolean) |
Specifies Virtual Network Fileter manually. (Inherited from IWithVirtualNetworkRule) |
| WithVirtualNetworkRule(String, String, Nullable<Boolean>) |
Specifies a Virtual Network ACL Rule for the CosmosDB account. (Inherited from IWithVirtualNetworkRule) |
| WithVirtualNetworkRules(IList<VirtualNetworkRule>) |
Specifies the list of Virtual Network ACL Rules for the CosmosDB account. (Inherited from IWithVirtualNetworkRule) |
| WithWriteReplication(Region, Nullable<Boolean>) |
Sets a write location for the CosmosDB account. (Inherited from IWithWriteReplication) |
Applies to
Azure SDK for .NET
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for