autoscale_settings

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

Overview

Name	autoscale_settings
Type	Resource
Id	azure.monitor.autoscale_settings

Fields

The following fields are returned by SELECT queries:

get

Successful request to get one autoscale setting

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The autoscale setting of the resource.
tags		Resource tags
type	string	Azure resource type

list_by_resource_group

Successful request for a list of autoscale settings

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The autoscale setting of the resource.
tags		Resource tags
type	string	Azure resource type

list_by_subscription

Successful request for a list of autoscale settings

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name
location	string	Resource location
properties	object	The autoscale setting of the resource.
tags		Resource tags
type	string	Azure resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, autoscaleSettingName, subscriptionId		Gets an autoscale setting
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists the autoscale settings for a resource group
list_by_subscription	select	subscriptionId		Lists the autoscale settings for a subscription
create_or_update	insert	resourceGroupName, autoscaleSettingName, subscriptionId, data__properties		Creates or updates an autoscale setting.
update	update	subscriptionId, resourceGroupName, autoscaleSettingName		Updates an existing AutoscaleSettingsResource. To update other fields use the CreateOrUpdate method.
delete	delete	resourceGroupName, autoscaleSettingName, subscriptionId		Deletes and autoscale setting

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
autoscaleSettingName	string	The autoscale setting name.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets an autoscale setting

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.autoscale_settings
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND autoscaleSettingName = '{{ autoscaleSettingName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists the autoscale settings for a resource group

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.autoscale_settings
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_subscription

Lists the autoscale settings for a subscription

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.monitor.autoscale_settings
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates an autoscale setting.

INSERT INTO azure.monitor.autoscale_settings (
data__location,
data__tags,
data__properties,
resourceGroupName,
autoscaleSettingName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}' /* required */,
'{{ resourceGroupName }}',
'{{ autoscaleSettingName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: autoscale_settings
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the autoscale_settings resource.
    - name: autoscaleSettingName
      value: string
      description: Required parameter for the autoscale_settings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the autoscale_settings resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: string
      description: |
        Resource tags
    - name: properties
      value: object
      description: |
        The autoscale setting of the resource.

UPDATE examples

update

Updates an existing AutoscaleSettingsResource. To update other fields use the CreateOrUpdate method.

UPDATE azure.monitor.autoscale_settings
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND autoscaleSettingName = '{{ autoscaleSettingName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes and autoscale setting

DELETE FROM azure.monitor.autoscale_settings
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND autoscaleSettingName = '{{ autoscaleSettingName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;