service_endpoint_policies

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

Overview

Name	service_endpoint_policies
Type	Resource
Id	azure.network.service_endpoint_policies

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting ServiceEndpointPolicy 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.
kind	string	Kind of service endpoint policy. This is metadata used for the Azure portal experience.
properties	object	Properties of the service end point 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"

list_by_resource_group

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

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.
kind	string	Kind of service endpoint policy. This is metadata used for the Azure portal experience.
properties	object	Properties of the service end point 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"

list

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

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.
kind	string	Kind of service endpoint policy. This is metadata used for the Azure portal experience.
properties	object	Properties of the service end point 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, serviceEndpointPolicyName, subscriptionId	$expand	Gets the specified service Endpoint Policies in a specified resource group.
list_by_resource_group	select	resourceGroupName, subscriptionId		Gets all service endpoint Policies in a resource group.
list	select	subscriptionId		Gets all the service endpoint policies in a subscription.
create_or_update	insert	resourceGroupName, serviceEndpointPolicyName, subscriptionId		Creates or updates a service Endpoint Policies.
delete	delete	resourceGroupName, serviceEndpointPolicyName, subscriptionId		Deletes the specified service endpoint policy.
update_tags	exec	resourceGroupName, serviceEndpointPolicyName, subscriptionId		Updates tags of a service endpoint policy.

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.
serviceEndpointPolicyName	string	The name of the service endpoint policy.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	Expands referenced resources.

SELECT examples

get

Gets the specified service Endpoint Policies in a specified resource group.

SELECT
id,
name,
etag,
kind,
properties,
systemData,
type
FROM azure.network.service_endpoint_policies
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND serviceEndpointPolicyName = '{{ serviceEndpointPolicyName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets all service endpoint Policies in a resource group.

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

list

Gets all the service endpoint policies in a subscription.

SELECT
id,
name,
etag,
kind,
properties,
systemData,
type
FROM azure.network.service_endpoint_policies
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a service Endpoint Policies.

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

Manifest

# Description fields are for documentation purposes
- name: service_endpoint_policies
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the service_endpoint_policies resource.
    - name: serviceEndpointPolicyName
      value: string
      description: Required parameter for the service_endpoint_policies resource.
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the service_endpoint_policies resource.
    - name: properties
      value: object
      description: |
        Properties of the service end point policy.

DELETE examples

delete

Deletes the specified service endpoint policy.

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

Lifecycle Methods

update_tags

Updates tags of a service endpoint policy.

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