cluster_managers

Creates, updates, deletes, gets or lists a cluster_managers resource.

Overview

Name	cluster_managers
Type	Resource
Id	azure.nexus.cluster_managers

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
identity	object	The identity of the cluster manager.
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ClusterManagerProperties represents the properties of a cluster manager.)
tags	object	Resource tags.

list_by_resource_group

The resource list has been successfully retrieved.

Name	Datatype	Description
identity	object	The identity of the cluster manager.
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ClusterManagerProperties represents the properties of a cluster manager.)
tags	object	Resource tags.

list_by_subscription

The resource list has been successfully retrieved.

Name	Datatype	Description
identity	object	The identity of the cluster manager.
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: ClusterManagerProperties represents the properties of a cluster manager.)
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, clusterManagerName		Get the properties of the provided cluster manager.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get a list of cluster managers in the provided resource group.
list_by_subscription	select	subscriptionId		Get a list of cluster managers in the provided subscription.
create_or_update	insert	subscriptionId, resourceGroupName, clusterManagerName, data__properties		Create a new cluster manager or update properties of the cluster manager if it exists.
update	update	subscriptionId, resourceGroupName, clusterManagerName		Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.
delete	delete	subscriptionId, resourceGroupName, clusterManagerName		Delete the provided cluster manager.

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
clusterManagerName	string	The name of the cluster manager.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get the properties of the provided cluster manager.

SELECT
identity,
location,
properties,
tags
FROM azure.nexus.cluster_managers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterManagerName = '{{ clusterManagerName }}' -- required
;

list_by_resource_group

Get a list of cluster managers in the provided resource group.

SELECT
identity,
location,
properties,
tags
FROM azure.nexus.cluster_managers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Get a list of cluster managers in the provided subscription.

SELECT
identity,
location,
properties,
tags
FROM azure.nexus.cluster_managers
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a new cluster manager or update properties of the cluster manager if it exists.

INSERT INTO azure.nexus.cluster_managers (
data__identity,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
clusterManagerName
)
SELECT 
'{{ identity }}',
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterManagerName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: cluster_managers
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the cluster_managers resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the cluster_managers resource.
    - name: clusterManagerName
      value: string
      description: Required parameter for the cluster_managers resource.
    - name: identity
      value: object
      description: |
        The identity of the cluster manager.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.

UPDATE azure.nexus.cluster_managers
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterManagerName = '{{ clusterManagerName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Delete the provided cluster manager.

DELETE FROM azure.nexus.cluster_managers
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterManagerName = '{{ clusterManagerName }}' --required
;