Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. redhatopenshift
  5. getOpenShiftCluster
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.redhatopenshift.getOpenShiftCluster

Explore with Pulumi AI

azure-native logo
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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
pulumi/pulumi-azure-native

    The operation returns properties of a OpenShift cluster. Azure REST API version: 2022-09-04.

    Other available API versions: 2023-04-01, 2023-07-01-preview, 2023-09-04, 2023-11-22, 2024-08-12-preview.

    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)
public static Output<GetOpenShiftClusterResult> getOpenShiftCluster(GetOpenShiftClusterArgs args, InvokeOptions options)

    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
    SystemData Pulumi.AzureNative.RedHatOpenShift.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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.
    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
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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.
    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
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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.
    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
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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.
    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
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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.
    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
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    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.
    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.
    Url string
    The URL to access the cluster API server.
    Visibility string
    API server visibility.
    Ip string
    The IP of the cluster API server.
    Url string
    The URL to access the cluster API server.
    Visibility string
    API server visibility.
    ip String
    The IP of the cluster API server.
    url String
    The URL to access the cluster API server.
    visibility String
    API server visibility.
    ip string
    The IP of the cluster API server.
    url string
    The URL to access the cluster API server.
    visibility string
    API server visibility.
    ip str
    The IP of the cluster API server.
    url str
    The URL to access the cluster API server.
    visibility str
    API server visibility.
    ip String
    The IP of the cluster API server.
    url String
    The URL to access the cluster API server.
    visibility String
    API server visibility.

    ClusterProfileResponse

    Domain string
    The domain for the cluster.
    FipsValidatedModules string
    If FIPS validated crypto modules are used
    PullSecret string
    The pull secret for the cluster.
    ResourceGroupId string
    The ID of the cluster resource group.
    Version string
    The version of the cluster.
    Domain string
    The domain for the cluster.
    FipsValidatedModules string
    If FIPS validated crypto modules are used
    PullSecret string
    The pull secret for the cluster.
    ResourceGroupId string
    The ID of the cluster resource group.
    Version string
    The version of the cluster.
    domain String
    The domain for the cluster.
    fipsValidatedModules String
    If FIPS validated crypto modules are used
    pullSecret String
    The pull secret for the cluster.
    resourceGroupId String
    The ID of the cluster resource group.
    version String
    The version of the cluster.
    domain string
    The domain for the cluster.
    fipsValidatedModules string
    If FIPS validated crypto modules are used
    pullSecret string
    The pull secret for the cluster.
    resourceGroupId string
    The ID of the cluster resource group.
    version string
    The version of the cluster.
    domain str
    The domain for the cluster.
    fips_validated_modules str
    If FIPS validated crypto modules are used
    pull_secret str
    The pull secret for the cluster.
    resource_group_id str
    The ID of the cluster resource group.
    version str
    The version of the cluster.
    domain String
    The domain for the cluster.
    fipsValidatedModules String
    If FIPS validated crypto modules are used
    pullSecret String
    The pull secret for the cluster.
    resourceGroupId String
    The ID of the cluster resource group.
    version String
    The version of the cluster.

    ConsoleProfileResponse

    Url string
    The URL to access the cluster console.
    Url string
    The URL to access the cluster console.
    url String
    The URL to access the cluster console.
    url string
    The URL to access the cluster console.
    url str
    The URL to access the cluster console.
    url String
    The URL to access the cluster console.

    IngressProfileResponse

    Ip string
    The IP of the ingress.
    Name string
    The ingress profile name.
    Visibility string
    Ingress visibility.
    Ip string
    The IP of the ingress.
    Name string
    The ingress profile name.
    Visibility string
    Ingress visibility.
    ip String
    The IP of the ingress.
    name String
    The ingress profile name.
    visibility String
    Ingress visibility.
    ip string
    The IP of the ingress.
    name string
    The ingress profile name.
    visibility string
    Ingress visibility.
    ip str
    The IP of the ingress.
    name str
    The ingress profile name.
    visibility str
    Ingress visibility.
    ip String
    The IP of the ingress.
    name String
    The ingress profile name.
    visibility String
    Ingress visibility.

    MasterProfileResponse

    DiskEncryptionSetId string
    The resource ID of an associated DiskEncryptionSet, if applicable.
    EncryptionAtHost string
    Whether master virtual machines are encrypted at host.
    SubnetId string
    The Azure resource ID of the master subnet.
    VmSize string
    The size of the master VMs.
    DiskEncryptionSetId string
    The resource ID of an associated DiskEncryptionSet, if applicable.
    EncryptionAtHost string
    Whether master virtual machines are encrypted at host.
    SubnetId string
    The Azure resource ID of the master subnet.
    VmSize string
    The size of the master VMs.
    diskEncryptionSetId String
    The resource ID of an associated DiskEncryptionSet, if applicable.
    encryptionAtHost String
    Whether master virtual machines are encrypted at host.
    subnetId String
    The Azure resource ID of the master subnet.
    vmSize String
    The size of the master VMs.
    diskEncryptionSetId string
    The resource ID of an associated DiskEncryptionSet, if applicable.
    encryptionAtHost string
    Whether master virtual machines are encrypted at host.
    subnetId string
    The Azure resource ID of the master subnet.
    vmSize string
    The size of the master VMs.
    disk_encryption_set_id str
    The resource ID of an associated DiskEncryptionSet, if applicable.
    encryption_at_host str
    Whether master virtual machines are encrypted at host.
    subnet_id str
    The Azure resource ID of the master subnet.
    vm_size str
    The size of the master VMs.
    diskEncryptionSetId String
    The resource ID of an associated DiskEncryptionSet, if applicable.
    encryptionAtHost String
    Whether master virtual machines are encrypted at host.
    subnetId String
    The Azure resource ID of the master subnet.
    vmSize String
    The size of the master VMs.

    NetworkProfileResponse

    PodCidr string
    The CIDR used for OpenShift/Kubernetes Pods.
    ServiceCidr string
    The CIDR used for OpenShift/Kubernetes Services.
    PodCidr string
    The CIDR used for OpenShift/Kubernetes Pods.
    ServiceCidr string
    The CIDR used for OpenShift/Kubernetes Services.
    podCidr String
    The CIDR used for OpenShift/Kubernetes Pods.
    serviceCidr String
    The CIDR used for OpenShift/Kubernetes Services.
    podCidr string
    The CIDR used for OpenShift/Kubernetes Pods.
    serviceCidr string
    The CIDR used for OpenShift/Kubernetes Services.
    pod_cidr str
    The CIDR used for OpenShift/Kubernetes Pods.
    service_cidr str
    The CIDR used for OpenShift/Kubernetes Services.
    podCidr String
    The CIDR used for OpenShift/Kubernetes Pods.
    serviceCidr String
    The CIDR used for OpenShift/Kubernetes Services.

    ServicePrincipalProfileResponse

    ClientId string
    The client ID used for the cluster.
    ClientSecret string
    The client secret used for the cluster.
    ClientId string
    The client ID used for the cluster.
    ClientSecret string
    The client secret used for the cluster.
    clientId String
    The client ID used for the cluster.
    clientSecret String
    The client secret used for the cluster.
    clientId string
    The client ID used for the cluster.
    clientSecret string
    The client secret used for the cluster.
    client_id str
    The client ID used for the cluster.
    client_secret str
    The client secret used for the cluster.
    clientId String
    The client ID used for the cluster.
    clientSecret String
    The client secret used for the cluster.

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    WorkerProfileResponse

    Count int
    The number of worker VMs.
    DiskEncryptionSetId string
    The resource ID of an associated DiskEncryptionSet, if applicable.
    DiskSizeGB int
    The disk size of the worker VMs.
    EncryptionAtHost string
    Whether master virtual machines are encrypted at host.
    Name string
    The worker profile name.
    SubnetId string
    The Azure resource ID of the worker subnet.
    VmSize string
    The size of the worker VMs.
    Count int
    The number of worker VMs.
    DiskEncryptionSetId string
    The resource ID of an associated DiskEncryptionSet, if applicable.
    DiskSizeGB int
    The disk size of the worker VMs.
    EncryptionAtHost string
    Whether master virtual machines are encrypted at host.
    Name string
    The worker profile name.
    SubnetId string
    The Azure resource ID of the worker subnet.
    VmSize string
    The size of the worker VMs.
    count Integer
    The number of worker VMs.
    diskEncryptionSetId String
    The resource ID of an associated DiskEncryptionSet, if applicable.
    diskSizeGB Integer
    The disk size of the worker VMs.
    encryptionAtHost String
    Whether master virtual machines are encrypted at host.
    name String
    The worker profile name.
    subnetId String
    The Azure resource ID of the worker subnet.
    vmSize String
    The size of the worker VMs.
    count number
    The number of worker VMs.
    diskEncryptionSetId string
    The resource ID of an associated DiskEncryptionSet, if applicable.
    diskSizeGB number
    The disk size of the worker VMs.
    encryptionAtHost string
    Whether master virtual machines are encrypted at host.
    name string
    The worker profile name.
    subnetId string
    The Azure resource ID of the worker subnet.
    vmSize string
    The size of the worker VMs.
    count int
    The number of worker VMs.
    disk_encryption_set_id str
    The resource ID of an associated DiskEncryptionSet, if applicable.
    disk_size_gb int
    The disk size of the worker VMs.
    encryption_at_host str
    Whether master virtual machines are encrypted at host.
    name str
    The worker profile name.
    subnet_id str
    The Azure resource ID of the worker subnet.
    vm_size str
    The size of the worker VMs.
    count Number
    The number of worker VMs.
    diskEncryptionSetId String
    The resource ID of an associated DiskEncryptionSet, if applicable.
    diskSizeGB Number
    The disk size of the worker VMs.
    encryptionAtHost String
    Whether master virtual machines are encrypted at host.
    name String
    The worker profile name.
    subnetId String
    The Azure resource ID of the worker subnet.
    vmSize String
    The size of the worker VMs.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    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.89.1 published on Sunday, Mar 2, 2025 by Pulumi
    pulumi/pulumi-azure-native