azure-native.kubernetes.getConnectedCluster
Explore with Pulumi AI
Returns the properties of the specified connected cluster, including name, identity, properties, and additional cluster details. Azure REST API version: 2022-05-01-preview.
Using getConnectedCluster
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 getConnectedCluster(args: GetConnectedClusterArgs, opts?: InvokeOptions): Promise<GetConnectedClusterResult>
function getConnectedClusterOutput(args: GetConnectedClusterOutputArgs, opts?: InvokeOptions): Output<GetConnectedClusterResult>
def get_connected_cluster(cluster_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetConnectedClusterResult
def get_connected_cluster_output(cluster_name: Optional[pulumi.Input[str]] = None,
resource_group_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetConnectedClusterResult]
func LookupConnectedCluster(ctx *Context, args *LookupConnectedClusterArgs, opts ...InvokeOption) (*LookupConnectedClusterResult, error)
func LookupConnectedClusterOutput(ctx *Context, args *LookupConnectedClusterOutputArgs, opts ...InvokeOption) LookupConnectedClusterResultOutput
> Note: This function is named LookupConnectedCluster
in the Go SDK.
public static class GetConnectedCluster
{
public static Task<GetConnectedClusterResult> InvokeAsync(GetConnectedClusterArgs args, InvokeOptions? opts = null)
public static Output<GetConnectedClusterResult> Invoke(GetConnectedClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetConnectedClusterResult> getConnectedCluster(GetConnectedClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:kubernetes:getConnectedCluster
arguments:
# arguments dictionary
The following arguments are supported:
- Cluster
Name string The name of the Kubernetes cluster on which get is called.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Cluster
Name string The name of the Kubernetes cluster on which get is called.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- cluster
Name String The name of the Kubernetes cluster on which get is called.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- cluster
Name string The name of the Kubernetes cluster on which get is called.
- resource
Group stringName The name of the resource group. The name is case insensitive.
- cluster_
name str The name of the Kubernetes cluster on which get is called.
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- cluster
Name String The name of the Kubernetes cluster on which get is called.
- resource
Group StringName The name of the resource group. The name is case insensitive.
getConnectedCluster Result
The following output properties are available:
- Agent
Public stringKey Certificate Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
- Agent
Version string Version of the agent running on the connected cluster resource
- Connectivity
Status string Represents the connectivity status of the connected cluster.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Identity
Pulumi.
Azure Native. Kubernetes. Outputs. Connected Cluster Identity Response The identity of the connected cluster.
- Kubernetes
Version string The Kubernetes version of the connected cluster resource
- Last
Connectivity stringTime Time representing the last instance when heart beat was received from the cluster
- Location string
The geo-location where the resource lives
- Managed
Identity stringCertificate Expiration Time Expiration time of the managed identity certificate
- Name string
The name of the resource
- Offering string
Connected cluster offering
- System
Data Pulumi.Azure Native. Kubernetes. Outputs. System Data Response Metadata pertaining to creation and last modification of the resource
- Total
Core intCount Number of CPU cores present in the connected cluster resource
- Total
Node intCount Number of nodes present in the connected cluster resource
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Distribution string
The Kubernetes distribution running on this connected cluster.
- Infrastructure string
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
- Private
Link stringScope Resource Id The resource id of the private link scope this connected cluster is assigned to, if any.
- Private
Link stringState Property which describes the state of private link on a connected cluster resource.
- Provisioning
State string Provisioning state of the connected cluster resource.
- Dictionary<string, string>
Resource tags.
- Agent
Public stringKey Certificate Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
- Agent
Version string Version of the agent running on the connected cluster resource
- Connectivity
Status string Represents the connectivity status of the connected cluster.
- Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- Identity
Connected
Cluster Identity Response The identity of the connected cluster.
- Kubernetes
Version string The Kubernetes version of the connected cluster resource
- Last
Connectivity stringTime Time representing the last instance when heart beat was received from the cluster
- Location string
The geo-location where the resource lives
- Managed
Identity stringCertificate Expiration Time Expiration time of the managed identity certificate
- Name string
The name of the resource
- Offering string
Connected cluster offering
- System
Data SystemData Response Metadata pertaining to creation and last modification of the resource
- Total
Core intCount Number of CPU cores present in the connected cluster resource
- Total
Node intCount Number of nodes present in the connected cluster resource
- Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Distribution string
The Kubernetes distribution running on this connected cluster.
- Infrastructure string
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
- Private
Link stringScope Resource Id The resource id of the private link scope this connected cluster is assigned to, if any.
- Private
Link stringState Property which describes the state of private link on a connected cluster resource.
- Provisioning
State string Provisioning state of the connected cluster resource.
- map[string]string
Resource tags.
- agent
Public StringKey Certificate Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
- agent
Version String Version of the agent running on the connected cluster resource
- connectivity
Status String Represents the connectivity status of the connected cluster.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- identity
Connected
Cluster Identity Response The identity of the connected cluster.
- kubernetes
Version String The Kubernetes version of the connected cluster resource
- last
Connectivity StringTime Time representing the last instance when heart beat was received from the cluster
- location String
The geo-location where the resource lives
- managed
Identity StringCertificate Expiration Time Expiration time of the managed identity certificate
- name String
The name of the resource
- offering String
Connected cluster offering
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource
- total
Core IntegerCount Number of CPU cores present in the connected cluster resource
- total
Node IntegerCount Number of nodes present in the connected cluster resource
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- distribution String
The Kubernetes distribution running on this connected cluster.
- infrastructure String
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
- private
Link StringScope Resource Id The resource id of the private link scope this connected cluster is assigned to, if any.
- private
Link StringState Property which describes the state of private link on a connected cluster resource.
- provisioning
State String Provisioning state of the connected cluster resource.
- Map<String,String>
Resource tags.
- agent
Public stringKey Certificate Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
- agent
Version string Version of the agent running on the connected cluster resource
- connectivity
Status string Represents the connectivity status of the connected cluster.
- id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- identity
Connected
Cluster Identity Response The identity of the connected cluster.
- kubernetes
Version string The Kubernetes version of the connected cluster resource
- last
Connectivity stringTime Time representing the last instance when heart beat was received from the cluster
- location string
The geo-location where the resource lives
- managed
Identity stringCertificate Expiration Time Expiration time of the managed identity certificate
- name string
The name of the resource
- offering string
Connected cluster offering
- system
Data SystemData Response Metadata pertaining to creation and last modification of the resource
- total
Core numberCount Number of CPU cores present in the connected cluster resource
- total
Node numberCount Number of nodes present in the connected cluster resource
- type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- distribution string
The Kubernetes distribution running on this connected cluster.
- infrastructure string
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
- private
Link stringScope Resource Id The resource id of the private link scope this connected cluster is assigned to, if any.
- private
Link stringState Property which describes the state of private link on a connected cluster resource.
- provisioning
State string Provisioning state of the connected cluster resource.
- {[key: string]: string}
Resource tags.
- agent_
public_ strkey_ certificate Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
- agent_
version str Version of the agent running on the connected cluster resource
- connectivity_
status str Represents the connectivity status of the connected cluster.
- id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- identity
Connected
Cluster Identity Response The identity of the connected cluster.
- kubernetes_
version str The Kubernetes version of the connected cluster resource
- last_
connectivity_ strtime Time representing the last instance when heart beat was received from the cluster
- location str
The geo-location where the resource lives
- managed_
identity_ strcertificate_ expiration_ time Expiration time of the managed identity certificate
- name str
The name of the resource
- offering str
Connected cluster offering
- system_
data SystemData Response Metadata pertaining to creation and last modification of the resource
- total_
core_ intcount Number of CPU cores present in the connected cluster resource
- total_
node_ intcount Number of nodes present in the connected cluster resource
- type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- distribution str
The Kubernetes distribution running on this connected cluster.
- infrastructure str
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
- private_
link_ strscope_ resource_ id The resource id of the private link scope this connected cluster is assigned to, if any.
- private_
link_ strstate Property which describes the state of private link on a connected cluster resource.
- provisioning_
state str Provisioning state of the connected cluster resource.
- Mapping[str, str]
Resource tags.
- agent
Public StringKey Certificate Base64 encoded public certificate used by the agent to do the initial handshake to the backend services in Azure.
- agent
Version String Version of the agent running on the connected cluster resource
- connectivity
Status String Represents the connectivity status of the connected cluster.
- id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
- identity Property Map
The identity of the connected cluster.
- kubernetes
Version String The Kubernetes version of the connected cluster resource
- last
Connectivity StringTime Time representing the last instance when heart beat was received from the cluster
- location String
The geo-location where the resource lives
- managed
Identity StringCertificate Expiration Time Expiration time of the managed identity certificate
- name String
The name of the resource
- offering String
Connected cluster offering
- system
Data Property Map Metadata pertaining to creation and last modification of the resource
- total
Core NumberCount Number of CPU cores present in the connected cluster resource
- total
Node NumberCount Number of nodes present in the connected cluster resource
- type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- distribution String
The Kubernetes distribution running on this connected cluster.
- infrastructure String
The infrastructure on which the Kubernetes cluster represented by this connected cluster is running on.
- private
Link StringScope Resource Id The resource id of the private link scope this connected cluster is assigned to, if any.
- private
Link StringState Property which describes the state of private link on a connected cluster resource.
- provisioning
State String Provisioning state of the connected cluster resource.
- Map<String>
Resource tags.
Supporting Types
ConnectedClusterIdentityResponse
- Principal
Id string The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
- Tenant
Id string The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
- Type string
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
- Principal
Id string The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
- Tenant
Id string The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
- Type string
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
- principal
Id String The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
- tenant
Id String The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
- type String
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
- principal
Id string The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
- tenant
Id string The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
- type string
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
- principal_
id str The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
- tenant_
id str The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
- type str
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
- principal
Id String The principal id of connected cluster identity. This property will only be provided for a system assigned identity.
- tenant
Id String The tenant id associated with the connected cluster. This property will only be provided for a system assigned identity.
- type String
The type of identity used for the connected cluster. The type 'SystemAssigned, includes a system created identity. The type 'None' means no identity is assigned to the connected cluster.
SystemDataResponse
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource modification (UTC).
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- Created
At string The timestamp of resource creation (UTC).
- Created
By string The identity that created the resource.
- Created
By stringType The type of identity that created the resource.
- Last
Modified stringAt The timestamp of resource modification (UTC).
- Last
Modified stringBy The identity that last modified the resource.
- Last
Modified stringBy Type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource modification (UTC).
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
- created
At string The timestamp of resource creation (UTC).
- created
By string The identity that created the resource.
- created
By stringType The type of identity that created the resource.
- last
Modified stringAt The timestamp of resource modification (UTC).
- last
Modified stringBy The identity that last modified the resource.
- last
Modified stringBy Type The type of identity that last modified the resource.
- created_
at str The timestamp of resource creation (UTC).
- created_
by str The identity that created the resource.
- created_
by_ strtype The type of identity that created the resource.
- last_
modified_ strat The timestamp of resource modification (UTC).
- last_
modified_ strby The identity that last modified the resource.
- last_
modified_ strby_ type The type of identity that last modified the resource.
- created
At String The timestamp of resource creation (UTC).
- created
By String The identity that created the resource.
- created
By StringType The type of identity that created the resource.
- last
Modified StringAt The timestamp of resource modification (UTC).
- last
Modified StringBy The identity that last modified the resource.
- last
Modified StringBy Type The type of identity that last modified the resource.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0