open_shift_clusters

Creates, updates, deletes, gets or lists an open_shift_clusters resource.

Overview

Name	open_shift_clusters
Type	Resource
Id	azure_isv.redhatopenshift.open_shift_clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
apiserverProfile	object	The cluster API server profile.
clusterProfile	object	The cluster profile.
consoleProfile	object	The console profile.
identity	object	The managed service identities assigned to this resource.
ingressProfiles	array	The cluster ingress profiles.
location	string	The geo-location where the resource lives. Required.
masterProfile	object	The cluster master profile.
networkProfile	object	The cluster network profile.
platformWorkloadIdentityProfile	object	The workload identity profile.
provisioningState	string	The cluster provisioning state. Known values are: "AdminUpdating", "Canceled", "Creating", "Deleting", "Failed", "Succeeded", and "Updating". (AdminUpdating, Canceled, Creating, Deleting, Failed, Succeeded, Updating)
servicePrincipalProfile	object	The cluster service principal profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workerProfiles	array	The cluster worker profiles.
workerProfilesStatus	array	The cluster worker profiles status.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
apiserverProfile	object	The cluster API server profile.
clusterProfile	object	The cluster profile.
consoleProfile	object	The console profile.
identity	object	The managed service identities assigned to this resource.
ingressProfiles	array	The cluster ingress profiles.
location	string	The geo-location where the resource lives. Required.
masterProfile	object	The cluster master profile.
networkProfile	object	The cluster network profile.
platformWorkloadIdentityProfile	object	The workload identity profile.
provisioningState	string	The cluster provisioning state. Known values are: "AdminUpdating", "Canceled", "Creating", "Deleting", "Failed", "Succeeded", and "Updating". (AdminUpdating, Canceled, Creating, Deleting, Failed, Succeeded, Updating)
servicePrincipalProfile	object	The cluster service principal profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workerProfiles	array	The cluster worker profiles.
workerProfilesStatus	array	The cluster worker profiles status.

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
apiserverProfile	object	The cluster API server profile.
clusterProfile	object	The cluster profile.
consoleProfile	object	The console profile.
identity	object	The managed service identities assigned to this resource.
ingressProfiles	array	The cluster ingress profiles.
location	string	The geo-location where the resource lives. Required.
masterProfile	object	The cluster master profile.
networkProfile	object	The cluster network profile.
platformWorkloadIdentityProfile	object	The workload identity profile.
provisioningState	string	The cluster provisioning state. Known values are: "AdminUpdating", "Canceled", "Creating", "Deleting", "Failed", "Succeeded", and "Updating". (AdminUpdating, Canceled, Creating, Deleting, Failed, Succeeded, Updating)
servicePrincipalProfile	object	The cluster service principal profile.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
workerProfiles	array	The cluster worker profiles.
workerProfilesStatus	array	The cluster worker profiles status.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, subscription_id		Gets a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.
list_by_resource_group	select	resource_group_name, subscription_id		Lists OpenShift clusters in the specified subscription and resource group. The operation returns properties of each OpenShift cluster.
list	select	subscription_id		Lists OpenShift clusters in the specified subscription. The operation returns properties of each OpenShift cluster.
create_or_update	insert	resource_group_name, resource_name, subscription_id, location		Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.
update	update	resource_group_name, resource_name, subscription_id		Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.
create_or_update	replace	resource_group_name, resource_name, subscription_id, location		Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.
delete	delete	resource_group_name, resource_name, subscription_id		Deletes a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns nothing.
list_admin_credentials	exec	resource_group_name, resource_name, subscription_id		Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the admin kubeconfig.
list_credentials	exec	resource_group_name, resource_name, subscription_id		Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the credentials.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the OpenShift cluster resource. Required.
subscription_id	string

SELECT examples

get

Gets a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.

SELECT
id,
name,
apiserverProfile,
clusterProfile,
consoleProfile,
identity,
ingressProfiles,
location,
masterProfile,
networkProfile,
platformWorkloadIdentityProfile,
provisioningState,
servicePrincipalProfile,
systemData,
tags,
type,
workerProfiles,
workerProfilesStatus
FROM azure_isv.redhatopenshift.open_shift_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists OpenShift clusters in the specified subscription and resource group. The operation returns properties of each OpenShift cluster.

