Azure Native v2.20.1, Dec 1 23

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.20.1 published on Friday, Dec 1, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.containerservice.getOpenShiftManagedCluster

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.20.1 published on Friday, Dec 1, 2023 by Pulumi

pulumi/pulumi-azure-native

Using getOpenShiftManagedCluster

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 getOpenShiftManagedCluster(args: GetOpenShiftManagedClusterArgs, opts?: InvokeOptions): Promise<GetOpenShiftManagedClusterResult>
function getOpenShiftManagedClusterOutput(args: GetOpenShiftManagedClusterOutputArgs, opts?: InvokeOptions): Output<GetOpenShiftManagedClusterResult>

def get_open_shift_managed_cluster(resource_group_name: Optional[str] = None,
                                   resource_name: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetOpenShiftManagedClusterResult
def get_open_shift_managed_cluster_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                                   resource_name: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetOpenShiftManagedClusterResult]

func LookupOpenShiftManagedCluster(ctx *Context, args *LookupOpenShiftManagedClusterArgs, opts ...InvokeOption) (*LookupOpenShiftManagedClusterResult, error)
func LookupOpenShiftManagedClusterOutput(ctx *Context, args *LookupOpenShiftManagedClusterOutputArgs, opts ...InvokeOption) LookupOpenShiftManagedClusterResultOutput

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

