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_extras.network_cloud.bare_metal_machine_key_sets`

Fields

The following fields are returned by SELECT queries:

get
list_by_cluster

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.
`azureGroupId`	`string`	The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. Required.
`detailedStatus`	`string`	The more detailed status of the key set. Known values are: "AllActive", "SomeInvalid", "AllInvalid", and "Validating". (AllActive, SomeInvalid, AllInvalid, Validating)
`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.").
`expiration`	`string (date-time)`	The date and time after which the users in this key set will be removed from the bare metal machines. Required.
`extendedLocation`	`object`	The extended location of the resource. This property is required when creating the resource. Required.
`jumpHostsAllowed`	`array`	The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. Required.
`lastValidation`	`string (date-time)`	The last time this key set was validated.
`location`	`string`	The geo-location where the resource lives. Required.
`osGroupName`	`string`	The name of the group that users will be assigned to on the operating system of the machines.
`privilegeLevel`	`string`	The access level allowed for the users in this key set. Required. Known values are: "Standard", "Superuser", and "Other". (Standard, Superuser, Other)
`privilegeLevelName`	`string`	The name of the access level to apply when the privilege level is set to Other.
`provisioningState`	`string`	The provisioning state of the bare metal machine key set. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Provisioning". (Succeeded, Failed, Canceled, Accepted, Provisioning)
`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".
`userList`	`array`	The unique list of permitted users. Required.
`userListStatus`	`array`	The status evaluation of each user.

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.
`azureGroupId`	`string`	The object ID of Azure Active Directory group that all users in the list must be in for access to be granted. Users that are not in the group will not have access. Required.
`detailedStatus`	`string`	The more detailed status of the key set. Known values are: "AllActive", "SomeInvalid", "AllInvalid", and "Validating". (AllActive, SomeInvalid, AllInvalid, Validating)
`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.").
`expiration`	`string (date-time)`	The date and time after which the users in this key set will be removed from the bare metal machines. Required.
`extendedLocation`	`object`	The extended location of the resource. This property is required when creating the resource. Required.
`jumpHostsAllowed`	`array`	The list of IP addresses of jump hosts with management network access from which a login will be allowed for the users. Required.
`lastValidation`	`string (date-time)`	The last time this key set was validated.
`location`	`string`	The geo-location where the resource lives. Required.
`osGroupName`	`string`	The name of the group that users will be assigned to on the operating system of the machines.
`privilegeLevel`	`string`	The access level allowed for the users in this key set. Required. Known values are: "Standard", "Superuser", and "Other". (Standard, Superuser, Other)
`privilegeLevelName`	`string`	The name of the access level to apply when the privilege level is set to Other.
`provisioningState`	`string`	The provisioning state of the bare metal machine key set. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Provisioning". (Succeeded, Failed, Canceled, Accepted, Provisioning)
`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".
`userList`	`array`	The unique list of permitted users. Required.
`userListStatus`	`array`	The status evaluation of each user.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`resource_group_name`, `cluster_name`, `bare_metal_machine_key_set_name`, `subscription_id`		Get bare metal machine key set of the provided cluster.
`list_by_cluster`	`select`	`resource_group_name`, `cluster_name`, `subscription_id`	`$top`, `$skipToken`	Get a list of bare metal machine key sets for the provided cluster.
`create_or_update`	`insert`	`resource_group_name`, `cluster_name`, `bare_metal_machine_key_set_name`, `subscription_id`, `location`, `properties`, `extendedLocation`		Create a new bare metal machine key set or update the existing one for the provided cluster.
`update`	`update`	`resource_group_name`, `cluster_name`, `bare_metal_machine_key_set_name`, `subscription_id`		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.
`create_or_update`	`replace`	`resource_group_name`, `cluster_name`, `bare_metal_machine_key_set_name`, `subscription_id`, `location`, `properties`, `extendedLocation`		Create a new bare metal machine key set or update the existing one for the provided cluster.
`delete`	`delete`	`resource_group_name`, `cluster_name`, `bare_metal_machine_key_set_name`, `subscription_id`		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
`bare_metal_machine_key_set_name`	`string`	The name of the bare metal machine key set. Required.
`cluster_name`	`string`	The name of the cluster. 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
list_by_cluster

Get bare metal machine key set of the provided cluster.

SELECT
id,
name,
azureGroupId,
detailedStatus,
detailedStatusMessage,
etag,
expiration,
extendedLocation,
jumpHostsAllowed,
lastValidation,
location,
osGroupName,
privilegeLevel,
privilegeLevelName,
provisioningState,
systemData,
tags,
type,
userList,
userListStatus
FROM azure_extras.network_cloud.bare_metal_machine_key_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND bare_metal_machine_key_set_name = '{{ bare_metal_machine_key_set_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

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

SELECT
id,
name,
azureGroupId,
detailedStatus,
detailedStatusMessage,
etag,
expiration,
extendedLocation,
jumpHostsAllowed,
lastValidation,
location,
osGroupName,
privilegeLevel,
privilegeLevelName,
provisioningState,
systemData,
tags,
type,
userList,
userListStatus
FROM azure_extras.network_cloud.bare_metal_machine_key_sets
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND cluster_name = '{{ cluster_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $top = '{{ $top }}'
AND $skipToken = '{{ $skipToken }}'
;

`INSERT` examples

create_or_update
Manifest

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

INSERT INTO azure_extras.network_cloud.bare_metal_machine_key_sets (
tags,
location,
properties,
extendedLocation,
resource_group_name,
cluster_name,
bare_metal_machine_key_set_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ extendedLocation }}' /* required */,
'{{ resource_group_name }}',
'{{ cluster_name }}',
'{{ bare_metal_machine_key_set_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

# Description fields are for documentation purposes
- name: bare_metal_machine_key_sets
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the bare_metal_machine_key_sets resource.
  - name: cluster_name
    value: "{{ cluster_name }}"
    description: Required parameter for the bare_metal_machine_key_sets resource.
  - name: bare_metal_machine_key_set_name
    value: "{{ bare_metal_machine_key_set_name }}"
    description: Required parameter for the bare_metal_machine_key_sets resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the bare_metal_machine_key_sets 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:
      azureGroupId: "{{ azureGroupId }}"
      expiration: "{{ expiration }}"
      jumpHostsAllowed:
        - "{{ jumpHostsAllowed }}"
      osGroupName: "{{ osGroupName }}"
      privilegeLevel: "{{ privilegeLevel }}"
      privilegeLevelName: "{{ privilegeLevelName }}"
      userList:
        - azureUserName: "{{ azureUserName }}"
          description: "{{ description }}"
          sshPublicKey:
            keyData: "{{ keyData }}"
          userPrincipalName: "{{ userPrincipalName }}"
      detailedStatus: "{{ detailedStatus }}"
      detailedStatusMessage: "{{ detailedStatusMessage }}"
      lastValidation: "{{ lastValidation }}"
      userListStatus:
        - azureUserName: "{{ azureUserName }}"
          status: "{{ status }}"
          statusMessage: "{{ statusMessage }}"
      provisioningState: "{{ provisioningState }}"
  - name: extendedLocation
    description: |
      The extended location of the resource. This property is required when creating the resource. Required.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

`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_extras.network_cloud.bare_metal_machine_key_sets
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND bare_metal_machine_key_set_name = '{{ bare_metal_machine_key_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

`REPLACE` examples

create_or_update

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

REPLACE azure_extras.network_cloud.bare_metal_machine_key_sets
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND bare_metal_machine_key_set_name = '{{ bare_metal_machine_key_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
AND extendedLocation = '{{ extendedLocation }}' --required
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

`DELETE` examples

delete

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

DELETE FROM azure_extras.network_cloud.bare_metal_machine_key_sets
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND cluster_name = '{{ cluster_name }}' --required
AND bare_metal_machine_key_set_name = '{{ bare_metal_machine_key_set_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

REPLACE examples​

DELETE examples​