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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
resourceGuid	string	The resourceGuid property of the outbound endpoint resource.
subnet	object	Reference to another ARM resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
etag	string	"If etag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.").
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The current provisioning state of the outbound endpoint. This is a read-only property and any attempt to set this value will be ignored. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Failed", and "Canceled". (Creating, Updating, Deleting, Succeeded, Failed, Canceled)
resourceGuid	string	The resourceGuid property of the outbound endpoint resource.
subnet	object	Reference to another ARM resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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	resource_group_name, dns_resolver_name, outbound_endpoint_name, subscription_id		Gets properties of an outbound endpoint for a DNS resolver.
list	select	resource_group_name, dns_resolver_name, subscription_id	$top	Lists outbound endpoints for a DNS resolver.
create_or_update	insert	resource_group_name, dns_resolver_name, outbound_endpoint_name, subscription_id, location, properties		Creates or updates an outbound endpoint for a DNS resolver.
update	update	resource_group_name, dns_resolver_name, outbound_endpoint_name, subscription_id		Updates an outbound endpoint for a DNS resolver.
create_or_update	replace	resource_group_name, dns_resolver_name, outbound_endpoint_name, subscription_id, location, properties		Creates or updates an outbound endpoint for a DNS resolver.
delete	delete	resource_group_name, dns_resolver_name, outbound_endpoint_name, subscription_id		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
dns_resolver_name	string	The name of the DNS resolver. Required.
outbound_endpoint_name	string	The name of the outbound endpoint for the DNS resolver. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$top	integer	The maximum number of results to return. If not specified, returns up to 100 results. Default value is None.

SELECT examples

get

Gets properties of an outbound endpoint for a DNS resolver.

SELECT
id,
name,
etag,
location,
provisioningState,
resourceGuid,
subnet,
systemData,
tags,
type
FROM azure.dns_resolver.outbound_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dns_resolver_name = '{{ dns_resolver_name }}' -- required
AND outbound_endpoint_name = '{{ outbound_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Lists outbound endpoints for a DNS resolver.

SELECT
id,
name,
etag,
location,
provisioningState,
resourceGuid,
subnet,
systemData,
tags,
type
FROM azure.dns_resolver.outbound_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dns_resolver_name = '{{ dns_resolver_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- 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 (
tags,
location,
properties,
resource_group_name,
dns_resolver_name,
outbound_endpoint_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ dns_resolver_name }}',
'{{ outbound_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: outbound_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the outbound_endpoints resource.
  - name: dns_resolver_name
    value: "{{ dns_resolver_name }}"
    description: Required parameter for the outbound_endpoints resource.
  - name: outbound_endpoint_name
    value: "{{ outbound_endpoint_name }}"
    description: Required parameter for the outbound_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the outbound_endpoints resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Properties of the outbound endpoint. Required.
    value:
      subnet:
        id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      resourceGuid: "{{ resourceGuid }}"

UPDATE examples

update

Updates an outbound endpoint for a DNS resolver.

UPDATE azure.dns_resolver.outbound_endpoints
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_resolver_name = '{{ dns_resolver_name }}' --required
AND outbound_endpoint_name = '{{ outbound_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates an outbound endpoint for a DNS resolver.

REPLACE azure.dns_resolver.outbound_endpoints
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND dns_resolver_name = '{{ dns_resolver_name }}' --required
AND outbound_endpoint_name = '{{ outbound_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
etag,
location,
properties,
systemData,
tags,
type;

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 resource_group_name = '{{ resource_group_name }}' --required
AND dns_resolver_name = '{{ dns_resolver_name }}' --required
AND outbound_endpoint_name = '{{ outbound_endpoint_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;