usage_plans

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

Overview

Name	usage_plans
Type	Resource
Id	azure.resilience_management.usage_plans

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.
errorDetails	object	Details of any errors encountered during Usage Plan create or update.
location	string	The geo-location where the resource lives. Required.
planType	string	The type of the usage plan. Known values are: "Basic" and "Standard". (Basic, Standard)
provisioningState	string	Provisioning state of the usage plan. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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".

list_by_resource_group

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.
errorDetails	object	Details of any errors encountered during Usage Plan create or update.
location	string	The geo-location where the resource lives. Required.
planType	string	The type of the usage plan. Known values are: "Basic" and "Standard". (Basic, Standard)
provisioningState	string	Provisioning state of the usage plan. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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".

list_by_subscription

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.
errorDetails	object	Details of any errors encountered during Usage Plan create or update.
location	string	The geo-location where the resource lives. Required.
planType	string	The type of the usage plan. Known values are: "Basic" and "Standard". (Basic, Standard)
provisioningState	string	Provisioning state of the usage plan. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
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".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, usage_plan_name, subscription_id		Get a UsagePlan.
list_by_resource_group	select	resource_group_name, subscription_id		List UsagePlan resources by resource group.
list_by_subscription	select	subscription_id		List UsagePlan resources by subscription ID.
create_or_update	insert	resource_group_name, usage_plan_name, subscription_id, location		Create a UsagePlan.
update	update	resource_group_name, usage_plan_name, subscription_id		Update a UsagePlan.
create_or_update	replace	resource_group_name, usage_plan_name, subscription_id, location		Create a UsagePlan.
delete	delete	resource_group_name, usage_plan_name, subscription_id		Delete a UsagePlan.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
usage_plan_name	string	The name of the usage plan. Required.

SELECT examples

get

Get a UsagePlan.

SELECT
id,
name,
errorDetails,
location,
planType,
provisioningState,
systemData,
tags,
type
FROM azure.resilience_management.usage_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND usage_plan_name = '{{ usage_plan_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List UsagePlan resources by resource group.

SELECT
id,
name,
errorDetails,
location,
planType,
provisioningState,
systemData,
tags,
type
FROM azure.resilience_management.usage_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List UsagePlan resources by subscription ID.

SELECT
id,
name,
errorDetails,
location,
planType,
provisioningState,
systemData,
tags,
type
FROM azure.resilience_management.usage_plans
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a UsagePlan.

INSERT INTO azure.resilience_management.usage_plans (
tags,
location,
properties,
resource_group_name,
usage_plan_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ usage_plan_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: usage_plans
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the usage_plans resource.
  - name: usage_plan_name
    value: "{{ usage_plan_name }}"
    description: Required parameter for the usage_plans resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the usage_plans 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 resource-specific properties for this resource.
    value:
      planType: "{{ planType }}"
      provisioningState: "{{ provisioningState }}"
      errorDetails:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        details:
          - code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details: "{{ details }}"
            additionalInfo: "{{ additionalInfo }}"
        additionalInfo:
          - type: "{{ type }}"
            info: "{{ info }}"

UPDATE examples

update

Update a UsagePlan.

UPDATE azure.resilience_management.usage_plans
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND usage_plan_name = '{{ usage_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a UsagePlan.

REPLACE azure.resilience_management.usage_plans
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND usage_plan_name = '{{ usage_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a UsagePlan.

DELETE FROM azure.resilience_management.usage_plans
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND usage_plan_name = '{{ usage_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;