ArmCosmosDBModelFactory.CosmosDBAccountPatch Method
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.
Overloads
CosmosDBAccountPatch(IDictionary<String,String>, Nullable<AzureLocation>, ManagedServiceIdentity, ConsistencyPolicy, IEnumerable<CosmosDBAccountLocation>, IEnumerable<CosmosDBIPAddressOrRange>, Nullable<Boolean>, Nullable<Boolean>, IEnumerable<CosmosDBAccountCapability>, IEnumerable<CosmosDBVirtualNetworkRule>, Nullable<Boolean>, Nullable<Boolean>, Nullable<ConnectorOffer>, Nullable<Boolean>, Uri, String, Nullable<CosmosDBPublicNetworkAccess>, Nullable<Boolean>, Nullable<CosmosDBServerVersion>, Nullable<Boolean>, Nullable<AnalyticalStorageSchemaType>, CosmosDBAccountBackupPolicy, IEnumerable<CosmosDBAccountCorsPolicy>, Nullable<NetworkAclBypass>, IEnumerable<ResourceIdentifier>, Nullable<Boolean>, Nullable<Int32>, DatabaseAccountKeysMetadata, Nullable<Boolean>, Nullable<CosmosDBMinimalTlsVersion>)
- Source:
- ArmCosmosDBModelFactory.cs
public static Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountPatch CosmosDBAccountPatch (System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation? location = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, Azure.ResourceManager.CosmosDB.Models.ConsistencyPolicy consistencyPolicy = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountLocation> locations = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBIPAddressOrRange> ipRules = default, bool? isVirtualNetworkFilterEnabled = default, bool? enableAutomaticFailover = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountCapability> capabilities = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBVirtualNetworkRule> virtualNetworkRules = default, bool? enableMultipleWriteLocations = default, bool? enableCassandraConnector = default, Azure.ResourceManager.CosmosDB.Models.ConnectorOffer? connectorOffer = default, bool? disableKeyBasedMetadataWriteAccess = default, Uri keyVaultKeyUri = default, string defaultIdentity = default, Azure.ResourceManager.CosmosDB.Models.CosmosDBPublicNetworkAccess? publicNetworkAccess = default, bool? isFreeTierEnabled = default, Azure.ResourceManager.CosmosDB.Models.CosmosDBServerVersion? apiServerVersion = default, bool? isAnalyticalStorageEnabled = default, Azure.ResourceManager.CosmosDB.Models.AnalyticalStorageSchemaType? analyticalStorageSchemaType = default, Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountBackupPolicy backupPolicy = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountCorsPolicy> cors = default, Azure.ResourceManager.CosmosDB.Models.NetworkAclBypass? networkAclBypass = default, System.Collections.Generic.IEnumerable<Azure.Core.ResourceIdentifier> networkAclBypassResourceIds = default, bool? disableLocalAuth = default, int? capacityTotalThroughputLimit = default, Azure.ResourceManager.CosmosDB.Models.DatabaseAccountKeysMetadata keysMetadata = default, bool? enablePartitionMerge = default, Azure.ResourceManager.CosmosDB.Models.CosmosDBMinimalTlsVersion? minimalTlsVersion = default);
static member CosmosDBAccountPatch : System.Collections.Generic.IDictionary<string, string> * Nullable<Azure.Core.AzureLocation> * Azure.ResourceManager.Models.ManagedServiceIdentity * Azure.ResourceManager.CosmosDB.Models.ConsistencyPolicy * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountLocation> * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBIPAddressOrRange> * Nullable<bool> * Nullable<bool> * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountCapability> * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBVirtualNetworkRule> * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.ConnectorOffer> * Nullable<bool> * Uri * string * Nullable<Azure.ResourceManager.CosmosDB.Models.CosmosDBPublicNetworkAccess> * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.CosmosDBServerVersion> * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.AnalyticalStorageSchemaType> * Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountBackupPolicy * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountCorsPolicy> * Nullable<Azure.ResourceManager.CosmosDB.Models.NetworkAclBypass> * seq<Azure.Core.ResourceIdentifier> * Nullable<bool> * Nullable<int> * Azure.ResourceManager.CosmosDB.Models.DatabaseAccountKeysMetadata * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.CosmosDBMinimalTlsVersion> -> Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountPatch
Public Shared Function CosmosDBAccountPatch (Optional tags As IDictionary(Of String, String) = Nothing, Optional location As Nullable(Of AzureLocation) = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional consistencyPolicy As ConsistencyPolicy = Nothing, Optional locations As IEnumerable(Of CosmosDBAccountLocation) = Nothing, Optional ipRules As IEnumerable(Of CosmosDBIPAddressOrRange) = Nothing, Optional isVirtualNetworkFilterEnabled As Nullable(Of Boolean) = Nothing, Optional enableAutomaticFailover As Nullable(Of Boolean) = Nothing, Optional capabilities As IEnumerable(Of CosmosDBAccountCapability) = Nothing, Optional virtualNetworkRules As IEnumerable(Of CosmosDBVirtualNetworkRule) = Nothing, Optional enableMultipleWriteLocations As Nullable(Of Boolean) = Nothing, Optional enableCassandraConnector As Nullable(Of Boolean) = Nothing, Optional connectorOffer As Nullable(Of ConnectorOffer) = Nothing, Optional disableKeyBasedMetadataWriteAccess As Nullable(Of Boolean) = Nothing, Optional keyVaultKeyUri As Uri = Nothing, Optional defaultIdentity As String = Nothing, Optional publicNetworkAccess As Nullable(Of CosmosDBPublicNetworkAccess) = Nothing, Optional isFreeTierEnabled As Nullable(Of Boolean) = Nothing, Optional apiServerVersion As Nullable(Of CosmosDBServerVersion) = Nothing, Optional isAnalyticalStorageEnabled As Nullable(Of Boolean) = Nothing, Optional analyticalStorageSchemaType As Nullable(Of AnalyticalStorageSchemaType) = Nothing, Optional backupPolicy As CosmosDBAccountBackupPolicy = Nothing, Optional cors As IEnumerable(Of CosmosDBAccountCorsPolicy) = Nothing, Optional networkAclBypass As Nullable(Of NetworkAclBypass) = Nothing, Optional networkAclBypassResourceIds As IEnumerable(Of ResourceIdentifier) = Nothing, Optional disableLocalAuth As Nullable(Of Boolean) = Nothing, Optional capacityTotalThroughputLimit As Nullable(Of Integer) = Nothing, Optional keysMetadata As DatabaseAccountKeysMetadata = Nothing, Optional enablePartitionMerge As Nullable(Of Boolean) = Nothing, Optional minimalTlsVersion As Nullable(Of CosmosDBMinimalTlsVersion) = Nothing) As CosmosDBAccountPatch
Parameters
- tags
- IDictionary<String,String>
- location
- Nullable<AzureLocation>
- identity
- ManagedServiceIdentity
- consistencyPolicy
- ConsistencyPolicy
- locations
- IEnumerable<CosmosDBAccountLocation>
- ipRules
- IEnumerable<CosmosDBIPAddressOrRange>
- capabilities
- IEnumerable<CosmosDBAccountCapability>
- virtualNetworkRules
- IEnumerable<CosmosDBVirtualNetworkRule>
- connectorOffer
- Nullable<ConnectorOffer>
- keyVaultKeyUri
- Uri
- defaultIdentity
- String
- publicNetworkAccess
- Nullable<CosmosDBPublicNetworkAccess>
- apiServerVersion
- Nullable<CosmosDBServerVersion>
- analyticalStorageSchemaType
- Nullable<AnalyticalStorageSchemaType>
- backupPolicy
- CosmosDBAccountBackupPolicy
- networkAclBypass
- Nullable<NetworkAclBypass>
- networkAclBypassResourceIds
- IEnumerable<ResourceIdentifier>
- keysMetadata
- DatabaseAccountKeysMetadata
- minimalTlsVersion
- Nullable<CosmosDBMinimalTlsVersion>
Returns
Applies to
CosmosDBAccountPatch(IDictionary<String,String>, Nullable<AzureLocation>, ManagedServiceIdentity, ConsistencyPolicy, IEnumerable<CosmosDBAccountLocation>, IEnumerable<CosmosDBIPAddressOrRange>, Nullable<Boolean>, Nullable<Boolean>, IEnumerable<CosmosDBAccountCapability>, IEnumerable<CosmosDBVirtualNetworkRule>, Nullable<Boolean>, Nullable<Boolean>, Nullable<ConnectorOffer>, Nullable<Boolean>, Uri, String, Nullable<CosmosDBPublicNetworkAccess>, Nullable<Boolean>, Nullable<CosmosDBServerVersion>, Nullable<Boolean>, Nullable<AnalyticalStorageSchemaType>, CosmosDBAccountBackupPolicy, IEnumerable<CosmosDBAccountCorsPolicy>, Nullable<NetworkAclBypass>, IEnumerable<ResourceIdentifier>, Nullable<EnableFullTextQuery>, Nullable<Boolean>, Nullable<Int32>, Nullable<CapacityMode>, Nullable<Boolean>, DatabaseAccountKeysMetadata, Nullable<Boolean>, Nullable<Boolean>, Nullable<CosmosDBMinimalTlsVersion>, String, Nullable<Boolean>, Nullable<DefaultPriorityLevel>, Nullable<Boolean>)
- Source:
- ArmCosmosDBModelFactory.cs
Initializes a new instance of CosmosDBAccountPatch.
public static Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountPatch CosmosDBAccountPatch (System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation? location = default, Azure.ResourceManager.Models.ManagedServiceIdentity identity = default, Azure.ResourceManager.CosmosDB.Models.ConsistencyPolicy consistencyPolicy = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountLocation> locations = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBIPAddressOrRange> ipRules = default, bool? isVirtualNetworkFilterEnabled = default, bool? enableAutomaticFailover = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountCapability> capabilities = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBVirtualNetworkRule> virtualNetworkRules = default, bool? enableMultipleWriteLocations = default, bool? enableCassandraConnector = default, Azure.ResourceManager.CosmosDB.Models.ConnectorOffer? connectorOffer = default, bool? disableKeyBasedMetadataWriteAccess = default, Uri keyVaultKeyUri = default, string defaultIdentity = default, Azure.ResourceManager.CosmosDB.Models.CosmosDBPublicNetworkAccess? publicNetworkAccess = default, bool? isFreeTierEnabled = default, Azure.ResourceManager.CosmosDB.Models.CosmosDBServerVersion? apiServerVersion = default, bool? isAnalyticalStorageEnabled = default, Azure.ResourceManager.CosmosDB.Models.AnalyticalStorageSchemaType? analyticalStorageSchemaType = default, Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountBackupPolicy backupPolicy = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountCorsPolicy> cors = default, Azure.ResourceManager.CosmosDB.Models.NetworkAclBypass? networkAclBypass = default, System.Collections.Generic.IEnumerable<Azure.Core.ResourceIdentifier> networkAclBypassResourceIds = default, Azure.ResourceManager.CosmosDB.Models.EnableFullTextQuery? diagnosticLogEnableFullTextQuery = default, bool? disableLocalAuth = default, int? capacityTotalThroughputLimit = default, Azure.ResourceManager.CosmosDB.Models.CapacityMode? capacityMode = default, bool? enableMaterializedViews = default, Azure.ResourceManager.CosmosDB.Models.DatabaseAccountKeysMetadata keysMetadata = default, bool? enablePartitionMerge = default, bool? enableBurstCapacity = default, Azure.ResourceManager.CosmosDB.Models.CosmosDBMinimalTlsVersion? minimalTlsVersion = default, string customerManagedKeyStatus = default, bool? enablePriorityBasedExecution = default, Azure.ResourceManager.CosmosDB.Models.DefaultPriorityLevel? defaultPriorityLevel = default, bool? enablePerRegionPerPartitionAutoscale = default);
static member CosmosDBAccountPatch : System.Collections.Generic.IDictionary<string, string> * Nullable<Azure.Core.AzureLocation> * Azure.ResourceManager.Models.ManagedServiceIdentity * Azure.ResourceManager.CosmosDB.Models.ConsistencyPolicy * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountLocation> * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBIPAddressOrRange> * Nullable<bool> * Nullable<bool> * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountCapability> * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBVirtualNetworkRule> * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.ConnectorOffer> * Nullable<bool> * Uri * string * Nullable<Azure.ResourceManager.CosmosDB.Models.CosmosDBPublicNetworkAccess> * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.CosmosDBServerVersion> * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.AnalyticalStorageSchemaType> * Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountBackupPolicy * seq<Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountCorsPolicy> * Nullable<Azure.ResourceManager.CosmosDB.Models.NetworkAclBypass> * seq<Azure.Core.ResourceIdentifier> * Nullable<Azure.ResourceManager.CosmosDB.Models.EnableFullTextQuery> * Nullable<bool> * Nullable<int> * Nullable<Azure.ResourceManager.CosmosDB.Models.CapacityMode> * Nullable<bool> * Azure.ResourceManager.CosmosDB.Models.DatabaseAccountKeysMetadata * Nullable<bool> * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.CosmosDBMinimalTlsVersion> * string * Nullable<bool> * Nullable<Azure.ResourceManager.CosmosDB.Models.DefaultPriorityLevel> * Nullable<bool> -> Azure.ResourceManager.CosmosDB.Models.CosmosDBAccountPatch
Public Shared Function CosmosDBAccountPatch (Optional tags As IDictionary(Of String, String) = Nothing, Optional location As Nullable(Of AzureLocation) = Nothing, Optional identity As ManagedServiceIdentity = Nothing, Optional consistencyPolicy As ConsistencyPolicy = Nothing, Optional locations As IEnumerable(Of CosmosDBAccountLocation) = Nothing, Optional ipRules As IEnumerable(Of CosmosDBIPAddressOrRange) = Nothing, Optional isVirtualNetworkFilterEnabled As Nullable(Of Boolean) = Nothing, Optional enableAutomaticFailover As Nullable(Of Boolean) = Nothing, Optional capabilities As IEnumerable(Of CosmosDBAccountCapability) = Nothing, Optional virtualNetworkRules As IEnumerable(Of CosmosDBVirtualNetworkRule) = Nothing, Optional enableMultipleWriteLocations As Nullable(Of Boolean) = Nothing, Optional enableCassandraConnector As Nullable(Of Boolean) = Nothing, Optional connectorOffer As Nullable(Of ConnectorOffer) = Nothing, Optional disableKeyBasedMetadataWriteAccess As Nullable(Of Boolean) = Nothing, Optional keyVaultKeyUri As Uri = Nothing, Optional defaultIdentity As String = Nothing, Optional publicNetworkAccess As Nullable(Of CosmosDBPublicNetworkAccess) = Nothing, Optional isFreeTierEnabled As Nullable(Of Boolean) = Nothing, Optional apiServerVersion As Nullable(Of CosmosDBServerVersion) = Nothing, Optional isAnalyticalStorageEnabled As Nullable(Of Boolean) = Nothing, Optional analyticalStorageSchemaType As Nullable(Of AnalyticalStorageSchemaType) = Nothing, Optional backupPolicy As CosmosDBAccountBackupPolicy = Nothing, Optional cors As IEnumerable(Of CosmosDBAccountCorsPolicy) = Nothing, Optional networkAclBypass As Nullable(Of NetworkAclBypass) = Nothing, Optional networkAclBypassResourceIds As IEnumerable(Of ResourceIdentifier) = Nothing, Optional diagnosticLogEnableFullTextQuery As Nullable(Of EnableFullTextQuery) = Nothing, Optional disableLocalAuth As Nullable(Of Boolean) = Nothing, Optional capacityTotalThroughputLimit As Nullable(Of Integer) = Nothing, Optional capacityMode As Nullable(Of CapacityMode) = Nothing, Optional enableMaterializedViews As Nullable(Of Boolean) = Nothing, Optional keysMetadata As DatabaseAccountKeysMetadata = Nothing, Optional enablePartitionMerge As Nullable(Of Boolean) = Nothing, Optional enableBurstCapacity As Nullable(Of Boolean) = Nothing, Optional minimalTlsVersion As Nullable(Of CosmosDBMinimalTlsVersion) = Nothing, Optional customerManagedKeyStatus As String = Nothing, Optional enablePriorityBasedExecution As Nullable(Of Boolean) = Nothing, Optional defaultPriorityLevel As Nullable(Of DefaultPriorityLevel) = Nothing, Optional enablePerRegionPerPartitionAutoscale As Nullable(Of Boolean) = Nothing) As CosmosDBAccountPatch
Parameters
- tags
- IDictionary<String,String>
Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
- location
- Nullable<AzureLocation>
The location of the resource group to which the resource belongs.
- identity
- ManagedServiceIdentity
Identity for the resource.
- consistencyPolicy
- ConsistencyPolicy
The consistency policy for the Cosmos DB account.
- locations
- IEnumerable<CosmosDBAccountLocation>
An array that contains the georeplication locations enabled for the Cosmos DB account.
- ipRules
- IEnumerable<CosmosDBIPAddressOrRange>
List of IpRules.
Flag to indicate whether to enable/disable Virtual Network ACL rules.
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.
- capabilities
- IEnumerable<CosmosDBAccountCapability>
List of Cosmos DB capabilities for the account.
- virtualNetworkRules
- IEnumerable<CosmosDBVirtualNetworkRule>
List of Virtual Network ACL rules configured for the Cosmos DB account.
Enables the cassandra connector on the Cosmos DB C* account.
- connectorOffer
- Nullable<ConnectorOffer>
The cassandra connector offer type for the Cosmos DB database C* account.
Disable write operations on metadata resources (databases, containers, throughput) via account keys.
- keyVaultKeyUri
- Uri
The URI of the key vault.
- defaultIdentity
- String
The default identity for accessing key vault used in features like customer managed keys. The default identity needs to be explicitly set by the users. It can be "FirstPartyIdentity", "SystemAssignedIdentity" and more.
- publicNetworkAccess
- Nullable<CosmosDBPublicNetworkAccess>
Whether requests from Public Network are allowed.
- apiServerVersion
- Nullable<CosmosDBServerVersion>
API specific properties. Currently, supported only for MongoDB API.
- analyticalStorageSchemaType
- Nullable<AnalyticalStorageSchemaType>
Analytical storage specific properties.
- backupPolicy
- CosmosDBAccountBackupPolicy
The object representing the policy for taking backups on an account. Please note CosmosDBAccountBackupPolicy is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ContinuousModeBackupPolicy and PeriodicModeBackupPolicy.
The CORS policy for the Cosmos DB database account.
- networkAclBypass
- Nullable<NetworkAclBypass>
Indicates what services are allowed to bypass firewall checks.
- networkAclBypassResourceIds
- IEnumerable<ResourceIdentifier>
An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account.
- diagnosticLogEnableFullTextQuery
- Nullable<EnableFullTextQuery>
The Object representing the different Diagnostic log settings for the Cosmos DB Account.
Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication.
The object that represents all properties related to capacity enforcement on an account.
- capacityMode
- Nullable<CapacityMode>
Indicates the capacityMode of the Cosmos DB account.
Flag to indicate whether to enable MaterializedViews on the Cosmos DB account.
- keysMetadata
- DatabaseAccountKeysMetadata
This property is ignored during the update operation, as the metadata is read-only. The object represents the metadata for the Account Keys of the Cosmos DB account.
Flag to indicate enabling/disabling of Partition Merge feature on the account.
Flag to indicate enabling/disabling of Burst Capacity Preview feature on the account.
- minimalTlsVersion
- Nullable<CosmosDBMinimalTlsVersion>
Indicates the minimum allowed Tls version. The default is Tls 1.0, except for Cassandra and Mongo API's, which only work with Tls 1.2.
- customerManagedKeyStatus
- String
Indicates the status of the Customer Managed Key feature on the account. In case there are errors, the property provides troubleshooting guidance.
Flag to indicate enabling/disabling of Priority Based Execution Preview feature on the account.
- defaultPriorityLevel
- Nullable<DefaultPriorityLevel>
Enum to indicate default Priority Level of request for Priority Based Execution.
Flag to indicate enabling/disabling of Per-Region Per-partition autoscale Preview feature on the account.
Returns
A new CosmosDBAccountPatch instance for mocking.