Azure Native v2.73.0, Nov 20 24

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.documentdb.getCassandraDataCenter

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

Using getCassandraDataCenter

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getCassandraDataCenter(args: GetCassandraDataCenterArgs, opts?: InvokeOptions): Promise<GetCassandraDataCenterResult>
function getCassandraDataCenterOutput(args: GetCassandraDataCenterOutputArgs, opts?: InvokeOptions): Output<GetCassandraDataCenterResult>

def get_cassandra_data_center(cluster_name: Optional[str] = None,
                              data_center_name: Optional[str] = None,
                              resource_group_name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetCassandraDataCenterResult
def get_cassandra_data_center_output(cluster_name: Optional[pulumi.Input[str]] = None,
                              data_center_name: Optional[pulumi.Input[str]] = None,
                              resource_group_name: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetCassandraDataCenterResult]

func LookupCassandraDataCenter(ctx *Context, args *LookupCassandraDataCenterArgs, opts ...InvokeOption) (*LookupCassandraDataCenterResult, error)
func LookupCassandraDataCenterOutput(ctx *Context, args *LookupCassandraDataCenterOutputArgs, opts ...InvokeOption) LookupCassandraDataCenterResultOutput

> Note: This function is named LookupCassandraDataCenter in the Go SDK.

public static class GetCassandraDataCenter 
{
    public static Task<GetCassandraDataCenterResult> InvokeAsync(GetCassandraDataCenterArgs args, InvokeOptions? opts = null)
    public static Output<GetCassandraDataCenterResult> Invoke(GetCassandraDataCenterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCassandraDataCenterResult> getCassandraDataCenter(GetCassandraDataCenterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:documentdb:getCassandraDataCenter
  arguments:
    # arguments dictionary

The following arguments are supported:

ClusterName string: Managed Cassandra cluster name.
DataCenterName string: Data center name in a managed Cassandra cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

ClusterName string: Managed Cassandra cluster name.
DataCenterName string: Data center name in a managed Cassandra cluster.
ResourceGroupName string: The name of the resource group. The name is case insensitive.

clusterName String: Managed Cassandra cluster name.
dataCenterName String: Data center name in a managed Cassandra cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.

clusterName string: Managed Cassandra cluster name.
dataCenterName string: Data center name in a managed Cassandra cluster.
resourceGroupName string: The name of the resource group. The name is case insensitive.

cluster_name str: Managed Cassandra cluster name.
data_center_name str: Data center name in a managed Cassandra cluster.
resource_group_name str: The name of the resource group. The name is case insensitive.

clusterName String: Managed Cassandra cluster name.
dataCenterName String: Data center name in a managed Cassandra cluster.
resourceGroupName String: The name of the resource group. The name is case insensitive.

getCassandraDataCenter Result

The following output properties are available:

Id string: The unique resource identifier of the database account.
Name string: The name of the database account.
Properties Pulumi.AzureNative.DocumentDB.Outputs.DataCenterResourceResponseProperties: Properties of a managed Cassandra data center.
Type string: The type of Azure resource.

Id string: The unique resource identifier of the database account.
Name string: The name of the database account.
Properties DataCenterResourceResponseProperties: Properties of a managed Cassandra data center.
Type string: The type of Azure resource.

id String: The unique resource identifier of the database account.
name String: The name of the database account.
properties DataCenterResourceResponseProperties: Properties of a managed Cassandra data center.
type String: The type of Azure resource.

id string: The unique resource identifier of the database account.
name string: The name of the database account.
properties DataCenterResourceResponseProperties: Properties of a managed Cassandra data center.
type string: The type of Azure resource.

id str: The unique resource identifier of the database account.
name str: The name of the database account.
properties DataCenterResourceResponseProperties: Properties of a managed Cassandra data center.
type str: The type of Azure resource.

id String: The unique resource identifier of the database account.
name String: The name of the database account.
properties Property Map: Properties of a managed Cassandra data center.
type String: The type of Azure resource.

Supporting Types

AuthenticationMethodLdapPropertiesResponse

ConnectionTimeoutInMs int: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
SearchBaseDistinguishedName string: Distinguished name of the object to start the recursive search of users from.
SearchFilterTemplate string: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
ServerCertificates List<Pulumi.AzureNative.DocumentDB.Inputs.CertificateResponse>
ServerHostname string: Hostname of the LDAP server.
ServerPort int: Port of the LDAP server.
ServiceUserDistinguishedName string: Distinguished name of the look up user account, who can look up user details on authentication.
ServiceUserPassword string: Password of the look up user.

ConnectionTimeoutInMs int: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
SearchBaseDistinguishedName string: Distinguished name of the object to start the recursive search of users from.
SearchFilterTemplate string: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
ServerCertificates []CertificateResponse
ServerHostname string: Hostname of the LDAP server.
ServerPort int: Port of the LDAP server.
ServiceUserDistinguishedName string: Distinguished name of the look up user account, who can look up user details on authentication.
ServiceUserPassword string: Password of the look up user.

connectionTimeoutInMs Integer: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
searchBaseDistinguishedName String: Distinguished name of the object to start the recursive search of users from.
searchFilterTemplate String: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
serverCertificates List<CertificateResponse>
serverHostname String: Hostname of the LDAP server.
serverPort Integer: Port of the LDAP server.
serviceUserDistinguishedName String: Distinguished name of the look up user account, who can look up user details on authentication.
serviceUserPassword String: Password of the look up user.

connectionTimeoutInMs number: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
searchBaseDistinguishedName string: Distinguished name of the object to start the recursive search of users from.
searchFilterTemplate string: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
serverCertificates CertificateResponse[]
serverHostname string: Hostname of the LDAP server.
serverPort number: Port of the LDAP server.
serviceUserDistinguishedName string: Distinguished name of the look up user account, who can look up user details on authentication.
serviceUserPassword string: Password of the look up user.

connection_timeout_in_ms int: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
search_base_distinguished_name str: Distinguished name of the object to start the recursive search of users from.
search_filter_template str: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
server_certificates Sequence[CertificateResponse]
server_hostname str: Hostname of the LDAP server.
server_port int: Port of the LDAP server.
service_user_distinguished_name str: Distinguished name of the look up user account, who can look up user details on authentication.
service_user_password str: Password of the look up user.

connectionTimeoutInMs Number: Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
searchBaseDistinguishedName String: Distinguished name of the object to start the recursive search of users from.
searchFilterTemplate String: Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
serverCertificates List<Property Map>
serverHostname String: Hostname of the LDAP server.
serverPort Number: Port of the LDAP server.
serviceUserDistinguishedName String: Distinguished name of the look up user account, who can look up user details on authentication.
serviceUserPassword String: Password of the look up user.

CassandraErrorResponse

AdditionalErrorInfo string: Additional information about the error.
Code string: The code of error that occurred.
Message string: The message of the error.
Target string: The target resource of the error.

AdditionalErrorInfo string: Additional information about the error.
Code string: The code of error that occurred.
Message string: The message of the error.
Target string: The target resource of the error.

additionalErrorInfo String: Additional information about the error.
code String: The code of error that occurred.
message String: The message of the error.
target String: The target resource of the error.

additionalErrorInfo string: Additional information about the error.
code string: The code of error that occurred.
message string: The message of the error.
target string: The target resource of the error.

additional_error_info str: Additional information about the error.
code str: The code of error that occurred.
message str: The message of the error.
target str: The target resource of the error.

additionalErrorInfo String: Additional information about the error.
code String: The code of error that occurred.
message String: The message of the error.
target String: The target resource of the error.

CertificateResponse

Pem string: PEM formatted public key.

Pem string: PEM formatted public key.

pem String: PEM formatted public key.

pem string: PEM formatted public key.

pem str: PEM formatted public key.

pem String: PEM formatted public key.

DataCenterResourceResponseProperties

SeedNodes List<Pulumi.AzureNative.DocumentDB.Inputs.SeedNodeResponse>: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.
AuthenticationMethodLdapProperties Pulumi.AzureNative.DocumentDB.Inputs.AuthenticationMethodLdapPropertiesResponse: Ldap authentication method properties. This feature is in preview.
AvailabilityZone bool: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
BackupStorageCustomerKeyUri string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
Base64EncodedCassandraYamlFragment string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed.
DataCenterLocation string: The region this data center should be created in.
Deallocated bool: Whether the data center has been deallocated.
DelegatedSubnetId string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
DiskCapacity int: Number of disks attached to each node. Default is 4.
DiskSku string: Disk SKU used for data centers. Default value is P30.
ManagedDiskCustomerKeyUri string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.
NodeCount int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster.
ProvisionError Pulumi.AzureNative.DocumentDB.Inputs.CassandraErrorResponse: Error related to resource provisioning.
ProvisioningState string: The status of the resource at the time the operation was called.
Sku string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2

SeedNodes []SeedNodeResponse: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.
AuthenticationMethodLdapProperties AuthenticationMethodLdapPropertiesResponse: Ldap authentication method properties. This feature is in preview.
AvailabilityZone bool: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
BackupStorageCustomerKeyUri string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
Base64EncodedCassandraYamlFragment string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed.
DataCenterLocation string: The region this data center should be created in.
Deallocated bool: Whether the data center has been deallocated.
DelegatedSubnetId string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
DiskCapacity int: Number of disks attached to each node. Default is 4.
DiskSku string: Disk SKU used for data centers. Default value is P30.
ManagedDiskCustomerKeyUri string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.
NodeCount int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster.
ProvisionError CassandraErrorResponse: Error related to resource provisioning.
ProvisioningState string: The status of the resource at the time the operation was called.
Sku string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2

seedNodes List<SeedNodeResponse>: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.
authenticationMethodLdapProperties AuthenticationMethodLdapPropertiesResponse: Ldap authentication method properties. This feature is in preview.
availabilityZone Boolean: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
backupStorageCustomerKeyUri String: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
base64EncodedCassandraYamlFragment String: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed.
dataCenterLocation String: The region this data center should be created in.
deallocated Boolean: Whether the data center has been deallocated.
delegatedSubnetId String: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
diskCapacity Integer: Number of disks attached to each node. Default is 4.
diskSku String: Disk SKU used for data centers. Default value is P30.
managedDiskCustomerKeyUri String: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.
nodeCount Integer: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster.
provisionError CassandraErrorResponse: Error related to resource provisioning.
provisioningState String: The status of the resource at the time the operation was called.
sku String: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2

seedNodes SeedNodeResponse[]: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.
authenticationMethodLdapProperties AuthenticationMethodLdapPropertiesResponse: Ldap authentication method properties. This feature is in preview.
availabilityZone boolean: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
backupStorageCustomerKeyUri string: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
base64EncodedCassandraYamlFragment string: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed.
dataCenterLocation string: The region this data center should be created in.
deallocated boolean: Whether the data center has been deallocated.
delegatedSubnetId string: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
diskCapacity number: Number of disks attached to each node. Default is 4.
diskSku string: Disk SKU used for data centers. Default value is P30.
managedDiskCustomerKeyUri string: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.
nodeCount number: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster.
provisionError CassandraErrorResponse: Error related to resource provisioning.
provisioningState string: The status of the resource at the time the operation was called.
sku string: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2

seed_nodes Sequence[SeedNodeResponse]: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.
authentication_method_ldap_properties AuthenticationMethodLdapPropertiesResponse: Ldap authentication method properties. This feature is in preview.
availability_zone bool: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
backup_storage_customer_key_uri str: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
base64_encoded_cassandra_yaml_fragment str: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed.
data_center_location str: The region this data center should be created in.
deallocated bool: Whether the data center has been deallocated.
delegated_subnet_id str: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
disk_capacity int: Number of disks attached to each node. Default is 4.
disk_sku str: Disk SKU used for data centers. Default value is P30.
managed_disk_customer_key_uri str: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.
node_count int: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster.
provision_error CassandraErrorResponse: Error related to resource provisioning.
provisioning_state str: The status of the resource at the time the operation was called.
sku str: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2

seedNodes List<Property Map>: IP addresses for seed nodes in this data center. This is for reference. Generally you will want to use the seedNodes property on the cluster, which aggregates the seed nodes from all data centers in the cluster.
authenticationMethodLdapProperties Property Map: Ldap authentication method properties. This feature is in preview.
availabilityZone Boolean: If the data center has Availability Zone support, apply it to the Virtual Machine ScaleSet that host the cassandra data center virtual machines.
backupStorageCustomerKeyUri String: Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
base64EncodedCassandraYamlFragment String: A fragment of a cassandra.yaml configuration file to be included in the cassandra.yaml for all nodes in this data center. The fragment should be Base64 encoded, and only a subset of keys are allowed.
dataCenterLocation String: The region this data center should be created in.
deallocated Boolean: Whether the data center has been deallocated.
delegatedSubnetId String: Resource id of a subnet the nodes in this data center should have their network interfaces connected to. The subnet must be in the same region specified in 'dataCenterLocation' and must be able to route to the subnet specified in the cluster's 'delegatedManagementSubnetId' property. This resource id will be of the form '/subscriptions//resourceGroups//providers/Microsoft.Network/virtualNetworks//subnets/'.
diskCapacity Number: Number of disks attached to each node. Default is 4.
diskSku String: Disk SKU used for data centers. Default value is P30.
managedDiskCustomerKeyUri String: Key uri to use for encryption of managed disks. Ensure the system assigned identity of the cluster has been assigned appropriate permissions(key get/wrap/unwrap permissions) on the key.
nodeCount Number: The number of nodes the data center should have. This is the desired number. After it is set, it may take some time for the data center to be scaled to match. To monitor the number of nodes and their status, use the fetchNodeStatus method on the cluster.
provisionError Property Map: Error related to resource provisioning.
provisioningState String: The status of the resource at the time the operation was called.
sku String: Virtual Machine SKU used for data centers. Default value is Standard_DS14_v2

SeedNodeResponse

IpAddress string: IP address of this seed node.

IpAddress string: IP address of this seed node.

ipAddress String: IP address of this seed node.

ipAddress string: IP address of this seed node.

ip_address str: IP address of this seed node.

ipAddress String: IP address of this seed node.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.

Azure Native v2.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

pulumi/pulumi-azure-native

azure-native.documentdb.getCassandraDataCenter

On this page

On this page

Using getCassandraDataCenter

getCassandraDataCenter Result

Supporting Types

AuthenticationMethodLdapPropertiesResponse

CassandraErrorResponse

CertificateResponse

DataCenterResourceResponseProperties

SeedNodeResponse

Package Details

On this page

On this page