outbound_endpoints

Creates, updates, deletes, gets or lists an outbound_endpoints resource.

Overview

Name	outbound_endpoints
Type	Resource
Id	azure.dns_resolver.outbound_endpoints

Fields

The following fields are returned by SELECT queries:

get

The outbound endpoint for the DNS resolver was found.

Name	Datatype	Description
etag	string	ETag of the outbound endpoint.
location	string	The geo-location where the resource lives
properties	object	Properties of the outbound endpoint.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

list

List of outbound endpoints for the DNS resolver.

Name	Datatype	Description
etag	string	ETag of the outbound endpoint.
location	string	The geo-location where the resource lives
properties	object	Properties of the outbound endpoint.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, dnsResolverName, outboundEndpointName		Gets properties of an outbound endpoint for a DNS resolver.
list	select	subscriptionId, resourceGroupName, dnsResolverName	$top	Lists outbound endpoints for a DNS resolver.
create_or_update	insert	subscriptionId, resourceGroupName, dnsResolverName, outboundEndpointName, data__properties	If-Match, If-None-Match	Creates or updates an outbound endpoint for a DNS resolver.
update	update	subscriptionId, resourceGroupName, dnsResolverName, outboundEndpointName	If-Match	Updates an outbound endpoint for a DNS resolver.
delete	delete	subscriptionId, resourceGroupName, dnsResolverName, outboundEndpointName	If-Match	Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.

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
dnsResolverName	string	The name of the DNS resolver.
outboundEndpointName	string	The name of the outbound endpoint for the DNS resolver.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
$top	integer (int32)	The maximum number of results to return. If not specified, returns up to 100 results.
If-Match	string	ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
If-None-Match	string	Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.

SELECT examples

get

Gets properties of an outbound endpoint for a DNS resolver.

SELECT
etag,
location,
properties,
systemData,
tags
FROM azure.dns_resolver.outbound_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dnsResolverName = '{{ dnsResolverName }}' -- required
AND outboundEndpointName = '{{ outboundEndpointName }}' -- required
;

list

Lists outbound endpoints for a DNS resolver.

SELECT
etag,
location,
properties,
systemData,
tags
FROM azure.dns_resolver.outbound_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dnsResolverName = '{{ dnsResolverName }}' -- required
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates or updates an outbound endpoint for a DNS resolver.

INSERT INTO azure.dns_resolver.outbound_endpoints (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
dnsResolverName,
outboundEndpointName,
If-Match,
If-None-Match
)
SELECT 
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dnsResolverName }}',
'{{ outboundEndpointName }}',
'{{ If-Match }}',
'{{ If-None-Match }}'
RETURNING
etag,
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: outbound_endpoints
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the outbound_endpoints resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the outbound_endpoints resource.
    - name: dnsResolverName
      value: string
      description: Required parameter for the outbound_endpoints resource.
    - name: outboundEndpointName
      value: string
      description: Required parameter for the outbound_endpoints resource.
    - name: properties
      value: object
      description: |
        Properties of the outbound endpoint.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: If-Match
      value: string
      description: ETag of the resource. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting any concurrent changes.
    - name: If-None-Match
      value: string
      description: Set to '*' to allow a new resource to be created, but to prevent updating an existing resource. Other values will be ignored.

UPDATE examples

update

Updates an outbound endpoint for a DNS resolver.

UPDATE azure.dns_resolver.outbound_endpoints
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dnsResolverName = '{{ dnsResolverName }}' --required
AND outboundEndpointName = '{{ outboundEndpointName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
etag,
location,
properties,
systemData,
tags;

DELETE examples

delete

Deletes an outbound endpoint for a DNS resolver. WARNING: This operation cannot be undone.

DELETE FROM azure.dns_resolver.outbound_endpoints
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dnsResolverName = '{{ dnsResolverName }}' --required
AND outboundEndpointName = '{{ outboundEndpointName }}' --required
AND If-Match = '{{ If-Match }}'
;