cluster_managers

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

Overview

Name	cluster_managers
Type	Resource
Id	azure_extras.network_cloud.cluster_managers

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.
analyticsWorkspaceId	string	The resource ID of the Log Analytics workspace that is used for the logs collection.
availabilityZones	array	The Azure availability zones within the region that will be used to support the cluster manager resource.
clusterVersions	array	The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
detailedStatus	string	The detailed status that provides additional information about the cluster manager. Known values are: "Error", "Available", "Provisioning", "ProvisioningFailed", "Updating", and "UpdateFailed". (Error, Available, Provisioning, ProvisioningFailed, Updating, UpdateFailed)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
fabricControllerId	string	The resource ID of the fabric controller that has one to one mapping with the cluster manager. Required.
identity	object	The managed service identities assigned to this resource.
kind	string	The kind of the cluster manager. Known values are: "Nexus" and "AzureLocal". (Nexus, AzureLocal)
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	The configuration of the managed resource group associated with the resource.
managerExtendedLocation	object	The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.
provisioningState	string	The provisioning state of the cluster manager. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Accepted", and "Updating". (Succeeded, Failed, Canceled, Provisioning, Accepted, Updating)
relayConfiguration	object	The relay configuration for the cluster manager.
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".
vmSize	string	The size of the Azure virtual machines to use for hosting the cluster manager resource.

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.
analyticsWorkspaceId	string	The resource ID of the Log Analytics workspace that is used for the logs collection.
availabilityZones	array	The Azure availability zones within the region that will be used to support the cluster manager resource.
clusterVersions	array	The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
detailedStatus	string	The detailed status that provides additional information about the cluster manager. Known values are: "Error", "Available", "Provisioning", "ProvisioningFailed", "Updating", and "UpdateFailed". (Error, Available, Provisioning, ProvisioningFailed, Updating, UpdateFailed)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
fabricControllerId	string	The resource ID of the fabric controller that has one to one mapping with the cluster manager. Required.
identity	object	The managed service identities assigned to this resource.
kind	string	The kind of the cluster manager. Known values are: "Nexus" and "AzureLocal". (Nexus, AzureLocal)
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	The configuration of the managed resource group associated with the resource.
managerExtendedLocation	object	The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.
provisioningState	string	The provisioning state of the cluster manager. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Accepted", and "Updating". (Succeeded, Failed, Canceled, Provisioning, Accepted, Updating)
relayConfiguration	object	The relay configuration for the cluster manager.
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".
vmSize	string	The size of the Azure virtual machines to use for hosting the cluster manager resource.

list_by_subscription

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.
analyticsWorkspaceId	string	The resource ID of the Log Analytics workspace that is used for the logs collection.
availabilityZones	array	The Azure availability zones within the region that will be used to support the cluster manager resource.
clusterVersions	array	The list of the cluster versions the manager supports. It is used as input in clusterVersion property of a cluster resource.
detailedStatus	string	The detailed status that provides additional information about the cluster manager. Known values are: "Error", "Available", "Provisioning", "ProvisioningFailed", "Updating", and "UpdateFailed". (Error, Available, Provisioning, ProvisioningFailed, Updating, UpdateFailed)
detailedStatusMessage	string	The descriptive message about the current detailed status.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
fabricControllerId	string	The resource ID of the fabric controller that has one to one mapping with the cluster manager. Required.
identity	object	The managed service identities assigned to this resource.
kind	string	The kind of the cluster manager. Known values are: "Nexus" and "AzureLocal". (Nexus, AzureLocal)
location	string	The geo-location where the resource lives. Required.
managedResourceGroupConfiguration	object	The configuration of the managed resource group associated with the resource.
managerExtendedLocation	object	The extended location (custom location) that represents the cluster manager's control plane location. This extended location is used when creating cluster and rack manifest resources.
provisioningState	string	The provisioning state of the cluster manager. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Accepted", and "Updating". (Succeeded, Failed, Canceled, Provisioning, Accepted, Updating)
relayConfiguration	object	The relay configuration for the cluster manager.
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".
vmSize	string	The size of the Azure virtual machines to use for hosting the cluster manager resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, cluster_manager_name, subscription_id		Get the properties of the provided cluster manager.
list_by_resource_group	select	resource_group_name, subscription_id	$top, $skipToken	Get a list of cluster managers in the provided resource group.
list_by_subscription	select	subscription_id	$top, $skipToken	Get a list of cluster managers in the provided subscription.
create_or_update	insert	resource_group_name, cluster_manager_name, subscription_id, location, properties		Create a new cluster manager or update properties of the cluster manager if it exists.
update	update	resource_group_name, cluster_manager_name, subscription_id		Patch properties of the provided cluster manager, or update the tags assigned to the cluster manager. Properties and tag updates can be done independently.
create_or_update	replace	resource_group_name, cluster_manager_name, subscription_id, location, properties		Create a new cluster manager or update properties of the cluster manager if it exists.
delete	delete	resource_group_name, cluster_manager_name, subscription_id		Delete the provided cluster manager.
update_relay_private_endpoint_connection	exec	resource_group_name, cluster_manager_name, subscription_id, connectionState, privateEndpointResourceId		Update the private endpoint connection for the Azure Relay namespace managed by the specified cluster manager. Use this operation to approve or reject a pending private endpoint connection request for the relay namespace managed by the 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
cluster_manager_name	string	The name of the cluster manager. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$skipToken	string	The opaque token that the server returns to indicate where to continue listing resources from. This is used for paging through large result sets. Default value is None.
$top	integer	The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None.

