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

Request successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the service endpoint policy definition.
type	string	The type of the resource.

list_by_resource_group

Request successful. The operation returns a list of ServiceEndpointPolicyDefinition resources.

Name	Datatype	Description
id	string	Resource ID.
name	string	The name of the resource that is unique within a resource group. This name can be used to access the resource.
etag	string	A unique read-only string that changes whenever the resource is updated.
properties	object	Properties of the service endpoint policy definition.
type	string	The type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, serviceEndpointPolicyName, serviceEndpointPolicyDefinitionName, subscriptionId		Get the specified service endpoint policy definitions from service endpoint policy.
list_by_resource_group	select	resourceGroupName, serviceEndpointPolicyName, subscriptionId		Gets all service endpoint policy definitions in a service end point policy.
create_or_update	insert	resourceGroupName, serviceEndpointPolicyName, serviceEndpointPolicyDefinitionName, subscriptionId		Creates or updates a service endpoint policy definition in the specified service endpoint policy.
delete	delete	resourceGroupName, serviceEndpointPolicyName, serviceEndpointPolicyDefinitionName, subscriptionId		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
resourceGroupName	string	The name of the resource group.
serviceEndpointPolicyDefinitionName	string	The name of the service endpoint policy definition.
serviceEndpointPolicyName	string	The name of the Service Endpoint Policy.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get the specified service endpoint policy definitions from service endpoint policy.

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.service_endpoint_policy_definitions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceEndpointPolicyName = '{{ serviceEndpointPolicyName }}' -- required
AND serviceEndpointPolicyDefinitionName = '{{ serviceEndpointPolicyDefinitionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
etag,
properties,
type
FROM azure.network.service_endpoint_policy_definitions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceEndpointPolicyName = '{{ serviceEndpointPolicyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- 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 (
data__properties,
data__name,
data__type,
data__id,
resourceGroupName,
serviceEndpointPolicyName,
serviceEndpointPolicyDefinitionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ name }}',
'{{ type }}',
'{{ id }}',
'{{ resourceGroupName }}',
'{{ serviceEndpointPolicyName }}',
'{{ serviceEndpointPolicyDefinitionName }}',
'{{ subscriptionId }}'
RETURNING
id,
name,
etag,
properties,
type
;

Manifest

# Description fields are for documentation purposes
- name: service_endpoint_policy_definitions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the service_endpoint_policy_definitions resource.
    - name: serviceEndpointPolicyName
      value: string
      description: Required parameter for the service_endpoint_policy_definitions resource.
    - name: serviceEndpointPolicyDefinitionName
      value: string
      description: Required parameter for the service_endpoint_policy_definitions resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the service_endpoint_policy_definitions resource.
    - name: properties
      value: object
      description: |
        Properties of the service endpoint policy definition.
    - name: name
      value: string
      description: |
        The name of the resource that is unique within a resource group. This name can be used to access the resource.
    - name: type
      value: string
      description: |
        The type of the resource.
    - name: id
      value: string
      description: |
        Resource ID.

DELETE examples

delete

Deletes the specified ServiceEndpoint policy definitions.

DELETE FROM azure.network.service_endpoint_policy_definitions
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceEndpointPolicyName = '{{ serviceEndpointPolicyName }}' --required
AND serviceEndpointPolicyDefinitionName = '{{ serviceEndpointPolicyDefinitionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;