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

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
contextualServiceEndpointPolicies	array	A collection of contextual service endpoint policy.
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.
location	string	Resource location.
provisioningState	string	The provisioning state of the service endpoint policy resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the service endpoint policy resource.
serviceAlias	string	The alias indicating if the policy belongs to a service.
serviceEndpointPolicyDefinitions	array	A collection of service endpoint policy definitions of the service endpoint policy.
subnets	array	A collection of references to subnets.
tags	object	Resource tags.
type	string	Resource type.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
contextualServiceEndpointPolicies	array	A collection of contextual service endpoint policy.
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.
location	string	Resource location.
provisioningState	string	The provisioning state of the service endpoint policy resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the service endpoint policy resource.
serviceAlias	string	The alias indicating if the policy belongs to a service.
serviceEndpointPolicyDefinitions	array	A collection of service endpoint policy definitions of the service endpoint policy.
subnets	array	A collection of references to subnets.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
contextualServiceEndpointPolicies	array	A collection of contextual service endpoint policy.
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.
location	string	Resource location.
provisioningState	string	The provisioning state of the service endpoint policy resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
resourceGuid	string	The resource GUID property of the service endpoint policy resource.
serviceAlias	string	The alias indicating if the policy belongs to a service.
serviceEndpointPolicyDefinitions	array	A collection of service endpoint policy definitions of the service endpoint policy.
subnets	array	A collection of references to subnets.
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	resource_group_name, service_endpoint_policy_name, subscription_id	$expand	Gets the specified service Endpoint Policies in a specified resource group.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all service endpoint Policies in a resource group.
list	select	subscription_id		Gets all the service endpoint policies in a subscription.
create_or_update	insert	resource_group_name, service_endpoint_policy_name, subscription_id		Creates or updates a service Endpoint Policies.
update_tags	update	resource_group_name, service_endpoint_policy_name, subscription_id		Updates tags of a service endpoint policy.
create_or_update	replace	resource_group_name, service_endpoint_policy_name, subscription_id		Creates or updates a service Endpoint Policies.
delete	delete	resource_group_name, service_endpoint_policy_name, subscription_id		Deletes the specified 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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_endpoint_policy_name	string	The name of the service endpoint policy. Required.
subscription_id	string
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get

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

SELECT
id,
name,
contextualServiceEndpointPolicies,
etag,
kind,
location,
provisioningState,
resourceGuid,
serviceAlias,
serviceEndpointPolicyDefinitions,
subnets,
tags,
type
FROM azure.network.service_endpoint_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_endpoint_policy_name = '{{ service_endpoint_policy_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

Gets all service endpoint Policies in a resource group.

SELECT
id,
name,
contextualServiceEndpointPolicies,
etag,
kind,
location,
provisioningState,
resourceGuid,
serviceAlias,
serviceEndpointPolicyDefinitions,
subnets,
tags,
type
FROM azure.network.service_endpoint_policies
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Gets all the service endpoint policies in a subscription.

SELECT
id,
name,
contextualServiceEndpointPolicies,
etag,
kind,
location,
provisioningState,
resourceGuid,
serviceAlias,
serviceEndpointPolicyDefinitions,
subnets,
tags,
type
FROM azure.network.service_endpoint_policies
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a service Endpoint Policies.

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

Manifest

