authentication_settings

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

Overview

Name	authentication_settings
Type	Resource
Id	azure.cloud_health.authentication_settings

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.
authenticationKind	string	Kind of the authentication setting. Required. "ManagedIdentity"
displayName	string	Display name.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_health_model

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.
authenticationKind	string	Kind of the authentication setting. Required. "ManagedIdentity"
displayName	string	Display name.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Creating", and "Deleting". (Succeeded, Failed, Canceled, Creating, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, health_model_name, authentication_setting_name, subscription_id		Get a AuthenticationSetting.
list_by_health_model	select	resource_group_name, health_model_name, subscription_id		List AuthenticationSetting resources by HealthModel.
create_or_update	insert	resource_group_name, health_model_name, authentication_setting_name, subscription_id		Create a AuthenticationSetting.
create_or_update	replace	resource_group_name, health_model_name, authentication_setting_name, subscription_id		Create a AuthenticationSetting.
delete	delete	resource_group_name, health_model_name, authentication_setting_name, subscription_id		Delete a AuthenticationSetting.

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
authentication_setting_name	string	Name of the authentication setting. Must be unique within a health model. Required.
health_model_name	string	Name of health model resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a AuthenticationSetting.

SELECT
id,
name,
authenticationKind,
displayName,
provisioningState,
systemData,
type
FROM azure.cloud_health.authentication_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND health_model_name = '{{ health_model_name }}' -- required
AND authentication_setting_name = '{{ authentication_setting_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_health_model

List AuthenticationSetting resources by HealthModel.

SELECT
id,
name,
authenticationKind,
displayName,
provisioningState,
systemData,
type
FROM azure.cloud_health.authentication_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND health_model_name = '{{ health_model_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a AuthenticationSetting.

INSERT INTO azure.cloud_health.authentication_settings (
properties,
resource_group_name,
health_model_name,
authentication_setting_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ health_model_name }}',
'{{ authentication_setting_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: authentication_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the authentication_settings resource.
  - name: health_model_name
    value: "{{ health_model_name }}"
    description: Required parameter for the authentication_settings resource.
  - name: authentication_setting_name
    value: "{{ authentication_setting_name }}"
    description: Required parameter for the authentication_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the authentication_settings resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      displayName: "{{ displayName }}"
      authenticationKind: "{{ authenticationKind }}"

REPLACE examples

create_or_update

Create a AuthenticationSetting.

REPLACE azure.cloud_health.authentication_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND health_model_name = '{{ health_model_name }}' --required
AND authentication_setting_name = '{{ authentication_setting_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a AuthenticationSetting.

DELETE FROM azure.cloud_health.authentication_settings
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND health_model_name = '{{ health_model_name }}' --required
AND authentication_setting_name = '{{ authentication_setting_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;