SELECT
id,
name,
apiserverProfile,
clusterProfile,
consoleProfile,
identity,
ingressProfiles,
location,
masterProfile,
networkProfile,
platformWorkloadIdentityProfile,
provisioningState,
servicePrincipalProfile,
systemData,
tags,
type,
workerProfiles,
workerProfilesStatus
FROM azure_isv.redhatopenshift.open_shift_clusters
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists OpenShift clusters in the specified subscription. The operation returns properties of each OpenShift cluster.

SELECT
id,
name,
apiserverProfile,
clusterProfile,
consoleProfile,
identity,
ingressProfiles,
location,
masterProfile,
networkProfile,
platformWorkloadIdentityProfile,
provisioningState,
servicePrincipalProfile,
systemData,
tags,
type,
workerProfiles,
workerProfilesStatus
FROM azure_isv.redhatopenshift.open_shift_clusters
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.

INSERT INTO azure_isv.redhatopenshift.open_shift_clusters (
tags,
location,
properties,
identity,
resource_group_name,
resource_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: open_shift_clusters
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the open_shift_clusters resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the open_shift_clusters resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the open_shift_clusters resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The cluster properties.
    value:
      provisioningState: "{{ provisioningState }}"
      clusterProfile:
        pullSecret: "{{ pullSecret }}"
        domain: "{{ domain }}"
        version: "{{ version }}"
        resourceGroupId: "{{ resourceGroupId }}"
        fipsValidatedModules: "{{ fipsValidatedModules }}"
        oidcIssuer: "{{ oidcIssuer }}"
      consoleProfile:
        url: "{{ url }}"
      servicePrincipalProfile:
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
      platformWorkloadIdentityProfile:
        upgradeableTo: "{{ upgradeableTo }}"
        platformWorkloadIdentities: "{{ platformWorkloadIdentities }}"
      networkProfile:
        podCidr: "{{ podCidr }}"
        serviceCidr: "{{ serviceCidr }}"
        outboundType: "{{ outboundType }}"
        loadBalancerProfile:
          managedOutboundIps:
            count: {{ count }}
          effectiveOutboundIps:
            - id: "{{ id }}"
        preconfiguredNSG: "{{ preconfiguredNSG }}"
      masterProfile:
        vmSize: "{{ vmSize }}"
        subnetId: "{{ subnetId }}"
        encryptionAtHost: "{{ encryptionAtHost }}"
        diskEncryptionSetId: "{{ diskEncryptionSetId }}"
      workerProfiles:
        - name: "{{ name }}"
          vmSize: "{{ vmSize }}"
          diskSizeGB: {{ diskSizeGB }}
          subnetId: "{{ subnetId }}"
          count: {{ count }}
          encryptionAtHost: "{{ encryptionAtHost }}"
          diskEncryptionSetId: "{{ diskEncryptionSetId }}"
      workerProfilesStatus:
        - name: "{{ name }}"
          vmSize: "{{ vmSize }}"
          diskSizeGB: {{ diskSizeGB }}
          subnetId: "{{ subnetId }}"
          count: {{ count }}
          encryptionAtHost: "{{ encryptionAtHost }}"
          diskEncryptionSetId: "{{ diskEncryptionSetId }}"
      apiserverProfile:
        visibility: "{{ visibility }}"
        url: "{{ url }}"
        ip: "{{ ip }}"
      ingressProfiles:
        - name: "{{ name }}"
          visibility: "{{ visibility }}"
          ip: "{{ ip }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.

UPDATE azure_isv.redhatopenshift.open_shift_clusters
SET 
tags = '{{ tags }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.

REPLACE azure_isv.redhatopenshift.open_shift_clusters
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns nothing.

DELETE FROM azure_isv.redhatopenshift.open_shift_clusters
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_admin_credentials

Lists admin kubeconfig of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the admin kubeconfig.

EXEC azure_isv.redhatopenshift.open_shift_clusters.list_admin_credentials 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_credentials

Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the credentials.

EXEC azure_isv.redhatopenshift.open_shift_clusters.list_credentials 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;