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.76.0 published on Friday, Dec 6, 2024 by Pulumi
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.76.0 published on Friday, Dec 6, 2024 by Pulumi
Gets the details of the managed OpenShift cluster with a specified resource group and name. Azure REST API version: 2019-10-27-preview.
Other available API versions: 2018-09-30-preview.
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:
- Resource
Group stringName - The name of the resource group.
- Resource
Name string - The name of the OpenShift managed cluster resource.
- Resource
Group stringName - The name of the resource group.
- Resource
Name string - The name of the OpenShift managed cluster resource.
- resource
Group StringName - The name of the resource group.
- resource
Name String - The name of the OpenShift managed cluster resource.
- resource
Group stringName - The name of the resource group.
- resource
Name string - The name of the OpenShift managed cluster resource.
- resource_
group_ strname - The name of the resource group.
- resource_
name str - The name of the OpenShift managed cluster resource.
- resource
Group StringName - The name of the resource group.
- resource
Name String - The name of the OpenShift managed cluster resource.
getOpenShiftManagedCluster Result
The following output properties are available:
- Cluster
Version 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
- Open
Shift stringVersion - Version of OpenShift specified when creating the cluster.
- Provisioning
State string - The current deployment or provisioning state, which only appears in the response.
- Public
Hostname string - Service generated FQDN or private IP for OpenShift API server.
- Type string
- Resource type
- Agent
Pool List<Pulumi.Profiles Azure Native. Container Service. Outputs. Open Shift Managed Cluster Agent Pool Profile Response> - Configuration of OpenShift cluster VMs.
- Auth
Profile Pulumi.Azure Native. Container Service. Outputs. Open Shift Managed Cluster Auth Profile Response - Configures OpenShift authentication.
- Master
Pool Pulumi.Profile Azure Native. Container Service. Outputs. Open Shift Managed Cluster Master Pool Profile Response - Configuration for OpenShift master VMs.
- Monitor
Profile Pulumi.Azure Native. Container Service. Outputs. Open Shift Managed Cluster Monitor Profile Response - Configures Log Analytics integration.
- Network
Profile Pulumi.Azure Native. Container Service. Outputs. Network Profile Response - Configuration for OpenShift networking.
- Plan
Pulumi.
Azure Native. Container Service. Outputs. Purchase Plan Response - Define the resource plan as required by ARM for billing purposes
- Refresh
Cluster bool - Allows node rotation
- Router
Profiles List<Pulumi.Azure Native. Container Service. Outputs. Open Shift Router Profile Response> - Configuration for OpenShift router(s).
- Dictionary<string, string>
- Resource tags
- Cluster
Version 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
- Open
Shift stringVersion - Version of OpenShift specified when creating the cluster.
- Provisioning
State string - The current deployment or provisioning state, which only appears in the response.
- Public
Hostname string - Service generated FQDN or private IP for OpenShift API server.
- Type string
- Resource type
- Agent
Pool []OpenProfiles Shift Managed Cluster Agent Pool Profile Response - Configuration of OpenShift cluster VMs.
- Auth
Profile OpenShift Managed Cluster Auth Profile Response - Configures OpenShift authentication.
- Master
Pool OpenProfile Shift Managed Cluster Master Pool Profile Response - Configuration for OpenShift master VMs.
- Monitor
Profile OpenShift Managed Cluster Monitor Profile Response - Configures Log Analytics integration.
- Network
Profile NetworkProfile Response - Configuration for OpenShift networking.
- Plan
Purchase
Plan Response - Define the resource plan as required by ARM for billing purposes
- Refresh
Cluster bool - Allows node rotation
- Router
Profiles []OpenShift Router Profile Response - Configuration for OpenShift router(s).
- map[string]string
- Resource tags
- cluster
Version 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
- open
Shift StringVersion - Version of OpenShift specified when creating the cluster.
- provisioning
State String - The current deployment or provisioning state, which only appears in the response.
- public
Hostname String - Service generated FQDN or private IP for OpenShift API server.
- type String
- Resource type
- agent
Pool List<OpenProfiles Shift Managed Cluster Agent Pool Profile Response> - Configuration of OpenShift cluster VMs.
- auth
Profile OpenShift Managed Cluster Auth Profile Response - Configures OpenShift authentication.
- master
Pool OpenProfile Shift Managed Cluster Master Pool Profile Response - Configuration for OpenShift master VMs.
- monitor
Profile OpenShift Managed Cluster Monitor Profile Response - Configures Log Analytics integration.
- network
Profile NetworkProfile Response - Configuration for OpenShift networking.
- plan
Purchase
Plan Response - Define the resource plan as required by ARM for billing purposes
- refresh
Cluster Boolean - Allows node rotation
- router
Profiles List<OpenShift Router Profile Response> - Configuration for OpenShift router(s).
- Map<String,String>
- Resource tags
- cluster
Version 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
- open
Shift stringVersion - Version of OpenShift specified when creating the cluster.
- provisioning
State string - The current deployment or provisioning state, which only appears in the response.
- public
Hostname string - Service generated FQDN or private IP for OpenShift API server.
- type string
- Resource type
- agent
Pool OpenProfiles Shift Managed Cluster Agent Pool Profile Response[] - Configuration of OpenShift cluster VMs.
- auth
Profile OpenShift Managed Cluster Auth Profile Response - Configures OpenShift authentication.
- master
Pool OpenProfile Shift Managed Cluster Master Pool Profile Response - Configuration for OpenShift master VMs.
- monitor
Profile OpenShift Managed Cluster Monitor Profile Response - Configures Log Analytics integration.
- network
Profile NetworkProfile Response - Configuration for OpenShift networking.
- plan
Purchase
Plan Response - Define the resource plan as required by ARM for billing purposes
- refresh
Cluster boolean - Allows node rotation
- router
Profiles OpenShift Router Profile Response[] - Configuration for OpenShift router(s).
- {[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_ strversion - 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_ Sequence[Openprofiles Shift Managed Cluster Agent Pool Profile Response] - Configuration of OpenShift cluster VMs.
- auth_
profile OpenShift Managed Cluster Auth Profile Response - Configures OpenShift authentication.
- master_
pool_ Openprofile Shift Managed Cluster Master Pool Profile Response - Configuration for OpenShift master VMs.
- monitor_
profile OpenShift Managed Cluster Monitor Profile Response - Configures Log Analytics integration.
- network_
profile NetworkProfile Response - Configuration for OpenShift networking.
- plan
Purchase
Plan Response - Define the resource plan as required by ARM for billing purposes
- refresh_
cluster bool - Allows node rotation
- router_
profiles Sequence[OpenShift Router Profile Response] - Configuration for OpenShift router(s).
- Mapping[str, str]
- Resource tags
- cluster
Version 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
- open
Shift StringVersion - Version of OpenShift specified when creating the cluster.
- provisioning
State String - The current deployment or provisioning state, which only appears in the response.
- public
Hostname String - Service generated FQDN or private IP for OpenShift API server.
- type String
- Resource type
- agent
Pool List<Property Map>Profiles - Configuration of OpenShift cluster VMs.
- auth
Profile Property Map - Configures OpenShift authentication.
- master
Pool Property MapProfile - Configuration for OpenShift master VMs.
- monitor
Profile Property Map - Configures Log Analytics integration.
- network
Profile Property Map - Configuration for OpenShift networking.
- plan Property Map
- Define the resource plan as required by ARM for billing purposes
- refresh
Cluster Boolean - Allows node rotation
- router
Profiles List<Property Map> - Configuration for OpenShift router(s).
- Map<String>
- Resource tags
Supporting Types
NetworkProfileResponse
- Management
Subnet stringCidr - CIDR of subnet used to create PLS needed for management of the cluster
- Vnet
Cidr string - CIDR for the OpenShift Vnet.
- Vnet
Id string - ID of the Vnet created for OSA cluster.
- Management
Subnet stringCidr - CIDR of subnet used to create PLS needed for management of the cluster
- Vnet
Cidr string - CIDR for the OpenShift Vnet.
- Vnet
Id string - ID of the Vnet created for OSA cluster.
- management
Subnet StringCidr - CIDR of subnet used to create PLS needed for management of the cluster
- vnet
Cidr String - CIDR for the OpenShift Vnet.
- vnet
Id String - ID of the Vnet created for OSA cluster.
- management
Subnet stringCidr - CIDR of subnet used to create PLS needed for management of the cluster
- vnet
Cidr string - CIDR for the OpenShift Vnet.
- vnet
Id string - ID of the Vnet created for OSA cluster.
- management_
subnet_ strcidr - 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.
- management
Subnet StringCidr - CIDR of subnet used to create PLS needed for management of the cluster
- vnet
Cidr String - CIDR for the OpenShift Vnet.
- vnet
Id String - ID of the Vnet created for OSA cluster.
OpenShiftAPIPropertiesResponse
- Private
Api boolServer - Specifies if API server is public or private.
- Private
Api boolServer - Specifies if API server is public or private.
- private
Api BooleanServer - Specifies if API server is public or private.
- private
Api booleanServer - Specifies if API server is public or private.
- private_
api_ boolserver - Specifies if API server is public or private.
- private
Api BooleanServer - Specifies if API server is public or private.
OpenShiftManagedClusterAADIdentityProviderResponse
- Client
Id string - The clientId password associated with the provider.
- Customer
Admin stringGroup Id - The groupId to be granted cluster admin role.
- Secret string
- The secret password associated with the provider.
- Tenant
Id string - The tenantId associated with the provider.
- Client
Id string - The clientId password associated with the provider.
- Customer
Admin stringGroup Id - The groupId to be granted cluster admin role.
- Secret string
- The secret password associated with the provider.
- Tenant
Id string - The tenantId associated with the provider.
- client
Id String - The clientId password associated with the provider.
- customer
Admin StringGroup Id - The groupId to be granted cluster admin role.
- secret String
- The secret password associated with the provider.
- tenant
Id String - The tenantId associated with the provider.
- client
Id string - The clientId password associated with the provider.
- customer
Admin stringGroup Id - The groupId to be granted cluster admin role.
- secret string
- The secret password associated with the provider.
- tenant
Id string - The tenantId associated with the provider.
- client_
id str - The clientId password associated with the provider.
- customer_
admin_ strgroup_ id - 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.
- client
Id String - The clientId password associated with the provider.
- customer
Admin StringGroup Id - The groupId to be granted cluster admin role.
- secret String
- The secret password associated with the provider.
- tenant
Id 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.
- Vm
Size string - Size of agent VMs.
- Os
Type 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.
- Subnet
Cidr 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.
- Vm
Size string - Size of agent VMs.
- Os
Type 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.
- Subnet
Cidr 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.
- vm
Size String - Size of agent VMs.
- os
Type 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.
- subnet
Cidr 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.
- vm
Size string - Size of agent VMs.
- os
Type 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.
- subnet
Cidr 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.
- vm
Size String - Size of agent VMs.
- os
Type 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.
- subnet
Cidr String - Subnet CIDR for the peering.
OpenShiftManagedClusterAuthProfileResponse
- Identity
Providers List<Pulumi.Azure Native. Container Service. Inputs. Open Shift Managed Cluster Identity Provider Response> - Type of authentication profile to use.
- Identity
Providers []OpenShift Managed Cluster Identity Provider Response - Type of authentication profile to use.
- identity
Providers List<OpenShift Managed Cluster Identity Provider Response> - Type of authentication profile to use.
- identity
Providers OpenShift Managed Cluster Identity Provider Response[] - Type of authentication profile to use.
- identity_
providers Sequence[OpenShift Managed Cluster Identity Provider Response] - Type of authentication profile to use.
- identity
Providers List<Property Map> - Type of authentication profile to use.
OpenShiftManagedClusterIdentityProviderResponse
- Name string
- Name of the provider.
- Provider
Pulumi.
Azure Native. Container Service. Inputs. Open Shift Managed Cluster AADIdentity Provider Response - Configuration of the provider.
- Name string
- Name of the provider.
- Provider
Open
Shift Managed Cluster AADIdentity Provider Response - Configuration of the provider.
- name String
- Name of the provider.
- provider
Open
Shift Managed Cluster AADIdentity Provider Response - Configuration of the provider.
- name string
- Name of the provider.
- provider
Open
Shift Managed Cluster AADIdentity Provider Response - Configuration of the provider.
- name str
- Name of the provider.
- provider
Open
Shift Managed Cluster AADIdentity Provider Response - 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.
- Vm
Size string - Size of agent VMs.
- Api
Properties Pulumi.Azure Native. Container Service. Inputs. Open Shift APIProperties Response - Defines further properties on the API.
- Subnet
Cidr string - Subnet CIDR for the peering.
- Count int
- Number of masters (VMs) to host docker containers. The default value is 3.
- Vm
Size string - Size of agent VMs.
- Api
Properties OpenShift APIProperties Response - Defines further properties on the API.
- Subnet
Cidr string - Subnet CIDR for the peering.
- count Integer
- Number of masters (VMs) to host docker containers. The default value is 3.
- vm
Size String - Size of agent VMs.
- api
Properties OpenShift APIProperties Response - Defines further properties on the API.
- subnet
Cidr String - Subnet CIDR for the peering.
- count number
- Number of masters (VMs) to host docker containers. The default value is 3.
- vm
Size string - Size of agent VMs.
- api
Properties OpenShift APIProperties Response - Defines further properties on the API.
- subnet
Cidr 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 OpenShift APIProperties Response - 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.
- vm
Size String - Size of agent VMs.
- api
Properties Property Map - Defines further properties on the API.
- subnet
Cidr String - Subnet CIDR for the peering.
OpenShiftManagedClusterMonitorProfileResponse
- Enabled bool
- If the Log analytics integration should be turned on or off
- Workspace
Resource stringID - 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 stringID - 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
- workspace
Resource StringID - 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
- workspace
Resource stringID - 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_ strid - 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
- workspace
Resource StringID - Azure Resource Manager Resource ID for the Log Analytics workspace to integrate with.
OpenShiftRouterProfileResponse
- Fqdn string
- Auto-allocated FQDN for the OpenShift router.
- Public
Subdomain string - DNS subdomain for OpenShift router.
- Name string
- Name of the router profile.
- Fqdn string
- Auto-allocated FQDN for the OpenShift router.
- Public
Subdomain string - DNS subdomain for OpenShift router.
- Name string
- Name of the router profile.
- fqdn String
- Auto-allocated FQDN for the OpenShift router.
- public
Subdomain String - DNS subdomain for OpenShift router.
- name String
- Name of the router profile.
- fqdn string
- Auto-allocated FQDN for the OpenShift router.
- public
Subdomain 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.
- public
Subdomain 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.
- Promotion
Code 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.
- Promotion
Code 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.
- promotion
Code 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.
- promotion
Code 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.
- promotion
Code 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.76.0 published on Friday, Dec 6, 2024 by Pulumi