Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.2 published on Tuesday, Aug 16, 2022 by Pulumi

getOpenShiftCluster

OpenShiftCluster represents an Azure Red Hat OpenShift cluster. API Version: 2020-04-30.

Using getOpenShiftCluster

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 getOpenShiftCluster(args: GetOpenShiftClusterArgs, opts?: InvokeOptions): Promise<GetOpenShiftClusterResult>
function getOpenShiftClusterOutput(args: GetOpenShiftClusterOutputArgs, opts?: InvokeOptions): Output<GetOpenShiftClusterResult>
def get_open_shift_cluster(resource_group_name: Optional[str] = None,
                           resource_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetOpenShiftClusterResult
def get_open_shift_cluster_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                           resource_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetOpenShiftClusterResult]
func LookupOpenShiftCluster(ctx *Context, args *LookupOpenShiftClusterArgs, opts ...InvokeOption) (*LookupOpenShiftClusterResult, error)
func LookupOpenShiftClusterOutput(ctx *Context, args *LookupOpenShiftClusterOutputArgs, opts ...InvokeOption) LookupOpenShiftClusterResultOutput

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

public static class GetOpenShiftCluster 
{
    public static Task<GetOpenShiftClusterResult> InvokeAsync(GetOpenShiftClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetOpenShiftClusterResult> Invoke(GetOpenShiftClusterInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetOpenShiftClusterResult> getOpenShiftCluster(GetOpenShiftClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:redhatopenshift:getOpenShiftCluster
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ResourceName string

The name of the OpenShift cluster resource.

ResourceGroupName string

The name of the resource group. The name is case insensitive.

ResourceName string

The name of the OpenShift cluster resource.

resourceGroupName String

The name of the resource group. The name is case insensitive.

resourceName String

The name of the OpenShift cluster resource.

resourceGroupName string

The name of the resource group. The name is case insensitive.

resourceName string

The name of the OpenShift cluster resource.

resource_group_name str

The name of the resource group. The name is case insensitive.

resource_name str

The name of the OpenShift cluster resource.

resourceGroupName String

The name of the resource group. The name is case insensitive.

resourceName String

The name of the OpenShift cluster resource.

getOpenShiftCluster Result

The following output properties are available:

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Location string

The geo-location where the resource lives

Name string

The name of the resource

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ApiserverProfile Pulumi.AzureNative.RedHatOpenShift.Outputs.APIServerProfileResponse

The cluster API server profile.

ClusterProfile Pulumi.AzureNative.RedHatOpenShift.Outputs.ClusterProfileResponse

The cluster profile.

ConsoleProfile Pulumi.AzureNative.RedHatOpenShift.Outputs.ConsoleProfileResponse

The console profile.

IngressProfiles List<Pulumi.AzureNative.RedHatOpenShift.Outputs.IngressProfileResponse>

The cluster ingress profiles.

MasterProfile Pulumi.AzureNative.RedHatOpenShift.Outputs.MasterProfileResponse

The cluster master profile.

NetworkProfile Pulumi.AzureNative.RedHatOpenShift.Outputs.NetworkProfileResponse

The cluster network profile.

ProvisioningState string

The cluster provisioning state (immutable).

ServicePrincipalProfile Pulumi.AzureNative.RedHatOpenShift.Outputs.ServicePrincipalProfileResponse

The cluster service principal profile.

Tags Dictionary<string, string>

Resource tags.

WorkerProfiles List<Pulumi.AzureNative.RedHatOpenShift.Outputs.WorkerProfileResponse>

The cluster worker profiles.

Id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Location string

The geo-location where the resource lives

Name string

The name of the resource

Type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

ApiserverProfile APIServerProfileResponse

The cluster API server profile.

ClusterProfile ClusterProfileResponse

The cluster profile.

ConsoleProfile ConsoleProfileResponse

The console profile.

IngressProfiles []IngressProfileResponse

The cluster ingress profiles.

MasterProfile MasterProfileResponse

The cluster master profile.

NetworkProfile NetworkProfileResponse

The cluster network profile.

ProvisioningState string

The cluster provisioning state (immutable).

ServicePrincipalProfile ServicePrincipalProfileResponse

The cluster service principal profile.

Tags map[string]string

Resource tags.

WorkerProfiles []WorkerProfileResponse

The cluster worker profiles.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location String

The geo-location where the resource lives

name String

The name of the resource

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

apiserverProfile APIServerProfileResponse

The cluster API server profile.

clusterProfile ClusterProfileResponse

The cluster profile.

consoleProfile ConsoleProfileResponse

The console profile.

ingressProfiles List<IngressProfileResponse>

The cluster ingress profiles.

masterProfile MasterProfileResponse

The cluster master profile.

networkProfile NetworkProfileResponse

The cluster network profile.

provisioningState String

The cluster provisioning state (immutable).

servicePrincipalProfile ServicePrincipalProfileResponse

The cluster service principal profile.

tags Map<String,String>

Resource tags.

workerProfiles List<WorkerProfileResponse>

The cluster worker profiles.

id string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location string

The geo-location where the resource lives

name string

The name of the resource

type string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

apiserverProfile APIServerProfileResponse

The cluster API server profile.

clusterProfile ClusterProfileResponse

The cluster profile.

consoleProfile ConsoleProfileResponse

The console profile.

ingressProfiles IngressProfileResponse[]

The cluster ingress profiles.

masterProfile MasterProfileResponse

The cluster master profile.

networkProfile NetworkProfileResponse

The cluster network profile.

provisioningState string

The cluster provisioning state (immutable).

servicePrincipalProfile ServicePrincipalProfileResponse

The cluster service principal profile.

tags {[key: string]: string}

Resource tags.

workerProfiles WorkerProfileResponse[]

The cluster worker profiles.

id str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location str

The geo-location where the resource lives

name str

The name of the resource

type str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

apiserver_profile APIServerProfileResponse

The cluster API server profile.

cluster_profile ClusterProfileResponse

The cluster profile.

console_profile ConsoleProfileResponse

The console profile.

ingress_profiles Sequence[IngressProfileResponse]

The cluster ingress profiles.

master_profile MasterProfileResponse

The cluster master profile.

network_profile NetworkProfileResponse

The cluster network profile.

provisioning_state str

The cluster provisioning state (immutable).

service_principal_profile ServicePrincipalProfileResponse

The cluster service principal profile.

tags Mapping[str, str]

Resource tags.

worker_profiles Sequence[WorkerProfileResponse]

The cluster worker profiles.

id String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location String

The geo-location where the resource lives

name String

The name of the resource

type String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

apiserverProfile Property Map

The cluster API server profile.

clusterProfile Property Map

The cluster profile.

consoleProfile Property Map

The console profile.

ingressProfiles List<Property Map>

The cluster ingress profiles.

masterProfile Property Map

The cluster master profile.

networkProfile Property Map

The cluster network profile.

provisioningState String

The cluster provisioning state (immutable).

servicePrincipalProfile Property Map

The cluster service principal profile.

tags Map<String>

Resource tags.

workerProfiles List<Property Map>

The cluster worker profiles.

Supporting Types

APIServerProfileResponse

Ip string

The IP of the cluster API server (immutable).

Url string

The URL to access the cluster API server (immutable).

Visibility string

API server visibility (immutable).

Ip string

The IP of the cluster API server (immutable).

Url string

The URL to access the cluster API server (immutable).

Visibility string

API server visibility (immutable).

ip String

The IP of the cluster API server (immutable).

url String

The URL to access the cluster API server (immutable).

visibility String

API server visibility (immutable).

ip string

The IP of the cluster API server (immutable).

url string

The URL to access the cluster API server (immutable).

visibility string

API server visibility (immutable).

ip str

The IP of the cluster API server (immutable).

url str

The URL to access the cluster API server (immutable).

visibility str

API server visibility (immutable).

ip String

The IP of the cluster API server (immutable).

url String

The URL to access the cluster API server (immutable).

visibility String

API server visibility (immutable).

ClusterProfileResponse

Domain string

The domain for the cluster (immutable).

PullSecret string

The pull secret for the cluster (immutable).

ResourceGroupId string

The ID of the cluster resource group (immutable).

Version string

The version of the cluster (immutable).

Domain string

The domain for the cluster (immutable).

PullSecret string

The pull secret for the cluster (immutable).

ResourceGroupId string

The ID of the cluster resource group (immutable).

Version string

The version of the cluster (immutable).

domain String

The domain for the cluster (immutable).

pullSecret String

The pull secret for the cluster (immutable).

resourceGroupId String

The ID of the cluster resource group (immutable).

version String

The version of the cluster (immutable).

domain string

The domain for the cluster (immutable).

pullSecret string

The pull secret for the cluster (immutable).

resourceGroupId string

The ID of the cluster resource group (immutable).

version string

The version of the cluster (immutable).

domain str

The domain for the cluster (immutable).

pull_secret str

The pull secret for the cluster (immutable).

resource_group_id str

The ID of the cluster resource group (immutable).

version str

The version of the cluster (immutable).

domain String

The domain for the cluster (immutable).

pullSecret String

The pull secret for the cluster (immutable).

resourceGroupId String

The ID of the cluster resource group (immutable).

version String

The version of the cluster (immutable).

ConsoleProfileResponse

Url string

The URL to access the cluster console (immutable).

Url string

The URL to access the cluster console (immutable).

url String

The URL to access the cluster console (immutable).

url string

The URL to access the cluster console (immutable).

url str

The URL to access the cluster console (immutable).

url String

The URL to access the cluster console (immutable).

IngressProfileResponse

Ip string

The IP of the ingress (immutable).

Name string

The ingress profile name. Must be "default" (immutable).

Visibility string

Ingress visibility (immutable).

Ip string

The IP of the ingress (immutable).

Name string

The ingress profile name. Must be "default" (immutable).

Visibility string

Ingress visibility (immutable).

ip String

The IP of the ingress (immutable).

name String

The ingress profile name. Must be "default" (immutable).

visibility String

Ingress visibility (immutable).

ip string

The IP of the ingress (immutable).

name string

The ingress profile name. Must be "default" (immutable).

visibility string

Ingress visibility (immutable).

ip str

The IP of the ingress (immutable).

name str

The ingress profile name. Must be "default" (immutable).

visibility str

Ingress visibility (immutable).

ip String

The IP of the ingress (immutable).

name String

The ingress profile name. Must be "default" (immutable).

visibility String

Ingress visibility (immutable).

MasterProfileResponse

SubnetId string

The Azure resource ID of the master subnet (immutable).

VmSize string

The size of the master VMs (immutable).

SubnetId string

The Azure resource ID of the master subnet (immutable).

VmSize string

The size of the master VMs (immutable).

subnetId String

The Azure resource ID of the master subnet (immutable).

vmSize String

The size of the master VMs (immutable).

subnetId string

The Azure resource ID of the master subnet (immutable).

vmSize string

The size of the master VMs (immutable).

subnet_id str

The Azure resource ID of the master subnet (immutable).

vm_size str

The size of the master VMs (immutable).

subnetId String

The Azure resource ID of the master subnet (immutable).

vmSize String

The size of the master VMs (immutable).

NetworkProfileResponse

PodCidr string

The CIDR used for OpenShift/Kubernetes Pods (immutable).

ServiceCidr string

The CIDR used for OpenShift/Kubernetes Services (immutable).

PodCidr string

The CIDR used for OpenShift/Kubernetes Pods (immutable).

ServiceCidr string

The CIDR used for OpenShift/Kubernetes Services (immutable).

podCidr String

The CIDR used for OpenShift/Kubernetes Pods (immutable).

serviceCidr String

The CIDR used for OpenShift/Kubernetes Services (immutable).

podCidr string

The CIDR used for OpenShift/Kubernetes Pods (immutable).

serviceCidr string

The CIDR used for OpenShift/Kubernetes Services (immutable).

pod_cidr str

The CIDR used for OpenShift/Kubernetes Pods (immutable).

service_cidr str

The CIDR used for OpenShift/Kubernetes Services (immutable).

podCidr String

The CIDR used for OpenShift/Kubernetes Pods (immutable).

serviceCidr String

The CIDR used for OpenShift/Kubernetes Services (immutable).

ServicePrincipalProfileResponse

ClientId string

The client ID used for the cluster (immutable).

ClientSecret string

The client secret used for the cluster (immutable).

ClientId string

The client ID used for the cluster (immutable).

ClientSecret string

The client secret used for the cluster (immutable).

clientId String

The client ID used for the cluster (immutable).

clientSecret String

The client secret used for the cluster (immutable).

clientId string

The client ID used for the cluster (immutable).

clientSecret string

The client secret used for the cluster (immutable).

client_id str

The client ID used for the cluster (immutable).

client_secret str

The client secret used for the cluster (immutable).

clientId String

The client ID used for the cluster (immutable).

clientSecret String

The client secret used for the cluster (immutable).

WorkerProfileResponse

Count int

The number of worker VMs. Must be between 3 and 20 (immutable).

DiskSizeGB int

The disk size of the worker VMs. Must be 128 or greater (immutable).

Name string

The worker profile name. Must be "worker" (immutable).

SubnetId string

The Azure resource ID of the worker subnet (immutable).

VmSize string

The size of the worker VMs (immutable).

Count int

The number of worker VMs. Must be between 3 and 20 (immutable).

DiskSizeGB int

The disk size of the worker VMs. Must be 128 or greater (immutable).

Name string

The worker profile name. Must be "worker" (immutable).

SubnetId string

The Azure resource ID of the worker subnet (immutable).

VmSize string

The size of the worker VMs (immutable).

count Integer

The number of worker VMs. Must be between 3 and 20 (immutable).

diskSizeGB Integer

The disk size of the worker VMs. Must be 128 or greater (immutable).

name String

The worker profile name. Must be "worker" (immutable).

subnetId String

The Azure resource ID of the worker subnet (immutable).

vmSize String

The size of the worker VMs (immutable).

count number

The number of worker VMs. Must be between 3 and 20 (immutable).

diskSizeGB number

The disk size of the worker VMs. Must be 128 or greater (immutable).

name string

The worker profile name. Must be "worker" (immutable).

subnetId string

The Azure resource ID of the worker subnet (immutable).

vmSize string

The size of the worker VMs (immutable).

count int

The number of worker VMs. Must be between 3 and 20 (immutable).

disk_size_gb int

The disk size of the worker VMs. Must be 128 or greater (immutable).

name str

The worker profile name. Must be "worker" (immutable).

subnet_id str

The Azure resource ID of the worker subnet (immutable).

vm_size str

The size of the worker VMs (immutable).

count Number

The number of worker VMs. Must be between 3 and 20 (immutable).

diskSizeGB Number

The disk size of the worker VMs. Must be 128 or greater (immutable).

name String

The worker profile name. Must be "worker" (immutable).

subnetId String

The Azure resource ID of the worker subnet (immutable).

vmSize String

The size of the worker VMs (immutable).

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0