SELECT examples

get

Get the properties of the provided cluster manager.

SELECT
id,
name,
analyticsWorkspaceId,
availabilityZones,
clusterVersions,
detailedStatus,
detailedStatusMessage,
etag,
fabricControllerId,
identity,
kind,
location,
managedResourceGroupConfiguration,
managerExtendedLocation,
provisioningState,
relayConfiguration,
systemData,
tags,
type,
vmSize
FROM azure_extras.network_cloud.cluster_managers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_manager_name = '{{ cluster_manager_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
analyticsWorkspaceId,
availabilityZones,
clusterVersions,
detailedStatus,
detailedStatusMessage,
etag,
fabricControllerId,
identity,
kind,
location,
managedResourceGroupConfiguration,
managerExtendedLocation,
provisioningState,
relayConfiguration,
systemData,
tags,
type,
vmSize
FROM azure_extras.network_cloud.cluster_managers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

list_by_subscription

Get a list of cluster managers in the provided subscription.

SELECT
id,
name,
analyticsWorkspaceId,
availabilityZones,
clusterVersions,
detailedStatus,
detailedStatusMessage,
etag,
fabricControllerId,
identity,
kind,
location,
managedResourceGroupConfiguration,
managerExtendedLocation,
provisioningState,
relayConfiguration,
systemData,
tags,
type,
vmSize
FROM azure_extras.network_cloud.cluster_managers
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure_extras.network_cloud.cluster_managers (
tags,
location,
properties,
identity,
kind,
resource_group_name,
cluster_manager_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ identity }}',
'{{ kind }}',
'{{ resource_group_name }}',
'{{ cluster_manager_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: cluster_managers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the cluster_managers resource.
  - name: cluster_manager_name
    value: "{{ cluster_manager_name }}"
    description: Required parameter for the cluster_managers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the cluster_managers 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 list of the resource properties. Required.
    value:
      analyticsWorkspaceId: "{{ analyticsWorkspaceId }}"
      availabilityZones:
        - "{{ availabilityZones }}"
      clusterVersions:
        - supportExpiryDate: "{{ supportExpiryDate }}"
          targetClusterVersion: "{{ targetClusterVersion }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      fabricControllerId: "{{ fabricControllerId }}"
      managedResourceGroupConfiguration:
        location: "{{ location }}"
        name: "{{ name }}"
      managerExtendedLocation:
        name: "{{ name }}"
        type: "{{ type }}"
      provisioningState: "{{ provisioningState }}"
      relayConfiguration:
        relayNamespaceId: "{{ relayNamespaceId }}"
      vmSize: "{{ vmSize }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of the cluster manager. Known values are: "Nexus" and "AzureLocal".
    valid_values: ['Nexus', 'AzureLocal']

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_extras.network_cloud.cluster_managers
SET 
identity = '{{ identity }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_manager_name = '{{ cluster_manager_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure_extras.network_cloud.cluster_managers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
kind = '{{ kind }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_manager_name = '{{ cluster_manager_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete the provided cluster manager.

DELETE FROM azure_extras.network_cloud.cluster_managers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_manager_name = '{{ cluster_manager_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

update_relay_private_endpoint_connection

Update the private endpoint connection for the Azure Relay namespace managed by the specified cluster manager. Use this operation to approve or reject a pending private endpoint connection request for the relay namespace managed by the cluster manager.

EXEC azure_extras.network_cloud.cluster_managers.update_relay_private_endpoint_connection 
@resource_group_name='{{ resource_group_name }}' --required, 
@cluster_manager_name='{{ cluster_manager_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"connectionState": "{{ connectionState }}", 
"description": "{{ description }}", 
"privateEndpointResourceId": "{{ privateEndpointResourceId }}"
}'
;