Azure Native
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:
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Resource
Name string The name of the OpenShift cluster resource.
- Resource
Group stringName The name of the resource group. The name is case insensitive.
- Resource
Name string The name of the OpenShift cluster resource.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- resource
Name String The name of the OpenShift cluster resource.
- resource
Group stringName The name of the resource group. The name is case insensitive.
- resource
Name string The name of the OpenShift cluster resource.
- resource_
group_ strname The name of the resource group. The name is case insensitive.
- resource_
name str The name of the OpenShift cluster resource.
- resource
Group StringName The name of the resource group. The name is case insensitive.
- resource
Name 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"
- Apiserver
Profile Pulumi.Azure Native. Red Hat Open Shift. Outputs. APIServer Profile Response The cluster API server profile.
- Cluster
Profile Pulumi.Azure Native. Red Hat Open Shift. Outputs. Cluster Profile Response The cluster profile.
- Console
Profile Pulumi.Azure Native. Red Hat Open Shift. Outputs. Console Profile Response The console profile.
- Ingress
Profiles List<Pulumi.Azure Native. Red Hat Open Shift. Outputs. Ingress Profile Response> The cluster ingress profiles.
- Master
Profile Pulumi.Azure Native. Red Hat Open Shift. Outputs. Master Profile Response The cluster master profile.
- Network
Profile Pulumi.Azure Native. Red Hat Open Shift. Outputs. Network Profile Response The cluster network profile.
- Provisioning
State string The cluster provisioning state (immutable).
- Service
Principal Pulumi.Profile Azure Native. Red Hat Open Shift. Outputs. Service Principal Profile Response The cluster service principal profile.
- Dictionary<string, string>
Resource tags.
- Worker
Profiles List<Pulumi.Azure Native. Red Hat Open Shift. Outputs. Worker Profile Response> 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"
- Apiserver
Profile APIServerProfile Response The cluster API server profile.
- Cluster
Profile ClusterProfile Response The cluster profile.
- Console
Profile ConsoleProfile Response The console profile.
- Ingress
Profiles []IngressProfile Response The cluster ingress profiles.
- Master
Profile MasterProfile Response The cluster master profile.
- Network
Profile NetworkProfile Response The cluster network profile.
- Provisioning
State string The cluster provisioning state (immutable).
- Service
Principal ServiceProfile Principal Profile Response The cluster service principal profile.
- map[string]string
Resource tags.
- Worker
Profiles []WorkerProfile Response 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"
- apiserver
Profile APIServerProfile Response The cluster API server profile.
- cluster
Profile ClusterProfile Response The cluster profile.
- console
Profile ConsoleProfile Response The console profile.
- ingress
Profiles List<IngressProfile Response> The cluster ingress profiles.
- master
Profile MasterProfile Response The cluster master profile.
- network
Profile NetworkProfile Response The cluster network profile.
- provisioning
State String The cluster provisioning state (immutable).
- service
Principal ServiceProfile Principal Profile Response The cluster service principal profile.
- Map<String,String>
Resource tags.
- worker
Profiles List<WorkerProfile Response> 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"
- apiserver
Profile APIServerProfile Response The cluster API server profile.
- cluster
Profile ClusterProfile Response The cluster profile.
- console
Profile ConsoleProfile Response The console profile.
- ingress
Profiles IngressProfile Response[] The cluster ingress profiles.
- master
Profile MasterProfile Response The cluster master profile.
- network
Profile NetworkProfile Response The cluster network profile.
- provisioning
State string The cluster provisioning state (immutable).
- service
Principal ServiceProfile Principal Profile Response The cluster service principal profile.
- {[key: string]: string}
Resource tags.
- worker
Profiles WorkerProfile Response[] 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 APIServerProfile Response The cluster API server profile.
- cluster_
profile ClusterProfile Response The cluster profile.
- console_
profile ConsoleProfile Response The console profile.
- ingress_
profiles Sequence[IngressProfile Response] The cluster ingress profiles.
- master_
profile MasterProfile Response The cluster master profile.
- network_
profile NetworkProfile Response The cluster network profile.
- provisioning_
state str The cluster provisioning state (immutable).
- service_
principal_ Serviceprofile Principal Profile Response The cluster service principal profile.
- Mapping[str, str]
Resource tags.
- worker_
profiles Sequence[WorkerProfile Response] 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"
- apiserver
Profile Property Map The cluster API server profile.
- cluster
Profile Property Map The cluster profile.
- console
Profile Property Map The console profile.
- ingress
Profiles List<Property Map> The cluster ingress profiles.
- master
Profile Property Map The cluster master profile.
- network
Profile Property Map The cluster network profile.
- provisioning
State String The cluster provisioning state (immutable).
- service
Principal Property MapProfile The cluster service principal profile.
- Map<String>
Resource tags.
- worker
Profiles 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).
- Pull
Secret string The pull secret for the cluster (immutable).
- Resource
Group stringId The ID of the cluster resource group (immutable).
- Version string
The version of the cluster (immutable).
- Domain string
The domain for the cluster (immutable).
- Pull
Secret string The pull secret for the cluster (immutable).
- Resource
Group stringId The ID of the cluster resource group (immutable).
- Version string
The version of the cluster (immutable).
- domain String
The domain for the cluster (immutable).
- pull
Secret String The pull secret for the cluster (immutable).
- resource
Group StringId The ID of the cluster resource group (immutable).
- version String
The version of the cluster (immutable).
- domain string
The domain for the cluster (immutable).
- pull
Secret string The pull secret for the cluster (immutable).
- resource
Group stringId 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_ strid The ID of the cluster resource group (immutable).
- version str
The version of the cluster (immutable).
- domain String
The domain for the cluster (immutable).
- pull
Secret String The pull secret for the cluster (immutable).
- resource
Group StringId 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
NetworkProfileResponse
- Pod
Cidr string The CIDR used for OpenShift/Kubernetes Pods (immutable).
- Service
Cidr string The CIDR used for OpenShift/Kubernetes Services (immutable).
- Pod
Cidr string The CIDR used for OpenShift/Kubernetes Pods (immutable).
- Service
Cidr string The CIDR used for OpenShift/Kubernetes Services (immutable).
- pod
Cidr String The CIDR used for OpenShift/Kubernetes Pods (immutable).
- service
Cidr String The CIDR used for OpenShift/Kubernetes Services (immutable).
- pod
Cidr string The CIDR used for OpenShift/Kubernetes Pods (immutable).
- service
Cidr 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).
- pod
Cidr String The CIDR used for OpenShift/Kubernetes Pods (immutable).
- service
Cidr String The CIDR used for OpenShift/Kubernetes Services (immutable).
ServicePrincipalProfileResponse
- Client
Id string The client ID used for the cluster (immutable).
- Client
Secret string The client secret used for the cluster (immutable).
- Client
Id string The client ID used for the cluster (immutable).
- Client
Secret string The client secret used for the cluster (immutable).
- client
Id String The client ID used for the cluster (immutable).
- client
Secret String The client secret used for the cluster (immutable).
- client
Id string The client ID used for the cluster (immutable).
- client
Secret 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).
- client
Id String The client ID used for the cluster (immutable).
- client
Secret String The client secret used for the cluster (immutable).
WorkerProfileResponse
- Count int
The number of worker VMs. Must be between 3 and 20 (immutable).
- Disk
Size intGB The disk size of the worker VMs. Must be 128 or greater (immutable).
- Name string
The worker profile name. Must be "worker" (immutable).
- Subnet
Id string The Azure resource ID of the worker subnet (immutable).
- Vm
Size string The size of the worker VMs (immutable).
- Count int
The number of worker VMs. Must be between 3 and 20 (immutable).
- Disk
Size intGB The disk size of the worker VMs. Must be 128 or greater (immutable).
- Name string
The worker profile name. Must be "worker" (immutable).
- Subnet
Id string The Azure resource ID of the worker subnet (immutable).
- Vm
Size string The size of the worker VMs (immutable).
- count Integer
The number of worker VMs. Must be between 3 and 20 (immutable).
- disk
Size IntegerGB The disk size of the worker VMs. Must be 128 or greater (immutable).
- name String
The worker profile name. Must be "worker" (immutable).
- subnet
Id String The Azure resource ID of the worker subnet (immutable).
- vm
Size String The size of the worker VMs (immutable).
- count number
The number of worker VMs. Must be between 3 and 20 (immutable).
- disk
Size numberGB The disk size of the worker VMs. Must be 128 or greater (immutable).
- name string
The worker profile name. Must be "worker" (immutable).
- subnet
Id string The Azure resource ID of the worker subnet (immutable).
- vm
Size string The size of the worker VMs (immutable).
- count int
The number of worker VMs. Must be between 3 and 20 (immutable).
- disk_
size_ intgb 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).
- disk
Size NumberGB The disk size of the worker VMs. Must be 128 or greater (immutable).
- name String
The worker profile name. Must be "worker" (immutable).
- subnet
Id String The Azure resource ID of the worker subnet (immutable).
- vm
Size String The size of the worker VMs (immutable).
Package Details
- Repository
- https://github.com/pulumi/pulumi-azure-native
- License
- Apache-2.0