ddos_protection_plans

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

Overview

Name	ddos_protection_plans
Type	Resource
Id	azure.network.ddos_protection_plans

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the specified DDoS protection plan resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the DDoS protection plan.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Request successful. The operation returns a list of DDoS protection plan resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the DDoS protection plan.
tags	object	Resource tags.
type	string	Resource type.

list

Request successful. The operation returns a list of DDoS protection plan resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
etag	string	A unique read-only string that changes whenever the resource is updated.
location	string	Resource location.
properties	object	Properties of the DDoS protection plan.
tags	object	Resource tags.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, ddosProtectionPlanName, subscriptionId		Gets information about the specified DDoS protection plan.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all the DDoS protection plans in a resource group.
list	select	subscriptionId		Gets all DDoS protection plans in a subscription.
create_or_update	insert	resourceGroupName, ddosProtectionPlanName, subscriptionId		Creates or updates a DDoS protection plan.
delete	delete	resourceGroupName, ddosProtectionPlanName, subscriptionId		Deletes the specified DDoS protection plan.
update_tags	exec	resourceGroupName, ddosProtectionPlanName, subscriptionId		Update a DDoS protection plan 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
ddosProtectionPlanName	string	The name of the DDoS protection plan.
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 protection plan.

SELECT
id,
name,
etag,
location,
properties,
tags,
type
FROM azure.network.ddos_protection_plans
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND ddosProtectionPlanName = '{{ ddosProtectionPlanName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Gets all the DDoS protection plans in a resource group.

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

list

Gets all DDoS protection plans in a subscription.

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

INSERT examples

create_or_update

Creates or updates a DDoS protection plan.

INSERT INTO azure.network.ddos_protection_plans (
data__location,
data__tags,
data__properties,
resourceGroupName,
ddosProtectionPlanName,
subscriptionId
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ ddosProtectionPlanName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: ddos_protection_plans
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the ddos_protection_plans resource.
    - name: ddosProtectionPlanName
      value: string
      description: Required parameter for the ddos_protection_plans resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the ddos_protection_plans resource.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: properties
      value: object
      description: |
        Properties of the DDoS protection plan.

DELETE examples

delete

Deletes the specified DDoS protection plan.

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

Lifecycle Methods

update_tags

Update a DDoS protection plan tags.

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