Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. confluent
  5. listAccessClusters
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.confluent.listAccessClusters

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Details of the clusters returned on successful response

Uses Azure REST API version 2024-07-01.

Other available API versions: 2023-08-22, 2024-02-13. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native confluent [ApiVersion]. See the version guide for details.

Using listAccessClusters

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 listAccessClusters(args: ListAccessClustersArgs, opts?: InvokeOptions): Promise<ListAccessClustersResult>
function listAccessClustersOutput(args: ListAccessClustersOutputArgs, opts?: InvokeOptions): Output<ListAccessClustersResult>
Copy
def list_access_clusters(organization_name: Optional[str] = None,
                         resource_group_name: Optional[str] = None,
                         search_filters: Optional[Mapping[str, str]] = None,
                         opts: Optional[InvokeOptions] = None) -> ListAccessClustersResult
def list_access_clusters_output(organization_name: Optional[pulumi.Input[str]] = None,
                         resource_group_name: Optional[pulumi.Input[str]] = None,
                         search_filters: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[ListAccessClustersResult]
Copy
func ListAccessClusters(ctx *Context, args *ListAccessClustersArgs, opts ...InvokeOption) (*ListAccessClustersResult, error)
func ListAccessClustersOutput(ctx *Context, args *ListAccessClustersOutputArgs, opts ...InvokeOption) ListAccessClustersResultOutput
Copy

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

public static class ListAccessClusters 
{
    public static Task<ListAccessClustersResult> InvokeAsync(ListAccessClustersArgs args, InvokeOptions? opts = null)
    public static Output<ListAccessClustersResult> Invoke(ListAccessClustersInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<ListAccessClustersResult> listAccessClusters(ListAccessClustersArgs args, InvokeOptions options)
public static Output<ListAccessClustersResult> listAccessClusters(ListAccessClustersArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:confluent:listAccessClusters
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OrganizationName
This property is required.
Changes to this property will trigger replacement.
string
Organization resource name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SearchFilters Dictionary<string, string>
Search filters for the request
OrganizationName
This property is required.
Changes to this property will trigger replacement.
string
Organization resource name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SearchFilters map[string]string
Search filters for the request
organizationName
This property is required.
Changes to this property will trigger replacement.
String
Organization resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
searchFilters Map<String,String>
Search filters for the request
organizationName
This property is required.
Changes to this property will trigger replacement.
string
Organization resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
searchFilters {[key: string]: string}
Search filters for the request
organization_name
This property is required.
Changes to this property will trigger replacement.
str
Organization resource name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
search_filters Mapping[str, str]
Search filters for the request
organizationName
This property is required.
Changes to this property will trigger replacement.
String
Organization resource name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
searchFilters Map<String>
Search filters for the request

listAccessClusters Result

The following output properties are available:

Data []ClusterRecordResponse
List of clusters
Kind string
Type of response
Metadata ConfluentListMetadataResponse
Metadata of the list
data List<ClusterRecordResponse>
List of clusters
kind String
Type of response
metadata ConfluentListMetadataResponse
Metadata of the list
data ClusterRecordResponse[]
List of clusters
kind string
Type of response
metadata ConfluentListMetadataResponse
Metadata of the list
data Sequence[ClusterRecordResponse]
List of clusters
kind str
Type of response
metadata ConfluentListMetadataResponse
Metadata of the list
data List<Property Map>
List of clusters
kind String
Type of response
metadata Property Map
Metadata of the list

Supporting Types

ClusterByokEntityResponse

Id string
ID of the referred resource
Related string
API URL for accessing or modifying the referred object
ResourceName string
CRN reference to the referred resource
Id string
ID of the referred resource
Related string
API URL for accessing or modifying the referred object
ResourceName string
CRN reference to the referred resource
id String
ID of the referred resource
related String
API URL for accessing or modifying the referred object
resourceName String
CRN reference to the referred resource
id string
ID of the referred resource
related string
API URL for accessing or modifying the referred object
resourceName string
CRN reference to the referred resource
id str
ID of the referred resource
related str
API URL for accessing or modifying the referred object
resource_name str
CRN reference to the referred resource
id String
ID of the referred resource
related String
API URL for accessing or modifying the referred object
resourceName String
CRN reference to the referred resource

ClusterConfigEntityResponse

Kind string
The lifecycle phase of the cluster
Kind string
The lifecycle phase of the cluster
kind String
The lifecycle phase of the cluster
kind string
The lifecycle phase of the cluster
kind str
The lifecycle phase of the cluster
kind String
The lifecycle phase of the cluster

ClusterEnvironmentEntityResponse

Environment string
Environment of the referred resource
Id string
ID of the referred resource
Related string
API URL for accessing or modifying the referred object
ResourceName string
CRN reference to the referred resource
Environment string
Environment of the referred resource
Id string
ID of the referred resource
Related string
API URL for accessing or modifying the referred object
ResourceName string
CRN reference to the referred resource
environment String
Environment of the referred resource
id String
ID of the referred resource
related String
API URL for accessing or modifying the referred object
resourceName String
CRN reference to the referred resource
environment string
Environment of the referred resource
id string
ID of the referred resource
related string
API URL for accessing or modifying the referred object
resourceName string
CRN reference to the referred resource
environment str
Environment of the referred resource
id str
ID of the referred resource
related str
API URL for accessing or modifying the referred object
resource_name str
CRN reference to the referred resource
environment String
Environment of the referred resource
id String
ID of the referred resource
related String
API URL for accessing or modifying the referred object
resourceName String
CRN reference to the referred resource

ClusterNetworkEntityResponse

Environment string
Environment of the referred resource
Id string
ID of the referred resource
Related string
API URL for accessing or modifying the referred object
ResourceName string
CRN reference to the referred resource
Environment string
Environment of the referred resource
Id string
ID of the referred resource
Related string
API URL for accessing or modifying the referred object
ResourceName string
CRN reference to the referred resource
environment String
Environment of the referred resource
id String
ID of the referred resource
related String
API URL for accessing or modifying the referred object
resourceName String
CRN reference to the referred resource
environment string
Environment of the referred resource
id string
ID of the referred resource
related string
API URL for accessing or modifying the referred object
resourceName string
CRN reference to the referred resource
environment str
Environment of the referred resource
id str
ID of the referred resource
related str
API URL for accessing or modifying the referred object
resource_name str
CRN reference to the referred resource
environment String
Environment of the referred resource
id String
ID of the referred resource
related String
API URL for accessing or modifying the referred object
resourceName String
CRN reference to the referred resource

ClusterRecordResponse

DisplayName string
Display name of the cluster
Id string
Id of the cluster
Kind string
Type of cluster
Metadata Pulumi.AzureNative.Confluent.Inputs.MetadataEntityResponse
Metadata of the record
Spec Pulumi.AzureNative.Confluent.Inputs.ClusterSpecEntityResponse
Specification of the cluster
Status Pulumi.AzureNative.Confluent.Inputs.ClusterStatusEntityResponse
Specification of the cluster
DisplayName string
Display name of the cluster
Id string
Id of the cluster
Kind string
Type of cluster
Metadata MetadataEntityResponse
Metadata of the record
Spec ClusterSpecEntityResponse
Specification of the cluster
Status ClusterStatusEntityResponse
Specification of the cluster
displayName String
Display name of the cluster
id String
Id of the cluster
kind String
Type of cluster
metadata MetadataEntityResponse
Metadata of the record
spec ClusterSpecEntityResponse
Specification of the cluster
status ClusterStatusEntityResponse
Specification of the cluster
displayName string
Display name of the cluster
id string
Id of the cluster
kind string
Type of cluster
metadata MetadataEntityResponse
Metadata of the record
spec ClusterSpecEntityResponse
Specification of the cluster
status ClusterStatusEntityResponse
Specification of the cluster
display_name str
Display name of the cluster
id str
Id of the cluster
kind str
Type of cluster
metadata MetadataEntityResponse
Metadata of the record
spec ClusterSpecEntityResponse
Specification of the cluster
status ClusterStatusEntityResponse
Specification of the cluster
displayName String
Display name of the cluster
id String
Id of the cluster
kind String
Type of cluster
metadata Property Map
Metadata of the record
spec Property Map
Specification of the cluster
status Property Map
Specification of the cluster

ClusterSpecEntityResponse

ApiEndpoint string
The Kafka API cluster endpoint
Availability string
The availability zone configuration of the cluster
Byok Pulumi.AzureNative.Confluent.Inputs.ClusterByokEntityResponse
Specification of the cluster
Cloud string
The cloud service provider
Config Pulumi.AzureNative.Confluent.Inputs.ClusterConfigEntityResponse
Specification of the cluster
DisplayName string
The name of the cluster
Environment Pulumi.AzureNative.Confluent.Inputs.ClusterEnvironmentEntityResponse
Specification of the cluster
HttpEndpoint string
The cluster HTTP request URL.
KafkaBootstrapEndpoint string
The bootstrap endpoint used by Kafka clients to connect to the cluster
Network Pulumi.AzureNative.Confluent.Inputs.ClusterNetworkEntityResponse
Specification of the cluster
Region string
The cloud service provider region
Zone string
type of zone availability
ApiEndpoint string
The Kafka API cluster endpoint
Availability string
The availability zone configuration of the cluster
Byok ClusterByokEntityResponse
Specification of the cluster
Cloud string
The cloud service provider
Config ClusterConfigEntityResponse
Specification of the cluster
DisplayName string
The name of the cluster
Environment ClusterEnvironmentEntityResponse
Specification of the cluster
HttpEndpoint string
The cluster HTTP request URL.
KafkaBootstrapEndpoint string
The bootstrap endpoint used by Kafka clients to connect to the cluster
Network ClusterNetworkEntityResponse
Specification of the cluster
Region string
The cloud service provider region
Zone string
type of zone availability
apiEndpoint String
The Kafka API cluster endpoint
availability String
The availability zone configuration of the cluster
byok ClusterByokEntityResponse
Specification of the cluster
cloud String
The cloud service provider
config ClusterConfigEntityResponse
Specification of the cluster
displayName String
The name of the cluster
environment ClusterEnvironmentEntityResponse
Specification of the cluster
httpEndpoint String
The cluster HTTP request URL.
kafkaBootstrapEndpoint String
The bootstrap endpoint used by Kafka clients to connect to the cluster
network ClusterNetworkEntityResponse
Specification of the cluster
region String
The cloud service provider region
zone String
type of zone availability
apiEndpoint string
The Kafka API cluster endpoint
availability string
The availability zone configuration of the cluster
byok ClusterByokEntityResponse
Specification of the cluster
cloud string
The cloud service provider
config ClusterConfigEntityResponse
Specification of the cluster
displayName string
The name of the cluster
environment ClusterEnvironmentEntityResponse
Specification of the cluster
httpEndpoint string
The cluster HTTP request URL.
kafkaBootstrapEndpoint string
The bootstrap endpoint used by Kafka clients to connect to the cluster
network ClusterNetworkEntityResponse
Specification of the cluster
region string
The cloud service provider region
zone string
type of zone availability
api_endpoint str
The Kafka API cluster endpoint
availability str
The availability zone configuration of the cluster
byok ClusterByokEntityResponse
Specification of the cluster
cloud str
The cloud service provider
config ClusterConfigEntityResponse
Specification of the cluster
display_name str
The name of the cluster
environment ClusterEnvironmentEntityResponse
Specification of the cluster
http_endpoint str
The cluster HTTP request URL.
kafka_bootstrap_endpoint str
The bootstrap endpoint used by Kafka clients to connect to the cluster
network ClusterNetworkEntityResponse
Specification of the cluster
region str
The cloud service provider region
zone str
type of zone availability
apiEndpoint String
The Kafka API cluster endpoint
availability String
The availability zone configuration of the cluster
byok Property Map
Specification of the cluster
cloud String
The cloud service provider
config Property Map
Specification of the cluster
displayName String
The name of the cluster
environment Property Map
Specification of the cluster
httpEndpoint String
The cluster HTTP request URL.
kafkaBootstrapEndpoint String
The bootstrap endpoint used by Kafka clients to connect to the cluster
network Property Map
Specification of the cluster
region String
The cloud service provider region
zone String
type of zone availability

ClusterStatusEntityResponse

Cku int
The number of Confluent Kafka Units
Phase string
The lifecycle phase of the cluster
Cku int
The number of Confluent Kafka Units
Phase string
The lifecycle phase of the cluster
cku Integer
The number of Confluent Kafka Units
phase String
The lifecycle phase of the cluster
cku number
The number of Confluent Kafka Units
phase string
The lifecycle phase of the cluster
cku int
The number of Confluent Kafka Units
phase str
The lifecycle phase of the cluster
cku Number
The number of Confluent Kafka Units
phase String
The lifecycle phase of the cluster

ConfluentListMetadataResponse

First string
First page of the list
Last string
Last page of the list
Next string
Next page of the list
Prev string
Previous page of the list
TotalSize int
Total size of the list
First string
First page of the list
Last string
Last page of the list
Next string
Next page of the list
Prev string
Previous page of the list
TotalSize int
Total size of the list
first String
First page of the list
last String
Last page of the list
next String
Next page of the list
prev String
Previous page of the list
totalSize Integer
Total size of the list
first string
First page of the list
last string
Last page of the list
next string
Next page of the list
prev string
Previous page of the list
totalSize number
Total size of the list
first str
First page of the list
last str
Last page of the list
next str
Next page of the list
prev str
Previous page of the list
total_size int
Total size of the list
first String
First page of the list
last String
Last page of the list
next String
Next page of the list
prev String
Previous page of the list
totalSize Number
Total size of the list

MetadataEntityResponse

CreatedAt string
Created Date Time
DeletedAt string
Deleted Date time
ResourceName string
Resource name of the record
Self string
Self lookup url
UpdatedAt string
Updated Date time
CreatedAt string
Created Date Time
DeletedAt string
Deleted Date time
ResourceName string
Resource name of the record
Self string
Self lookup url
UpdatedAt string
Updated Date time
createdAt String
Created Date Time
deletedAt String
Deleted Date time
resourceName String
Resource name of the record
self String
Self lookup url
updatedAt String
Updated Date time
createdAt string
Created Date Time
deletedAt string
Deleted Date time
resourceName string
Resource name of the record
self string
Self lookup url
updatedAt string
Updated Date time
created_at str
Created Date Time
deleted_at str
Deleted Date time
resource_name str
Resource name of the record
self str
Self lookup url
updated_at str
Updated Date time
createdAt String
Created Date Time
deletedAt String
Deleted Date time
resourceName String
Resource name of the record
self String
Self lookup url
updatedAt String
Updated Date time

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 v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native