364 строки
34 KiB
YAML
364 строки
34 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters"
|
|
name: "DatabaseAccountCreateUpdateParameters"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters"
|
|
summary: "Parameters to create and update Cosmos DB database accounts."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.ProxyResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.Resource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.management.cosmosdb.ARMResourceProperties?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.azure.ProxyResource?alt=com.microsoft.azure.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.ProxyResource.id()?alt=com.microsoft.azure.ProxyResource.id&text=id\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.ProxyResource.name()?alt=com.microsoft.azure.ProxyResource.name&text=name\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.ProxyResource.type()?alt=com.microsoft.azure.ProxyResource.type&text=type\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "<xref href=\"com.microsoft.azure.Resource?alt=com.microsoft.azure.Resource&text=Resource\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.Resource.getTags()?alt=com.microsoft.azure.Resource.getTags&text=getTags\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.Resource.location()?alt=com.microsoft.azure.Resource.location&text=location\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.Resource.withLocation(java.lang.String)?alt=com.microsoft.azure.Resource.withLocation&text=withLocation\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.Resource.withTags(java.util.Map<java.lang.String,java.lang.String>)?alt=com.microsoft.azure.Resource.withTags&text=withTags\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public class **DatabaseAccountCreateUpdateParameters**</br> extends <xref href=\"com.microsoft.azure.management.cosmosdb.ARMResourceProperties?alt=com.microsoft.azure.management.cosmosdb.ARMResourceProperties&text=ARMResourceProperties\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.DatabaseAccountCreateUpdateParameters()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.DatabaseAccountCreateUpdateParameters()"
|
|
name: "DatabaseAccountCreateUpdateParameters()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.DatabaseAccountCreateUpdateParameters()"
|
|
summary: "Creates an instance of Database<wbr>Account<wbr>Create<wbr>Update<wbr>Parameters class."
|
|
syntax: "public DatabaseAccountCreateUpdateParameters()"
|
|
desc: "Creates an instance of DatabaseAccountCreateUpdateParameters class."
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.capabilities()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.capabilities()"
|
|
name: "capabilities()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.capabilities()"
|
|
summary: "Get list of Cosmos DB capabilities for the account."
|
|
syntax: "public List<Capability> capabilities()"
|
|
desc: "Get list of Cosmos DB capabilities for the account."
|
|
returns:
|
|
description: "the capabilities value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.Capability?alt=com.microsoft.azure.management.cosmosdb.Capability&text=Capability\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.connectorOffer()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.connectorOffer()"
|
|
name: "connectorOffer()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.connectorOffer()"
|
|
summary: "Get the cassandra connector offer type for the Cosmos DB database C\\* account."
|
|
syntax: "public ConnectorOffer connectorOffer()"
|
|
desc: "Get the cassandra connector offer type for the Cosmos DB database C\\* account. Possible values include: 'Small'."
|
|
returns:
|
|
description: "the connectorOffer value"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.ConnectorOffer?alt=com.microsoft.azure.management.cosmosdb.ConnectorOffer&text=ConnectorOffer\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.consistencyPolicy()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.consistencyPolicy()"
|
|
name: "consistencyPolicy()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.consistencyPolicy()"
|
|
summary: "Get the consistency policy for the Cosmos DB account."
|
|
syntax: "public ConsistencyPolicy consistencyPolicy()"
|
|
desc: "Get the consistency policy for the Cosmos DB account."
|
|
returns:
|
|
description: "the consistencyPolicy value"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.ConsistencyPolicy?alt=com.microsoft.azure.management.cosmosdb.ConsistencyPolicy&text=ConsistencyPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.databaseAccountOfferType()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.databaseAccountOfferType()"
|
|
name: "databaseAccountOfferType()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.databaseAccountOfferType()"
|
|
summary: "Get the offer type for the database."
|
|
syntax: "public String databaseAccountOfferType()"
|
|
desc: "Get the offer type for the database."
|
|
returns:
|
|
description: "the databaseAccountOfferType value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.disableKeyBasedMetadataWriteAccess()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.disableKeyBasedMetadataWriteAccess()"
|
|
name: "disableKeyBasedMetadataWriteAccess()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.disableKeyBasedMetadataWriteAccess()"
|
|
summary: "Get disable write operations on metadata resources (databases, containers, throughput) via account keys."
|
|
syntax: "public Boolean disableKeyBasedMetadataWriteAccess()"
|
|
desc: "Get disable write operations on metadata resources (databases, containers, throughput) via account keys."
|
|
returns:
|
|
description: "the disableKeyBasedMetadataWriteAccess value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.enableAutomaticFailover()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.enableAutomaticFailover()"
|
|
name: "enableAutomaticFailover()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.enableAutomaticFailover()"
|
|
summary: "Get enables automatic failover of the write region in the rare event that the region is unavailable due to an outage."
|
|
syntax: "public Boolean enableAutomaticFailover()"
|
|
desc: "Get enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account."
|
|
returns:
|
|
description: "the enableAutomaticFailover value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.enableCassandraConnector()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.enableCassandraConnector()"
|
|
name: "enableCassandraConnector()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.enableCassandraConnector()"
|
|
summary: "Get enables the cassandra connector on the Cosmos DB C\\* account."
|
|
syntax: "public Boolean enableCassandraConnector()"
|
|
desc: "Get enables the cassandra connector on the Cosmos DB C\\* account."
|
|
returns:
|
|
description: "the enableCassandraConnector value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.enableMultipleWriteLocations()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.enableMultipleWriteLocations()"
|
|
name: "enableMultipleWriteLocations()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.enableMultipleWriteLocations()"
|
|
summary: "Get enables the account to write in multiple locations."
|
|
syntax: "public Boolean enableMultipleWriteLocations()"
|
|
desc: "Get enables the account to write in multiple locations."
|
|
returns:
|
|
description: "the enableMultipleWriteLocations value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.ipRangeFilter()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.ipRangeFilter()"
|
|
name: "ipRangeFilter()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.ipRangeFilter()"
|
|
summary: "Get cosmos DB 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."
|
|
syntax: "public String ipRangeFilter()"
|
|
desc: "Get cosmos DB 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."
|
|
returns:
|
|
description: "the ipRangeFilter value"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.isVirtualNetworkFilterEnabled()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.isVirtualNetworkFilterEnabled()"
|
|
name: "isVirtualNetworkFilterEnabled()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.isVirtualNetworkFilterEnabled()"
|
|
summary: "Get flag to indicate whether to enable/disable Virtual Network ACL rules."
|
|
syntax: "public Boolean isVirtualNetworkFilterEnabled()"
|
|
desc: "Get flag to indicate whether to enable/disable Virtual Network ACL rules."
|
|
returns:
|
|
description: "the isVirtualNetworkFilterEnabled value"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.kind()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.kind()"
|
|
name: "kind()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.kind()"
|
|
summary: "Get indicates the type of database account."
|
|
syntax: "public DatabaseAccountKind kind()"
|
|
desc: "Get indicates the type of database account. This can only be set at database account creation. Possible values include: 'GlobalDocumentDB', 'MongoDB', 'Parse'."
|
|
returns:
|
|
description: "the kind value"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountKind?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountKind&text=DatabaseAccountKind\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.locations()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.locations()"
|
|
name: "locations()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.locations()"
|
|
summary: "Get an array that contains the georeplication locations enabled for the Cosmos DB account."
|
|
syntax: "public List<Location> locations()"
|
|
desc: "Get an array that contains the georeplication locations enabled for the Cosmos DB account."
|
|
returns:
|
|
description: "the locations value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.Location?alt=com.microsoft.azure.management.cosmosdb.Location&text=Location\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.virtualNetworkRules()"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.virtualNetworkRules()"
|
|
name: "virtualNetworkRules()"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.virtualNetworkRules()"
|
|
summary: "Get list of Virtual Network ACL rules configured for the Cosmos DB account."
|
|
syntax: "public List<VirtualNetworkRule> virtualNetworkRules()"
|
|
desc: "Get list of Virtual Network ACL rules configured for the Cosmos DB account."
|
|
returns:
|
|
description: "the virtualNetworkRules value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.VirtualNetworkRule?alt=com.microsoft.azure.management.cosmosdb.VirtualNetworkRule&text=VirtualNetworkRule\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withCapabilities(java.util.List<com.microsoft.azure.management.cosmosdb.Capability>)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withCapabilities(List<Capability> capabilities)"
|
|
name: "withCapabilities(List<Capability> capabilities)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withCapabilities(List<Capability> capabilities)"
|
|
summary: "Set list of Cosmos DB capabilities for the account."
|
|
parameters:
|
|
- description: "the capabilities value to set"
|
|
name: "capabilities"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.Capability?alt=com.microsoft.azure.management.cosmosdb.Capability&text=Capability\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withCapabilities(List<Capability> capabilities)"
|
|
desc: "Set list of Cosmos DB capabilities for the account."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withConnectorOffer(com.microsoft.azure.management.cosmosdb.ConnectorOffer)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withConnectorOffer(ConnectorOffer connectorOffer)"
|
|
name: "withConnectorOffer(ConnectorOffer connectorOffer)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withConnectorOffer(ConnectorOffer connectorOffer)"
|
|
summary: "Set the cassandra connector offer type for the Cosmos DB database C\\* account."
|
|
parameters:
|
|
- description: "the connectorOffer value to set"
|
|
name: "connectorOffer"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.ConnectorOffer?alt=com.microsoft.azure.management.cosmosdb.ConnectorOffer&text=ConnectorOffer\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withConnectorOffer(ConnectorOffer connectorOffer)"
|
|
desc: "Set the cassandra connector offer type for the Cosmos DB database C\\* account. Possible values include: 'Small'."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withConsistencyPolicy(com.microsoft.azure.management.cosmosdb.ConsistencyPolicy)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)"
|
|
name: "withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)"
|
|
summary: "Set the consistency policy for the Cosmos DB account."
|
|
parameters:
|
|
- description: "the consistencyPolicy value to set"
|
|
name: "consistencyPolicy"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.ConsistencyPolicy?alt=com.microsoft.azure.management.cosmosdb.ConsistencyPolicy&text=ConsistencyPolicy\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withConsistencyPolicy(ConsistencyPolicy consistencyPolicy)"
|
|
desc: "Set the consistency policy for the Cosmos DB account."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withDatabaseAccountOfferType(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withDatabaseAccountOfferType(String databaseAccountOfferType)"
|
|
name: "withDatabaseAccountOfferType(String databaseAccountOfferType)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withDatabaseAccountOfferType(String databaseAccountOfferType)"
|
|
summary: "Set the offer type for the database."
|
|
parameters:
|
|
- description: "the databaseAccountOfferType value to set"
|
|
name: "databaseAccountOfferType"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withDatabaseAccountOfferType(String databaseAccountOfferType)"
|
|
desc: "Set the offer type for the database."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withDisableKeyBasedMetadataWriteAccess(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)"
|
|
name: "withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)"
|
|
summary: "Set disable write operations on metadata resources (databases, containers, throughput) via account keys."
|
|
parameters:
|
|
- description: "the disableKeyBasedMetadataWriteAccess value to set"
|
|
name: "disableKeyBasedMetadataWriteAccess"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withDisableKeyBasedMetadataWriteAccess(Boolean disableKeyBasedMetadataWriteAccess)"
|
|
desc: "Set disable write operations on metadata resources (databases, containers, throughput) via account keys."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withEnableAutomaticFailover(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withEnableAutomaticFailover(Boolean enableAutomaticFailover)"
|
|
name: "withEnableAutomaticFailover(Boolean enableAutomaticFailover)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withEnableAutomaticFailover(Boolean enableAutomaticFailover)"
|
|
summary: "Set enables automatic failover of the write region in the rare event that the region is unavailable due to an outage."
|
|
parameters:
|
|
- description: "the enableAutomaticFailover value to set"
|
|
name: "enableAutomaticFailover"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withEnableAutomaticFailover(Boolean enableAutomaticFailover)"
|
|
desc: "Set enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withEnableCassandraConnector(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withEnableCassandraConnector(Boolean enableCassandraConnector)"
|
|
name: "withEnableCassandraConnector(Boolean enableCassandraConnector)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withEnableCassandraConnector(Boolean enableCassandraConnector)"
|
|
summary: "Set enables the cassandra connector on the Cosmos DB C\\* account."
|
|
parameters:
|
|
- description: "the enableCassandraConnector value to set"
|
|
name: "enableCassandraConnector"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withEnableCassandraConnector(Boolean enableCassandraConnector)"
|
|
desc: "Set enables the cassandra connector on the Cosmos DB C\\* account."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withEnableMultipleWriteLocations(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)"
|
|
name: "withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)"
|
|
summary: "Set enables the account to write in multiple locations."
|
|
parameters:
|
|
- description: "the enableMultipleWriteLocations value to set"
|
|
name: "enableMultipleWriteLocations"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withEnableMultipleWriteLocations(Boolean enableMultipleWriteLocations)"
|
|
desc: "Set enables the account to write in multiple locations."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withIpRangeFilter(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withIpRangeFilter(String ipRangeFilter)"
|
|
name: "withIpRangeFilter(String ipRangeFilter)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withIpRangeFilter(String ipRangeFilter)"
|
|
summary: "Set cosmos DB 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."
|
|
parameters:
|
|
- description: "the ipRangeFilter value to set"
|
|
name: "ipRangeFilter"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withIpRangeFilter(String ipRangeFilter)"
|
|
desc: "Set cosmos DB 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."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withIsVirtualNetworkFilterEnabled(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)"
|
|
name: "withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)"
|
|
summary: "Set flag to indicate whether to enable/disable Virtual Network ACL rules."
|
|
parameters:
|
|
- description: "the isVirtualNetworkFilterEnabled value to set"
|
|
name: "isVirtualNetworkFilterEnabled"
|
|
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withIsVirtualNetworkFilterEnabled(Boolean isVirtualNetworkFilterEnabled)"
|
|
desc: "Set flag to indicate whether to enable/disable Virtual Network ACL rules."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withKind(com.microsoft.azure.management.cosmosdb.DatabaseAccountKind)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withKind(DatabaseAccountKind kind)"
|
|
name: "withKind(DatabaseAccountKind kind)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withKind(DatabaseAccountKind kind)"
|
|
summary: "Set indicates the type of database account."
|
|
parameters:
|
|
- description: "the kind value to set"
|
|
name: "kind"
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountKind?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountKind&text=DatabaseAccountKind\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withKind(DatabaseAccountKind kind)"
|
|
desc: "Set indicates the type of database account. This can only be set at database account creation. Possible values include: 'GlobalDocumentDB', 'MongoDB', 'Parse'."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withLocations(java.util.List<com.microsoft.azure.management.cosmosdb.Location>)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withLocations(List<Location> locations)"
|
|
name: "withLocations(List<Location> locations)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withLocations(List<Location> locations)"
|
|
summary: "Set an array that contains the georeplication locations enabled for the Cosmos DB account."
|
|
parameters:
|
|
- description: "the locations value to set"
|
|
name: "locations"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.Location?alt=com.microsoft.azure.management.cosmosdb.Location&text=Location\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withLocations(List<Location> locations)"
|
|
desc: "Set an array that contains the georeplication locations enabled for the Cosmos DB account."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withVirtualNetworkRules(java.util.List<com.microsoft.azure.management.cosmosdb.VirtualNetworkRule>)"
|
|
fullName: "com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters.withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules)"
|
|
name: "withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules)"
|
|
nameWithType: "DatabaseAccountCreateUpdateParameters.withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules)"
|
|
summary: "Set list of Virtual Network ACL rules configured for the Cosmos DB account."
|
|
parameters:
|
|
- description: "the virtualNetworkRules value to set"
|
|
name: "virtualNetworkRules"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.cosmosdb.VirtualNetworkRule?alt=com.microsoft.azure.management.cosmosdb.VirtualNetworkRule&text=VirtualNetworkRule\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public DatabaseAccountCreateUpdateParameters withVirtualNetworkRules(List<VirtualNetworkRule> virtualNetworkRules)"
|
|
desc: "Set list of Virtual Network ACL rules configured for the Cosmos DB account."
|
|
returns:
|
|
description: "the DatabaseAccountCreateUpdateParameters object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters?alt=com.microsoft.azure.management.cosmosdb.DatabaseAccountCreateUpdateParameters&text=DatabaseAccountCreateUpdateParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Parameters to create and update Cosmos DB database accounts."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.management.cosmosdb"
|
|
artifact: com.microsoft.azure:azure-mgmt-cosmosdb:1.41.4
|