service_endpoint_policy_definitions

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

Overview

Name	service_endpoint_policy_definitions
Type	Resource
Id	azure.network.service_endpoint_policy_definitions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
description	string	A description for this rule. Restricted to 140 chars.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the service endpoint policy definition resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
service	string	Service endpoint name.
serviceResources	array	A list of service resources.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Name of the resource.
description	string	A description for this rule. Restricted to 140 chars.
etag	string	A unique read-only string that changes whenever the resource is updated.
provisioningState	string	The provisioning state of the service endpoint policy definition resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
service	string	Service endpoint name.
serviceResources	array	A list of service resources.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_endpoint_policy_name, service_endpoint_policy_definition_name, subscription_id		Get a ServiceEndpointPolicyDefinition.
list_by_resource_group	select	resource_group_name, service_endpoint_policy_name, subscription_id		Gets all service endpoint policy definitions in a service end point policy.
create_or_update	insert	resource_group_name, service_endpoint_policy_name, service_endpoint_policy_definition_name, subscription_id		Creates or updates a service endpoint policy definition in the specified service endpoint policy.
create_or_update	replace	resource_group_name, service_endpoint_policy_name, service_endpoint_policy_definition_name, subscription_id		Creates or updates a service endpoint policy definition in the specified service endpoint policy.
delete	delete	resource_group_name, service_endpoint_policy_name, service_endpoint_policy_definition_name, subscription_id		Deletes the specified ServiceEndpoint policy definitions.

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.
service_endpoint_policy_definition_name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource. Required.
service_endpoint_policy_name	string	The name of the service endpoint policy. Required.
subscription_id	string

SELECT examples

get

Get a ServiceEndpointPolicyDefinition.

SELECT
id,
name,
description,
etag,
provisioningState,
service,
serviceResources,
type
FROM azure.network.service_endpoint_policy_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_endpoint_policy_name = '{{ service_endpoint_policy_name }}' -- required
AND service_endpoint_policy_definition_name = '{{ service_endpoint_policy_definition_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all service endpoint policy definitions in a service end point policy.

SELECT
id,
name,
description,
etag,
provisioningState,
service,
serviceResources,
type
FROM azure.network.service_endpoint_policy_definitions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_endpoint_policy_name = '{{ service_endpoint_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a service endpoint policy definition in the specified service endpoint policy.

INSERT INTO azure.network.service_endpoint_policy_definitions (
id,
name,
properties,
resource_group_name,
service_endpoint_policy_name,
service_endpoint_policy_definition_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ name }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_endpoint_policy_name }}',
'{{ service_endpoint_policy_definition_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: service_endpoint_policy_definitions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the service_endpoint_policy_definitions resource.
  - name: service_endpoint_policy_name
    value: "{{ service_endpoint_policy_name }}"
    description: Required parameter for the service_endpoint_policy_definitions resource.
  - name: service_endpoint_policy_definition_name
    value: "{{ service_endpoint_policy_definition_name }}"
    description: Required parameter for the service_endpoint_policy_definitions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the service_endpoint_policy_definitions resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: name
    value: "{{ name }}"
    description: |
      Name of the resource.
  - name: properties
    description: |
      Properties of the service endpoint policy definition.
    value:
      description: "{{ description }}"
      service: "{{ service }}"
      serviceResources:
        - "{{ serviceResources }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Creates or updates a service endpoint policy definition in the specified service endpoint policy.

REPLACE azure.network.service_endpoint_policy_definitions
SET 
id = '{{ id }}',
name = '{{ name }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_endpoint_policy_name = '{{ service_endpoint_policy_name }}' --required
AND service_endpoint_policy_definition_name = '{{ service_endpoint_policy_definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
properties,
type;

DELETE examples

delete

Deletes the specified ServiceEndpoint policy definitions.

DELETE FROM azure.network.service_endpoint_policy_definitions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_endpoint_policy_name = '{{ service_endpoint_policy_name }}' --required
AND service_endpoint_policy_definition_name = '{{ service_endpoint_policy_definition_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;