ArmCosmosDBForPostgreSqlModelFactory.CosmosDBForPostgreSqlClusterData 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.
public static Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterData CosmosDBForPostgreSqlClusterData(Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, System.Collections.Generic.IDictionary<string,string> tags = default, Azure.Core.AzureLocation location = default, Azure.ResourceManager.CosmosDBForPostgreSql.Models.AadEnabledEnum? aadAuthEnabled = default, string administratorLogin = default, string administratorLoginPassword = default, Azure.ResourceManager.CosmosDBForPostgreSql.Models.DataEncryption dataEncryption = default, string provisioningState = default, string state = default, string postgresqlVersion = default, string citusVersion = default, Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlMaintenanceWindow maintenanceWindow = default, string preferredPrimaryZone = default, bool? isShardsOnCoordinatorEnabled = default, bool? isHAEnabled = default, string coordinatorServerEdition = default, int? coordinatorStorageQuotaInMb = default, int? coordinatorVCores = default, bool? isCoordinatorPublicIPAccessEnabled = default, string nodeServerEdition = default, int? nodeCount = default, int? nodeStorageQuotaInMb = default, int? nodeVCores = default, bool? isNodePublicIPAccessEnabled = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlServerNameItem> serverNames = default, Azure.Core.ResourceIdentifier sourceResourceId = default, Azure.Core.AzureLocation? sourceLocation = default, Azure.ResourceManager.CosmosDBForPostgreSql.Models.PasswordEnabledEnum? passwordEnabled = default, DateTimeOffset? pointInTimeUTC = default, System.Collections.Generic.IEnumerable<string> readReplicas = default, DateTimeOffset? earliestRestoreOn = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlSimplePrivateEndpointConnection> privateEndpointConnections = default, string databaseName = default, bool? enableGeoBackup = default, Azure.ResourceManager.CosmosDBForPostgreSql.Models.AuthConfig authConfig = default, Azure.ResourceManager.CosmosDBForPostgreSql.Models.IdentityProperties identity = default);static member CosmosDBForPostgreSqlClusterData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * System.Collections.Generic.IDictionary<string, string> * Azure.Core.AzureLocation * Nullable<Azure.ResourceManager.CosmosDBForPostgreSql.Models.AadEnabledEnum> * string * string * Azure.ResourceManager.CosmosDBForPostgreSql.Models.DataEncryption * string * string * string * string * Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlMaintenanceWindow * string * Nullable<bool> * Nullable<bool> * string * Nullable<int> * Nullable<int> * Nullable<bool> * string * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * seq<Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlServerNameItem> * Azure.Core.ResourceIdentifier * Nullable<Azure.Core.AzureLocation> * Nullable<Azure.ResourceManager.CosmosDBForPostgreSql.Models.PasswordEnabledEnum> * Nullable<DateTimeOffset> * seq<string> * Nullable<DateTimeOffset> * seq<Azure.ResourceManager.CosmosDBForPostgreSql.Models.CosmosDBForPostgreSqlSimplePrivateEndpointConnection> * string * Nullable<bool> * Azure.ResourceManager.CosmosDBForPostgreSql.Models.AuthConfig * Azure.ResourceManager.CosmosDBForPostgreSql.Models.IdentityProperties -> Azure.ResourceManager.CosmosDBForPostgreSql.CosmosDBForPostgreSqlClusterDataPublic Shared Function CosmosDBForPostgreSqlClusterData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional tags As IDictionary(Of String, String) = Nothing, Optional location As AzureLocation = Nothing, Optional aadAuthEnabled As Nullable(Of AadEnabledEnum) = Nothing, Optional administratorLogin As String = Nothing, Optional administratorLoginPassword As String = Nothing, Optional dataEncryption As DataEncryption = Nothing, Optional provisioningState As String = Nothing, Optional state As String = Nothing, Optional postgresqlVersion As String = Nothing, Optional citusVersion As String = Nothing, Optional maintenanceWindow As CosmosDBForPostgreSqlMaintenanceWindow = Nothing, Optional preferredPrimaryZone As String = Nothing, Optional isShardsOnCoordinatorEnabled As Nullable(Of Boolean) = Nothing, Optional isHAEnabled As Nullable(Of Boolean) = Nothing, Optional coordinatorServerEdition As String = Nothing, Optional coordinatorStorageQuotaInMb As Nullable(Of Integer) = Nothing, Optional coordinatorVCores As Nullable(Of Integer) = Nothing, Optional isCoordinatorPublicIPAccessEnabled As Nullable(Of Boolean) = Nothing, Optional nodeServerEdition As String = Nothing, Optional nodeCount As Nullable(Of Integer) = Nothing, Optional nodeStorageQuotaInMb As Nullable(Of Integer) = Nothing, Optional nodeVCores As Nullable(Of Integer) = Nothing, Optional isNodePublicIPAccessEnabled As Nullable(Of Boolean) = Nothing, Optional serverNames As IEnumerable(Of CosmosDBForPostgreSqlServerNameItem) = Nothing, Optional sourceResourceId As ResourceIdentifier = Nothing, Optional sourceLocation As Nullable(Of AzureLocation) = Nothing, Optional passwordEnabled As Nullable(Of PasswordEnabledEnum) = Nothing, Optional pointInTimeUTC As Nullable(Of DateTimeOffset) = Nothing, Optional readReplicas As IEnumerable(Of String) = Nothing, Optional earliestRestoreOn As Nullable(Of DateTimeOffset) = Nothing, Optional privateEndpointConnections As IEnumerable(Of CosmosDBForPostgreSqlSimplePrivateEndpointConnection) = Nothing, Optional databaseName As String = Nothing, Optional enableGeoBackup As Nullable(Of Boolean) = Nothing, Optional authConfig As AuthConfig = Nothing, Optional identity As IdentityProperties = Nothing) As CosmosDBForPostgreSqlClusterDataParameters
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
- name
- String
The name of the resource.
- resourceType
- ResourceType
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
- systemData
- SystemData
Azure Resource Manager metadata containing createdBy and modifiedBy information.
- tags
- IDictionary<String,String>
Resource tags.
- location
- AzureLocation
The geo-location where the resource lives.
- aadAuthEnabled
- Nullable<AadEnabledEnum>
Indicates whether the cluster was created using AAD authentication.
- administratorLogin
- String
The administrator's login name of the servers in the cluster.
- administratorLoginPassword
- String
The password of the administrator login. Required for creation.
- dataEncryption
- DataEncryption
The data encryption properties of a cluster.
- provisioningState
- String
Provisioning state of the cluster.
- state
- String
A state of a cluster/server that is visible to user.
- postgresqlVersion
- String
The major PostgreSQL version on all cluster servers.
- citusVersion
- String
The Citus extension version on all cluster servers.
- maintenanceWindow
- CosmosDBForPostgreSqlMaintenanceWindow
Maintenance window of a cluster.
- preferredPrimaryZone
- String
Preferred primary availability zone (AZ) for all cluster servers.
If distributed tables are placed on coordinator or not. Should be set to 'true' on single node clusters. Requires shard rebalancing after value is changed.
- coordinatorServerEdition
- String
The edition of a coordinator server (default: GeneralPurpose). Required for creation.
The storage of a server in MB. Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
The vCores count of a server (max: 96). Required for creation. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- nodeServerEdition
- String
The edition of a node server (default: MemoryOptimized).
Worker node count of the cluster. When node count is 0, it represents a single node configuration with the ability to create distributed tables on that node. 2 or more worker nodes represent multi-node configuration. Node count value cannot be 1. Required for creation.
The storage in MB on each worker node. See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
The compute in vCores on each worker node (max: 104). See https://learn.microsoft.com/azure/cosmos-db/postgresql/resources-compute for more information.
- serverNames
- IEnumerable<CosmosDBForPostgreSqlServerNameItem>
The list of server names in the cluster.
- sourceResourceId
- ResourceIdentifier
The resource id of source cluster for read replica clusters.
- sourceLocation
- Nullable<AzureLocation>
The Azure region of source cluster for read replica clusters.
- passwordEnabled
- Nullable<PasswordEnabledEnum>
Indicates whether the cluster was created with a password or using AAD authentication.
- pointInTimeUTC
- Nullable<DateTimeOffset>
Date and time in UTC (ISO8601 format) for cluster restore.
- readReplicas
- IEnumerable<String>
The array of read replica clusters.
- earliestRestoreOn
- Nullable<DateTimeOffset>
The earliest restore point time (ISO8601 format) for the cluster.
- privateEndpointConnections
- IEnumerable<CosmosDBForPostgreSqlSimplePrivateEndpointConnection>
The private endpoint connections for a cluster.
- databaseName
- String
The database name of the cluster. Only one database per cluster is supported.
If cluster backup is stored in another Azure region in addition to the copy of the backup stored in the cluster's region. Enabled only at the time of cluster creation.
- authConfig
- AuthConfig
Authentication configuration of a cluster.
- identity
- IdentityProperties
Describes the identity of the cluster.
Returns
A new CosmosDBForPostgreSqlClusterData instance for mocking.
