open_shift_clusters

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

Overview

Name	open_shift_clusters
Type	Resource
Id	azure_isv.openshift_clusters.open_shift_clusters

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The cluster properties.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The cluster properties.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The cluster properties.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName		The operation returns properties of a OpenShift cluster.
list_by_resource_group	select	subscriptionId, resourceGroupName		The operation returns properties of each OpenShift cluster.
list	select	subscriptionId		The operation returns properties of each OpenShift cluster.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName		The operation returns properties of a OpenShift cluster.
update	update	subscriptionId, resourceGroupName, resourceName		The operation returns properties of a OpenShift cluster.
delete	delete	subscriptionId, resourceGroupName, resourceName		The operation returns nothing.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the OpenShift cluster resource.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

The operation returns properties of a OpenShift cluster.

SELECT
location,
properties,
systemData,
tags
FROM azure_isv.openshift_clusters.open_shift_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

The operation returns properties of each OpenShift cluster.

SELECT
location,
properties,
systemData,
tags
FROM azure_isv.openshift_clusters.open_shift_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

The operation returns properties of each OpenShift cluster.

SELECT
location,
properties,
systemData,
tags
FROM azure_isv.openshift_clusters.open_shift_clusters
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

The operation returns properties of a OpenShift cluster.

INSERT INTO azure_isv.openshift_clusters.open_shift_clusters (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: open_shift_clusters
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the open_shift_clusters resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the open_shift_clusters resource.
    - name: resourceName
      value: string
      description: Required parameter for the open_shift_clusters resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        The cluster properties.

UPDATE examples

update

The operation returns properties of a OpenShift cluster.

UPDATE azure_isv.openshift_clusters.open_shift_clusters
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
location,
properties,
systemData,
tags;

DELETE examples

delete

The operation returns nothing.

DELETE FROM azure_isv.openshift_clusters.open_shift_clusters
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;