# Description fields are for documentation purposes
- name: service_endpoint_policies
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the service_endpoint_policies resource.
  - name: service_endpoint_policy_name
    value: "{{ service_endpoint_policy_name }}"
    description: Required parameter for the service_endpoint_policies resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the service_endpoint_policies resource.
  - name: id
    value: "{{ id }}"
    description: |
      Resource ID.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: properties
    description: |
      Properties of the service end point policy.
    value:
      serviceEndpointPolicyDefinitions:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            description: "{{ description }}"
            service: "{{ service }}"
            serviceResources:
              - "{{ serviceResources }}"
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"
      subnets:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          properties:
            addressPrefix: "{{ addressPrefix }}"
            addressPrefixes:
              - "{{ addressPrefixes }}"
            networkSecurityGroup:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                flushConnection: {{ flushConnection }}
                securityRules: "{{ securityRules }}"
                defaultSecurityRules: "{{ defaultSecurityRules }}"
                networkInterfaces: "{{ networkInterfaces }}"
                subnets: "{{ subnets }}"
                flowLogs: "{{ flowLogs }}"
                resourceGuid: "{{ resourceGuid }}"
                provisioningState: "{{ provisioningState }}"
              etag: "{{ etag }}"
            routeTable:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                routes: "{{ routes }}"
                subnets: "{{ subnets }}"
                disableBgpRoutePropagation: {{ disableBgpRoutePropagation }}
                disablePeeringRoute: "{{ disablePeeringRoute }}"
                provisioningState: "{{ provisioningState }}"
                resourceGuid: "{{ resourceGuid }}"
              etag: "{{ etag }}"
            natGateway:
              id: "{{ id }}"
            serviceEndpoints:
              - service: "{{ service }}"
                networkIdentifier:
                  id: "{{ id }}"
                locations: "{{ locations }}"
                provisioningState: "{{ provisioningState }}"
            serviceEndpointPolicies:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  serviceEndpointPolicyDefinitions: "{{ serviceEndpointPolicyDefinitions }}"
                  subnets: "{{ subnets }}"
                  resourceGuid: "{{ resourceGuid }}"
                  provisioningState: "{{ provisioningState }}"
                  serviceAlias: "{{ serviceAlias }}"
                  contextualServiceEndpointPolicies: "{{ contextualServiceEndpointPolicies }}"
                etag: "{{ etag }}"
                kind: "{{ kind }}"
            privateEndpoints:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                location: "{{ location }}"
                tags: "{{ tags }}"
                properties:
                  subnet: "{{ subnet }}"
                  networkInterfaces: "{{ networkInterfaces }}"
                  provisioningState: "{{ provisioningState }}"
                  ipVersionType: "{{ ipVersionType }}"
                  privateLinkServiceConnections: "{{ privateLinkServiceConnections }}"
                  manualPrivateLinkServiceConnections: "{{ manualPrivateLinkServiceConnections }}"
                  customDnsConfigs: "{{ customDnsConfigs }}"
                  applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                  ipConfigurations: "{{ ipConfigurations }}"
                  customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
                  billingSku: "{{ billingSku }}"
                extendedLocation:
                  name: "{{ name }}"
                  type: "{{ type }}"
                etag: "{{ etag }}"
            ipConfigurations:
              - id: "{{ id }}"
                properties:
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  subnet: "{{ subnet }}"
                  publicIPAddress: "{{ publicIPAddress }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
            ipConfigurationProfiles:
              - id: "{{ id }}"
                properties:
                  subnet: "{{ subnet }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                type: "{{ type }}"
                etag: "{{ etag }}"
            ipAllocations:
              - id: "{{ id }}"
            resourceNavigationLinks:
              - id: "{{ id }}"
                properties:
                  linkedResourceType: "{{ linkedResourceType }}"
                  link: "{{ link }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            serviceAssociationLinks:
              - id: "{{ id }}"
                properties:
                  linkedResourceType: "{{ linkedResourceType }}"
                  link: "{{ link }}"
                  provisioningState: "{{ provisioningState }}"
                  allowDelete: {{ allowDelete }}
                  locations: "{{ locations }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            delegations:
              - id: "{{ id }}"
                properties:
                  serviceName: "{{ serviceName }}"
                  actions: "{{ actions }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            purpose: "{{ purpose }}"
            provisioningState: "{{ provisioningState }}"
            privateEndpointNetworkPolicies: "{{ privateEndpointNetworkPolicies }}"
            privateLinkServiceNetworkPolicies: "{{ privateLinkServiceNetworkPolicies }}"
            applicationGatewayIPConfigurations:
              - id: "{{ id }}"
                properties:
                  subnet: "{{ subnet }}"
                  provisioningState: "{{ provisioningState }}"
                name: "{{ name }}"
                etag: "{{ etag }}"
                type: "{{ type }}"
            sharingScope: "{{ sharingScope }}"
            defaultOutboundAccess: {{ defaultOutboundAccess }}
            ipamPoolPrefixAllocations:
              - pool:
                  id: "{{ id }}"
                numberOfIpAddresses: "{{ numberOfIpAddresses }}"
                allocatedAddressPrefixes: "{{ allocatedAddressPrefixes }}"
            serviceGateway:
              id: "{{ id }}"
          etag: "{{ etag }}"
      resourceGuid: "{{ resourceGuid }}"
      provisioningState: "{{ provisioningState }}"
      serviceAlias: "{{ serviceAlias }}"
      contextualServiceEndpointPolicies:
        - "{{ contextualServiceEndpointPolicies }}"

UPDATE examples

update_tags

Updates tags of a service endpoint policy.

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

REPLACE examples

create_or_update

Creates or updates a service Endpoint Policies.

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

DELETE examples

delete

Deletes the specified service endpoint policy.

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