management_configurations

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

Overview

Name	management_configurations
Type	Resource
Id	azure.operations_management.management_configurations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
applicationId	string	The applicationId of the appliance for this Management.
location	string	Resource location.
parameters	array	Parameters to run the ARM template. Required.
parentResourceType	string	The type of the parent resource. Required.
provisioningState	string	The provisioning state for the ManagementConfiguration.
template	object	The Json object containing the ARM template to deploy. Required.
type	string	Resource type.

list_by_subscription

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
applicationId	string	The applicationId of the appliance for this Management.
location	string	Resource location.
parameters	array	Parameters to run the ARM template. Required.
parentResourceType	string	The type of the parent resource. Required.
provisioningState	string	The provisioning state for the ManagementConfiguration.
template	object	The Json object containing the ARM template to deploy. Required.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, management_configuration_name, subscription_id		Retrieve ManagementConfiguration. Retrieves the user ManagementConfiguration.
list_by_subscription	select	subscription_id		Retrieves the ManagementConfigurations list for the subscription. Retrieves the ManagementConfigurations list.
create_or_update	insert	resource_group_name, management_configuration_name, subscription_id		Create/Update ManagementConfiguration. Creates or updates the ManagementConfiguration.
create_or_update	replace	resource_group_name, management_configuration_name, subscription_id		Create/Update ManagementConfiguration. Creates or updates the ManagementConfiguration.
delete	delete	resource_group_name, management_configuration_name, subscription_id		Deletes the ManagementConfiguration. Deletes the ManagementConfiguration in the subscription.

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
management_configuration_name	string	User Management Configuration Name. Required.
resource_group_name	string	The name of the resource group to get. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Retrieve ManagementConfiguration. Retrieves the user ManagementConfiguration.

SELECT
id,
name,
applicationId,
location,
parameters,
parentResourceType,
provisioningState,
template,
type
FROM azure.operations_management.management_configurations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND management_configuration_name = '{{ management_configuration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Retrieves the ManagementConfigurations list for the subscription. Retrieves the ManagementConfigurations list.

SELECT
id,
name,
applicationId,
location,
parameters,
parentResourceType,
provisioningState,
template,
type
FROM azure.operations_management.management_configurations
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create/Update ManagementConfiguration. Creates or updates the ManagementConfiguration.

INSERT INTO azure.operations_management.management_configurations (
location,
properties,
resource_group_name,
management_configuration_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ management_configuration_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: management_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the management_configurations resource.
  - name: management_configuration_name
    value: "{{ management_configuration_name }}"
    description: Required parameter for the management_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the management_configurations resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: properties
    description: |
      Properties for ManagementConfiguration object supported by the OperationsManagement resource provider.
    value:
      applicationId: "{{ applicationId }}"
      parentResourceType: "{{ parentResourceType }}"
      parameters:
        - name: "{{ name }}"
          value: "{{ value }}"
      provisioningState: "{{ provisioningState }}"
      template: "{{ template }}"

REPLACE examples

create_or_update

Create/Update ManagementConfiguration. Creates or updates the ManagementConfiguration.

REPLACE azure.operations_management.management_configurations
SET 
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND management_configuration_name = '{{ management_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
type;

DELETE examples

delete

Deletes the ManagementConfiguration. Deletes the ManagementConfiguration in the subscription.

DELETE FROM azure.operations_management.management_configurations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND management_configuration_name = '{{ management_configuration_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;