ddos_custom_policies

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

Overview

Name	ddos_custom_policies
Type	Resource
Id	azure.network.ddos_custom_policies

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the specified DDoS custom policy resource.

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the DDoS custom policy.
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	resourceGroupName, ddosCustomPolicyName, subscriptionId		Gets information about the specified DDoS custom policy.
create_or_update	insert	resourceGroupName, ddosCustomPolicyName, subscriptionId		Creates or updates a DDoS custom policy.
delete	delete	resourceGroupName, ddosCustomPolicyName, subscriptionId		Deletes the specified DDoS custom policy.
update_tags	exec	resourceGroupName, ddosCustomPolicyName, subscriptionId		Update a DDoS custom policy tags.

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
ddosCustomPolicyName	string	The name of the DDoS custom policy.
resourceGroupName	string	The name of the resource group.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets information about the specified DDoS custom policy.

SELECT
id,
name,
etag,
properties,
systemData,
type
FROM azure.network.ddos_custom_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND ddosCustomPolicyName = '{{ ddosCustomPolicyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a DDoS custom policy.

INSERT INTO azure.network.ddos_custom_policies (
data__properties,
resourceGroupName,
ddosCustomPolicyName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ ddosCustomPolicyName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: ddos_custom_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the ddos_custom_policies resource.
    - name: ddosCustomPolicyName
      value: string
      description: Required parameter for the ddos_custom_policies resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the ddos_custom_policies resource.
    - name: properties
      value: object
      description: |
        Properties of the DDoS custom policy.

DELETE examples

delete

Deletes the specified DDoS custom policy.

DELETE FROM azure.network.ddos_custom_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND ddosCustomPolicyName = '{{ ddosCustomPolicyName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Update a DDoS custom policy tags.

EXEC azure.network.ddos_custom_policies.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@ddosCustomPolicyName='{{ ddosCustomPolicyName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;