bare_metal_machine_key_sets

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

Overview

Name	bare_metal_machine_key_sets
Type	Resource
Id	azure.nexus.bare_metal_machine_key_sets

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: BareMetalMachineKeySetProperties represents the properties of bare metal machine key set.)
tags	object	Resource tags.

list_by_cluster

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: BareMetalMachineKeySetProperties represents the properties of bare metal machine key set.)
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, clusterName, bareMetalMachineKeySetName		Get bare metal machine key set of the provided cluster.
list_by_cluster	select	subscriptionId, resourceGroupName, clusterName		Get a list of bare metal machine key sets for the provided cluster.
create_or_update	insert	subscriptionId, resourceGroupName, clusterName, bareMetalMachineKeySetName, data__extendedLocation, data__properties		Create a new bare metal machine key set or update the existing one for the provided cluster.
update	update	subscriptionId, resourceGroupName, clusterName, bareMetalMachineKeySetName		Patch properties of bare metal machine key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.
delete	delete	subscriptionId, resourceGroupName, clusterName, bareMetalMachineKeySetName		Delete the bare metal machine key set of the provided cluster.

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
bareMetalMachineKeySetName	string	The name of the bare metal machine key set.
clusterName	string	The name of the cluster.
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 bare metal machine key set of the provided cluster.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.bare_metal_machine_key_sets
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND clusterName = '{{ clusterName }}' -- required
AND bareMetalMachineKeySetName = '{{ bareMetalMachineKeySetName }}' -- required
;

list_by_cluster

Get a list of bare metal machine key sets for the provided cluster.

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

INSERT examples

create_or_update

Create a new bare metal machine key set or update the existing one for the provided cluster.

INSERT INTO azure.nexus.bare_metal_machine_key_sets (
data__extendedLocation,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
clusterName,
bareMetalMachineKeySetName
)
SELECT 
'{{ extendedLocation }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ clusterName }}',
'{{ bareMetalMachineKeySetName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: bare_metal_machine_key_sets
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the bare_metal_machine_key_sets resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the bare_metal_machine_key_sets resource.
    - name: clusterName
      value: string
      description: Required parameter for the bare_metal_machine_key_sets resource.
    - name: bareMetalMachineKeySetName
      value: string
      description: Required parameter for the bare_metal_machine_key_sets resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster associated with the resource.
    - 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 bare metal machine key set for the provided cluster, or update the tags associated with it. Properties and tag updates can be done independently.

UPDATE azure.nexus.bare_metal_machine_key_sets
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND bareMetalMachineKeySetName = '{{ bareMetalMachineKeySetName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete the bare metal machine key set of the provided cluster.

DELETE FROM azure.nexus.bare_metal_machine_key_sets
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND clusterName = '{{ clusterName }}' --required
AND bareMetalMachineKeySetName = '{{ bareMetalMachineKeySetName }}' --required
;