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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi
Get the properties of a managed Cassandra data center. Azure REST API version: 2023-04-15.
Other available API versions: 2023-09-15, 2023-09-15-preview, 2023-11-15, 2023-11-15-preview, 2024-02-15-preview, 2024-05-15, 2024-05-15-preview, 2024-08-15, 2024-09-01-preview.
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:
- Cluster
Name string - Managed Cassandra cluster name.
- Data
Center stringName - Data center name in a managed Cassandra cluster.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Cluster
Name string - Managed Cassandra cluster name.
- Data
Center stringName - Data center name in a managed Cassandra cluster.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- cluster
Name String - Managed Cassandra cluster name.
- data
Center StringName - Data center name in a managed Cassandra cluster.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- cluster
Name string - Managed Cassandra cluster name.
- data
Center stringName - Data center name in a managed Cassandra cluster.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- cluster_
name str - Managed Cassandra cluster name.
- data_
center_ strname - Data center name in a managed Cassandra cluster.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- cluster
Name String - Managed Cassandra cluster name.
- data
Center StringName - Data center name in a managed Cassandra cluster.
- resource
Group StringName - 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.
Azure Native. Document DB. Outputs. Data Center Resource Response Properties - 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
Data
Center Resource Response Properties - 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
Data
Center Resource Response Properties - 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
Data
Center Resource Response Properties - 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
Data
Center Resource Response Properties - 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
- Connection
Timeout intIn Ms - Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
- Search
Base stringDistinguished Name - Distinguished name of the object to start the recursive search of users from.
- Search
Filter stringTemplate - Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
- Server
Certificates List<Pulumi.Azure Native. Document DB. Inputs. Certificate Response> - Server
Hostname string - Hostname of the LDAP server.
- Server
Port int - Port of the LDAP server.
- Service
User stringDistinguished Name - Distinguished name of the look up user account, who can look up user details on authentication.
- Service
User stringPassword - Password of the look up user.
- Connection
Timeout intIn Ms - Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
- Search
Base stringDistinguished Name - Distinguished name of the object to start the recursive search of users from.
- Search
Filter stringTemplate - Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
- Server
Certificates []CertificateResponse - Server
Hostname string - Hostname of the LDAP server.
- Server
Port int - Port of the LDAP server.
- Service
User stringDistinguished Name - Distinguished name of the look up user account, who can look up user details on authentication.
- Service
User stringPassword - Password of the look up user.
- connection
Timeout IntegerIn Ms - Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
- search
Base StringDistinguished Name - Distinguished name of the object to start the recursive search of users from.
- search
Filter StringTemplate - Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
- server
Certificates List<CertificateResponse> - server
Hostname String - Hostname of the LDAP server.
- server
Port Integer - Port of the LDAP server.
- service
User StringDistinguished Name - Distinguished name of the look up user account, who can look up user details on authentication.
- service
User StringPassword - Password of the look up user.
- connection
Timeout numberIn Ms - Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
- search
Base stringDistinguished Name - Distinguished name of the object to start the recursive search of users from.
- search
Filter stringTemplate - Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
- server
Certificates CertificateResponse[] - server
Hostname string - Hostname of the LDAP server.
- server
Port number - Port of the LDAP server.
- service
User stringDistinguished Name - Distinguished name of the look up user account, who can look up user details on authentication.
- service
User stringPassword - Password of the look up user.
- connection_
timeout_ intin_ ms - Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
- search_
base_ strdistinguished_ name - Distinguished name of the object to start the recursive search of users from.
- search_
filter_ strtemplate - 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_ strdistinguished_ name - Distinguished name of the look up user account, who can look up user details on authentication.
- service_
user_ strpassword - Password of the look up user.
- connection
Timeout NumberIn Ms - Timeout for connecting to the LDAP server in miliseconds. The default is 5000 ms.
- search
Base StringDistinguished Name - Distinguished name of the object to start the recursive search of users from.
- search
Filter StringTemplate - Template to use for searching. Defaults to (cn=%s) where %s will be replaced by the username used to login.
- server
Certificates List<Property Map> - server
Hostname String - Hostname of the LDAP server.
- server
Port Number - Port of the LDAP server.
- service
User StringDistinguished Name - Distinguished name of the look up user account, who can look up user details on authentication.
- service
User StringPassword - Password of the look up user.
CassandraErrorResponse
- Additional
Error stringInfo - 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 stringInfo - 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 StringInfo - 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 stringInfo - 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_ strinfo - 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.
- additional
Error StringInfo - 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
- Seed
Nodes List<Pulumi.Azure Native. Document DB. Inputs. Seed Node Response> - 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 Pulumi.Ldap Properties Azure Native. Document DB. Inputs. Authentication Method Ldap Properties Response - 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 stringCustomer Key Uri - Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
- Base64Encoded
Cassandra stringYaml Fragment - 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 stringLocation - The region this data center should be created in.
- Deallocated bool
- Whether the data center has been deallocated.
- Delegated
Subnet stringId - 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 string - Disk SKU used for data centers. Default value is P30.
- Managed
Disk stringCustomer Key Uri - 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 Pulumi.Azure Native. Document DB. Inputs. Cassandra Error Response - Error related to resource provisioning.
- Provisioning
State 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 []SeedNode Response - 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 AuthenticationLdap Properties Method Ldap Properties Response - 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 stringCustomer Key Uri - Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
- Base64Encoded
Cassandra stringYaml Fragment - 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 stringLocation - The region this data center should be created in.
- Deallocated bool
- Whether the data center has been deallocated.
- Delegated
Subnet stringId - 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 string - Disk SKU used for data centers. Default value is P30.
- Managed
Disk stringCustomer Key Uri - 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 CassandraError Response - Error related to resource provisioning.
- Provisioning
State 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 List<SeedNode Response> - 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 AuthenticationLdap Properties Method Ldap Properties Response - Ldap authentication method properties. This feature is in preview.
- availability
Zone Boolean - 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 StringCustomer Key Uri - Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
- base64Encoded
Cassandra StringYaml Fragment - 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 StringLocation - The region this data center should be created in.
- deallocated Boolean
- Whether the data center has been deallocated.
- delegated
Subnet StringId - 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 Integer - Number of disks attached to each node. Default is 4.
- disk
Sku String - Disk SKU used for data centers. Default value is P30.
- managed
Disk StringCustomer Key Uri - 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 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.
- provision
Error CassandraError Response - Error related to resource provisioning.
- provisioning
State 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 SeedNode Response[] - 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 AuthenticationLdap Properties Method Ldap Properties Response - Ldap authentication method properties. This feature is in preview.
- availability
Zone boolean - 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 stringCustomer Key Uri - Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
- base64Encoded
Cassandra stringYaml Fragment - 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 stringLocation - The region this data center should be created in.
- deallocated boolean
- Whether the data center has been deallocated.
- delegated
Subnet stringId - 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 number - Number of disks attached to each node. Default is 4.
- disk
Sku string - Disk SKU used for data centers. Default value is P30.
- managed
Disk stringCustomer Key Uri - 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 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.
- provision
Error CassandraError Response - Error related to resource provisioning.
- provisioning
State 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[SeedNode Response] - 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_ Authenticationldap_ properties Method Ldap Properties Response - 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_ strcustomer_ key_ uri - Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
- base64_
encoded_ strcassandra_ yaml_ fragment - 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_ strlocation - The region this data center should be created in.
- deallocated bool
- Whether the data center has been deallocated.
- delegated_
subnet_ strid - 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_ strcustomer_ key_ uri - 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 CassandraError Response - 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
- seed
Nodes 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.
- authentication
Method Property MapLdap Properties - Ldap authentication method properties. This feature is in preview.
- availability
Zone Boolean - 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 StringCustomer Key Uri - Indicates the Key Uri of the customer key to use for encryption of the backup storage account.
- base64Encoded
Cassandra StringYaml Fragment - 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 StringLocation - The region this data center should be created in.
- deallocated Boolean
- Whether the data center has been deallocated.
- delegated
Subnet StringId - 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 Number - Number of disks attached to each node. Default is 4.
- disk
Sku String - Disk SKU used for data centers. Default value is P30.
- managed
Disk StringCustomer Key Uri - 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 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.
- provision
Error Property Map - Error related to resource provisioning.
- provisioning
State 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
- Ip
Address string - IP address of this seed node.
- Ip
Address string - IP address of this seed node.
- ip
Address String - IP address of this seed node.
- ip
Address string - IP address of this seed node.
- ip_
address str - IP address of this seed node.
- ip
Address 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.63.0 published on Tuesday, Sep 24, 2024 by Pulumi