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

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.
provisioningState	string	The provisioning state of the DDoS protection plan resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddresses	array	The list of public IPs associated with the DDoS protection plan resource. This list is read-only.
resourceGuid	string	The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
tags	object	Resource tags.
type	string	Resource type.
virtualNetworks	array	The list of virtual networks associated with the DDoS protection plan resource. This list is read-only.

list_by_resource_group

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.
provisioningState	string	The provisioning state of the DDoS protection plan resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddresses	array	The list of public IPs associated with the DDoS protection plan resource. This list is read-only.
resourceGuid	string	The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
tags	object	Resource tags.
type	string	Resource type.
virtualNetworks	array	The list of virtual networks associated with the DDoS protection plan resource. This list is read-only.

list

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.
provisioningState	string	The provisioning state of the DDoS protection plan resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
publicIPAddresses	array	The list of public IPs associated with the DDoS protection plan resource. This list is read-only.
resourceGuid	string	The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups.
tags	object	Resource tags.
type	string	Resource type.
virtualNetworks	array	The list of virtual networks associated with the DDoS protection plan resource. This list is read-only.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, ddos_protection_plan_name, subscription_id		Gets information about the specified DDoS protection plan.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all the DDoS protection plans in a resource group.
list	select	subscription_id		Gets all DDoS protection plans in a subscription.
create_or_update	insert	resource_group_name, ddos_protection_plan_name, subscription_id		Creates or updates a DDoS protection plan.
update_tags	update	resource_group_name, ddos_protection_plan_name, subscription_id		Update a DDoS protection plan tags.
create_or_update	replace	resource_group_name, ddos_protection_plan_name, subscription_id		Creates or updates a DDoS protection plan.
delete	delete	resource_group_name, ddos_protection_plan_name, subscription_id		Deletes the specified DDoS protection plan.

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

SELECT examples

get

Gets information about the specified DDoS protection plan.

SELECT
id,
name,
etag,
location,
provisioningState,
publicIPAddresses,
resourceGuid,
tags,
type,
virtualNetworks
FROM azure.network.ddos_protection_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND ddos_protection_plan_name = '{{ ddos_protection_plan_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all the DDoS protection plans in a resource group.

SELECT
id,
name,
etag,
location,
provisioningState,
publicIPAddresses,
resourceGuid,
tags,
type,
virtualNetworks
FROM azure.network.ddos_protection_plans
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all DDoS protection plans in a subscription.

SELECT
id,
name,
etag,
location,
provisioningState,
publicIPAddresses,
resourceGuid,
tags,
type,
virtualNetworks
FROM azure.network.ddos_protection_plans
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a DDoS protection plan.

INSERT INTO azure.network.ddos_protection_plans (
location,
tags,
properties,
resource_group_name,
ddos_protection_plan_name,
subscription_id
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ ddos_protection_plan_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: ddos_protection_plans
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the ddos_protection_plans resource.
  - name: ddos_protection_plan_name
    value: "{{ ddos_protection_plan_name }}"
    description: Required parameter for the ddos_protection_plans resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the ddos_protection_plans resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the DDoS protection plan.
    value:
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
      publicIPAddresses:
        - id: "{{ id }}"
      virtualNetworks:
        - id: "{{ id }}"

UPDATE examples

update_tags

Update a DDoS protection plan tags.

UPDATE azure.network.ddos_protection_plans
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND ddos_protection_plan_name = '{{ ddos_protection_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a DDoS protection plan.

REPLACE azure.network.ddos_protection_plans
SET 
location = '{{ location }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND ddos_protection_plan_name = '{{ ddos_protection_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
tags,
type;

DELETE examples

delete

Deletes the specified DDoS protection plan.

DELETE FROM azure.network.ddos_protection_plans
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND ddos_protection_plan_name = '{{ ddos_protection_plan_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;