public static class GetOpenShiftManagedCluster 
{
    public static Task<GetOpenShiftManagedClusterResult> InvokeAsync(GetOpenShiftManagedClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetOpenShiftManagedClusterResult> Invoke(GetOpenShiftManagedClusterInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetOpenShiftManagedClusterResult> getOpenShiftManagedCluster(GetOpenShiftManagedClusterArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:containerservice:getOpenShiftManagedCluster
  arguments:
    # arguments dictionary

The following arguments are supported:

ResourceGroupName string: The name of the resource group.
ResourceName string: The name of the OpenShift managed cluster resource.

ResourceGroupName string: The name of the resource group.
ResourceName string: The name of the OpenShift managed cluster resource.

resourceGroupName String: The name of the resource group.
resourceName String: The name of the OpenShift managed cluster resource.

resourceGroupName string: The name of the resource group.
resourceName string: The name of the OpenShift managed cluster resource.

resource_group_name str: The name of the resource group.
resource_name str: The name of the OpenShift managed cluster resource.

resourceGroupName String: The name of the resource group.
resourceName String: The name of the OpenShift managed cluster resource.

getOpenShiftManagedCluster Result

The following output properties are available:

ClusterVersion string: Version of OpenShift specified when creating the cluster.
Fqdn string: Service generated FQDN for OpenShift API server loadbalancer internal hostname.
Id string: Resource Id
Location string: Resource location
Name string: Resource name
OpenShiftVersion string: Version of OpenShift specified when creating the cluster.
ProvisioningState string: The current deployment or provisioning state, which only appears in the response.
PublicHostname string: Service generated FQDN or private IP for OpenShift API server.
Type string: Resource type
AgentPoolProfiles List<Pulumi.AzureNative.ContainerService.Outputs.OpenShiftManagedClusterAgentPoolProfileResponse>: Configuration of OpenShift cluster VMs.
AuthProfile Pulumi.AzureNative.ContainerService.Outputs.OpenShiftManagedClusterAuthProfileResponse: Configures OpenShift authentication.
MasterPoolProfile Pulumi.AzureNative.ContainerService.Outputs.OpenShiftManagedClusterMasterPoolProfileResponse: Configuration for OpenShift master VMs.
MonitorProfile Pulumi.AzureNative.ContainerService.Outputs.OpenShiftManagedClusterMonitorProfileResponse: Configures Log Analytics integration.
NetworkProfile Pulumi.AzureNative.ContainerService.Outputs.NetworkProfileResponse: Configuration for OpenShift networking.
Plan Pulumi.AzureNative.ContainerService.Outputs.PurchasePlanResponse: Define the resource plan as required by ARM for billing purposes
RefreshCluster bool: Allows node rotation
RouterProfiles List<Pulumi.AzureNative.ContainerService.Outputs.OpenShiftRouterProfileResponse>: Configuration for OpenShift router(s).
Tags Dictionary<string, string>: Resource tags

ClusterVersion string: Version of OpenShift specified when creating the cluster.
Fqdn string: Service generated FQDN for OpenShift API server loadbalancer internal hostname.
Id string: Resource Id
Location string: Resource location
Name string: Resource name
OpenShiftVersion string: Version of OpenShift specified when creating the cluster.
ProvisioningState string: The current deployment or provisioning state, which only appears in the response.
PublicHostname string: Service generated FQDN or private IP for OpenShift API server.
Type string: Resource type
AgentPoolProfiles []OpenShiftManagedClusterAgentPoolProfileResponse: Configuration of OpenShift cluster VMs.
AuthProfile OpenShiftManagedClusterAuthProfileResponse: Configures OpenShift authentication.
MasterPoolProfile OpenShiftManagedClusterMasterPoolProfileResponse: Configuration for OpenShift master VMs.
MonitorProfile OpenShiftManagedClusterMonitorProfileResponse: Configures Log Analytics integration.
NetworkProfile NetworkProfileResponse: Configuration for OpenShift networking.
Plan PurchasePlanResponse: Define the resource plan as required by ARM for billing purposes
RefreshCluster bool: Allows node rotation
RouterProfiles []OpenShiftRouterProfileResponse: Configuration for OpenShift router(s).
Tags map[string]string: Resource tags

clusterVersion String: Version of OpenShift specified when creating the cluster.
fqdn String: Service generated FQDN for OpenShift API server loadbalancer internal hostname.
id String: Resource Id
location String: Resource location
name String: Resource name
openShiftVersion String: Version of OpenShift specified when creating the cluster.
provisioningState String: The current deployment or provisioning state, which only appears in the response.
publicHostname String: Service generated FQDN or private IP for OpenShift API server.
type String: Resource type
agentPoolProfiles List<OpenShiftManagedClusterAgentPoolProfileResponse>: Configuration of OpenShift cluster VMs.
authProfile OpenShiftManagedClusterAuthProfileResponse: Configures OpenShift authentication.
masterPoolProfile OpenShiftManagedClusterMasterPoolProfileResponse: Configuration for OpenShift master VMs.
monitorProfile OpenShiftManagedClusterMonitorProfileResponse: Configures Log Analytics integration.
networkProfile NetworkProfileResponse: Configuration for OpenShift networking.
plan PurchasePlanResponse: Define the resource plan as required by ARM for billing purposes
refreshCluster Boolean: Allows node rotation
routerProfiles List<OpenShiftRouterProfileResponse>: Configuration for OpenShift router(s).
tags Map<String,String>: Resource tags

clusterVersion string: Version of OpenShift specified when creating the cluster.
fqdn string: Service generated FQDN for OpenShift API server loadbalancer internal hostname.
id string: Resource Id
location string: Resource location
name string: Resource name
openShiftVersion string: Version of OpenShift specified when creating the cluster.
provisioningState string: The current deployment or provisioning state, which only appears in the response.
publicHostname string: Service generated FQDN or private IP for OpenShift API server.
type string: Resource type
agentPoolProfiles OpenShiftManagedClusterAgentPoolProfileResponse[]: Configuration of OpenShift cluster VMs.
authProfile OpenShiftManagedClusterAuthProfileResponse: Configures OpenShift authentication.
masterPoolProfile OpenShiftManagedClusterMasterPoolProfileResponse: Configuration for OpenShift master VMs.
monitorProfile OpenShiftManagedClusterMonitorProfileResponse: Configures Log Analytics integration.
networkProfile NetworkProfileResponse: Configuration for OpenShift networking.
plan PurchasePlanResponse: Define the resource plan as required by ARM for billing purposes
refreshCluster boolean: Allows node rotation
routerProfiles OpenShiftRouterProfileResponse[]: Configuration for OpenShift router(s).
tags {[key: string]: string}: Resource tags

cluster_version str: Version of OpenShift specified when creating the cluster.
fqdn str: Service generated FQDN for OpenShift API server loadbalancer internal hostname.
id str: Resource Id
location str: Resource location
name str: Resource name
open_shift_version str: Version of OpenShift specified when creating the cluster.
provisioning_state str: The current deployment or provisioning state, which only appears in the response.
public_hostname str: Service generated FQDN or private IP for OpenShift API server.
type str: Resource type
agent_pool_profiles Sequence[OpenShiftManagedClusterAgentPoolProfileResponse]: Configuration of OpenShift cluster VMs.
auth_profile OpenShiftManagedClusterAuthProfileResponse: Configures OpenShift authentication.
master_pool_profile OpenShiftManagedClusterMasterPoolProfileResponse: Configuration for OpenShift master VMs.
monitor_profile OpenShiftManagedClusterMonitorProfileResponse: Configures Log Analytics integration.
network_profile NetworkProfileResponse: Configuration for OpenShift networking.
plan PurchasePlanResponse: Define the resource plan as required by ARM for billing purposes
refresh_cluster bool: Allows node rotation
router_profiles Sequence[OpenShiftRouterProfileResponse]: Configuration for OpenShift router(s).
tags Mapping[str, str]: Resource tags

clusterVersion String: Version of OpenShift specified when creating the cluster.
fqdn String: Service generated FQDN for OpenShift API server loadbalancer internal hostname.
id String: Resource Id
location String: Resource location
name String: Resource name
openShiftVersion String: Version of OpenShift specified when creating the cluster.
provisioningState String: The current deployment or provisioning state, which only appears in the response.
publicHostname String: Service generated FQDN or private IP for OpenShift API server.
type String: Resource type
agentPoolProfiles List<Property Map>: Configuration of OpenShift cluster VMs.
authProfile Property Map: Configures OpenShift authentication.
masterPoolProfile Property Map: Configuration for OpenShift master VMs.
monitorProfile Property Map: Configures Log Analytics integration.
networkProfile Property Map: Configuration for OpenShift networking.
plan Property Map: Define the resource plan as required by ARM for billing purposes
refreshCluster Boolean: Allows node rotation
routerProfiles List<Property Map>: Configuration for OpenShift router(s).
tags Map<String>: Resource tags

Supporting Types

NetworkProfileResponse

ManagementSubnetCidr string: CIDR of subnet used to create PLS needed for management of the cluster
VnetCidr string: CIDR for the OpenShift Vnet.
VnetId string: ID of the Vnet created for OSA cluster.

ManagementSubnetCidr string: CIDR of subnet used to create PLS needed for management of the cluster
VnetCidr string: CIDR for the OpenShift Vnet.
VnetId string: ID of the Vnet created for OSA cluster.

managementSubnetCidr String: CIDR of subnet used to create PLS needed for management of the cluster
vnetCidr String: CIDR for the OpenShift Vnet.
vnetId String: ID of the Vnet created for OSA cluster.

managementSubnetCidr string: CIDR of subnet used to create PLS needed for management of the cluster
vnetCidr string: CIDR for the OpenShift Vnet.
vnetId string: ID of the Vnet created for OSA cluster.

management_subnet_cidr str: CIDR of subnet used to create PLS needed for management of the cluster
vnet_cidr str: CIDR for the OpenShift Vnet.
vnet_id str: ID of the Vnet created for OSA cluster.

managementSubnetCidr String: CIDR of subnet used to create PLS needed for management of the cluster
vnetCidr String: CIDR for the OpenShift Vnet.
vnetId String: ID of the Vnet created for OSA cluster.

OpenShiftAPIPropertiesResponse

PrivateApiServer bool: Specifies if API server is public or private.

PrivateApiServer bool: Specifies if API server is public or private.

privateApiServer Boolean: Specifies if API server is public or private.

privateApiServer boolean: Specifies if API server is public or private.

private_api_server bool: Specifies if API server is public or private.

privateApiServer Boolean: Specifies if API server is public or private.

OpenShiftManagedClusterAADIdentityProviderResponse

ClientId string: The clientId password associated with the provider.
CustomerAdminGroupId string: The groupId to be granted cluster admin role.
Secret string: The secret password associated with the provider.
TenantId string: The tenantId associated with the provider.

ClientId string: The clientId password associated with the provider.
CustomerAdminGroupId string: The groupId to be granted cluster admin role.
Secret string: The secret password associated with the provider.
TenantId string: The tenantId associated with the provider.

clientId String: The clientId password associated with the provider.
customerAdminGroupId String: The groupId to be granted cluster admin role.
secret String: The secret password associated with the provider.
tenantId String: The tenantId associated with the provider.

clientId string: The clientId password associated with the provider.
customerAdminGroupId string: The groupId to be granted cluster admin role.
secret string: The secret password associated with the provider.
tenantId string: The tenantId associated with the provider.

client_id str: The clientId password associated with the provider.
customer_admin_group_id str: The groupId to be granted cluster admin role.
secret str: The secret password associated with the provider.
tenant_id str: The tenantId associated with the provider.

clientId String: The clientId password associated with the provider.
customerAdminGroupId String: The groupId to be granted cluster admin role.
secret String: The secret password associated with the provider.
tenantId String: The tenantId associated with the provider.

OpenShiftManagedClusterAgentPoolProfileResponse

Count int: Number of agents (VMs) to host docker containers.
Name string: Unique name of the pool profile in the context of the subscription and resource group.
VmSize string: Size of agent VMs.
OsType string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
Role string: Define the role of the AgentPoolProfile.
SubnetCidr string: Subnet CIDR for the peering.

Count int: Number of agents (VMs) to host docker containers.
Name string: Unique name of the pool profile in the context of the subscription and resource group.
VmSize string: Size of agent VMs.
OsType string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
Role string: Define the role of the AgentPoolProfile.
SubnetCidr string: Subnet CIDR for the peering.

count Integer: Number of agents (VMs) to host docker containers.
name String: Unique name of the pool profile in the context of the subscription and resource group.
vmSize String: Size of agent VMs.
osType String: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
role String: Define the role of the AgentPoolProfile.
subnetCidr String: Subnet CIDR for the peering.

count number: Number of agents (VMs) to host docker containers.
name string: Unique name of the pool profile in the context of the subscription and resource group.
vmSize string: Size of agent VMs.
osType string: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
role string: Define the role of the AgentPoolProfile.
subnetCidr string: Subnet CIDR for the peering.

count int: Number of agents (VMs) to host docker containers.
name str: Unique name of the pool profile in the context of the subscription and resource group.
vm_size str: Size of agent VMs.
os_type str: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
role str: Define the role of the AgentPoolProfile.
subnet_cidr str: Subnet CIDR for the peering.

count Number: Number of agents (VMs) to host docker containers.
name String: Unique name of the pool profile in the context of the subscription and resource group.
vmSize String: Size of agent VMs.
osType String: OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux.
role String: Define the role of the AgentPoolProfile.
subnetCidr String: Subnet CIDR for the peering.

OpenShiftManagedClusterAuthProfileResponse

IdentityProviders List<Pulumi.AzureNative.ContainerService.Inputs.OpenShiftManagedClusterIdentityProviderResponse>: Type of authentication profile to use.

IdentityProviders []OpenShiftManagedClusterIdentityProviderResponse: Type of authentication profile to use.

identityProviders List<OpenShiftManagedClusterIdentityProviderResponse>: Type of authentication profile to use.

identityProviders OpenShiftManagedClusterIdentityProviderResponse[]: Type of authentication profile to use.

identity_providers Sequence[OpenShiftManagedClusterIdentityProviderResponse]: Type of authentication profile to use.

identityProviders List<Property Map>: Type of authentication profile to use.

OpenShiftManagedClusterIdentityProviderResponse

Name string: Name of the provider.
Provider Pulumi.AzureNative.ContainerService.Inputs.OpenShiftManagedClusterAADIdentityProviderResponse: Configuration of the provider.

Name string: Name of the provider.
Provider OpenShiftManagedClusterAADIdentityProviderResponse: Configuration of the provider.

name String: Name of the provider.
provider OpenShiftManagedClusterAADIdentityProviderResponse: Configuration of the provider.

name string: Name of the provider.
provider OpenShiftManagedClusterAADIdentityProviderResponse: Configuration of the provider.

name str: Name of the provider.
provider OpenShiftManagedClusterAADIdentityProviderResponse: Configuration of the provider.

name String: Name of the provider.
provider Property Map: Configuration of the provider.

OpenShiftManagedClusterMasterPoolProfileResponse

Count int: Number of masters (VMs) to host docker containers. The default value is 3.
VmSize string: Size of agent VMs.
ApiProperties Pulumi.AzureNative.ContainerService.Inputs.OpenShiftAPIPropertiesResponse: Defines further properties on the API.
SubnetCidr string: Subnet CIDR for the peering.

Count int: Number of masters (VMs) to host docker containers. The default value is 3.
VmSize string: Size of agent VMs.
ApiProperties OpenShiftAPIPropertiesResponse: Defines further properties on the API.
SubnetCidr string: Subnet CIDR for the peering.

count Integer: Number of masters (VMs) to host docker containers. The default value is 3.
vmSize String: Size of agent VMs.
apiProperties OpenShiftAPIPropertiesResponse: Defines further properties on the API.
subnetCidr String: Subnet CIDR for the peering.

count number: Number of masters (VMs) to host docker containers. The default value is 3.
vmSize string: Size of agent VMs.
apiProperties OpenShiftAPIPropertiesResponse: Defines further properties on the API.
subnetCidr string: Subnet CIDR for the peering.

count int: Number of masters (VMs) to host docker containers. The default value is 3.
vm_size str: Size of agent VMs.
api_properties OpenShiftAPIPropertiesResponse: Defines further properties on the API.
subnet_cidr str: Subnet CIDR for the peering.

count Number: Number of masters (VMs) to host docker containers. The default value is 3.
vmSize String: Size of agent VMs.
apiProperties Property Map: Defines further properties on the API.
subnetCidr String: Subnet CIDR for the peering.

OpenShiftManagedClusterMonitorProfileResponse

Enabled bool: If the Log analytics integration should be turned on or off
WorkspaceResourceID string: Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with.

Enabled bool: If the Log analytics integration should be turned on or off
WorkspaceResourceID string: Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with.

enabled Boolean: If the Log analytics integration should be turned on or off
workspaceResourceID String: Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with.

enabled boolean: If the Log analytics integration should be turned on or off
workspaceResourceID string: Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with.

enabled bool: If the Log analytics integration should be turned on or off
workspace_resource_id str: Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with.

enabled Boolean: If the Log analytics integration should be turned on or off
workspaceResourceID String: Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with.

OpenShiftRouterProfileResponse

Fqdn string: Auto-allocated FQDN for the OpenShift router.
PublicSubdomain string: DNS subdomain for OpenShift router.
Name string: Name of the router profile.

Fqdn string: Auto-allocated FQDN for the OpenShift router.
PublicSubdomain string: DNS subdomain for OpenShift router.
Name string: Name of the router profile.

fqdn String: Auto-allocated FQDN for the OpenShift router.
publicSubdomain String: DNS subdomain for OpenShift router.
name String: Name of the router profile.

fqdn string: Auto-allocated FQDN for the OpenShift router.
publicSubdomain string: DNS subdomain for OpenShift router.
name string: Name of the router profile.

fqdn str: Auto-allocated FQDN for the OpenShift router.
public_subdomain str: DNS subdomain for OpenShift router.
name str: Name of the router profile.

fqdn String: Auto-allocated FQDN for the OpenShift router.
publicSubdomain String: DNS subdomain for OpenShift router.
name String: Name of the router profile.

PurchasePlanResponse

Name string: The plan ID.
Product string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
PromotionCode string: The promotion code.
Publisher string: The plan ID.

Name string: The plan ID.
Product string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
PromotionCode string: The promotion code.
Publisher string: The plan ID.

name String: The plan ID.
product String: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
promotionCode String: The promotion code.
publisher String: The plan ID.

name string: The plan ID.
product string: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
promotionCode string: The promotion code.
publisher string: The plan ID.

name str: The plan ID.
product str: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
promotion_code str: The promotion code.
publisher str: The plan ID.

name String: The plan ID.
product String: Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
promotionCode String: The promotion code.
publisher String: The plan ID.

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.20.1 published on Friday, Dec 1, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.containerservice.getOpenShiftManagedCluster

On this page

On this page

Using getOpenShiftManagedCluster

getOpenShiftManagedCluster Result

Supporting Types

NetworkProfileResponse

OpenShiftAPIPropertiesResponse

OpenShiftManagedClusterAADIdentityProviderResponse

OpenShiftManagedClusterAgentPoolProfileResponse

OpenShiftManagedClusterAuthProfileResponse

OpenShiftManagedClusterIdentityProviderResponse

OpenShiftManagedClusterMasterPoolProfileResponse

OpenShiftManagedClusterMonitorProfileResponse

OpenShiftRouterProfileResponse

PurchasePlanResponse

Package Details

On this page

On this page