private_endpoints

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

Overview

Name	private_endpoints
Type	Resource
Id	azure.network.private_endpoints

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
applicationSecurityGroups	array	Application security groups in which the private endpoint IP configuration is included.
billingSku	string	The billing sku of the private endpoint. Known values are: "PayAsYouGo" and "Fixed". (PayAsYouGo, Fixed)
customDnsConfigs	array	An array of custom dns configurations.
customNetworkInterfaceName	string	The custom name of the network interface attached to the private endpoint.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
ipConfigurations	array	A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints.
ipVersionType	string	Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. Known values are: "IPv4", "IPv6", and "DualStack". (IPv4, IPv6, DualStack)
location	string	Resource location.
manualPrivateLinkServiceConnections	array	A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.
networkInterfaces	array	An array of references to the network interfaces created for this private endpoint.
privateLinkServiceConnections	array	A grouping of information about the connection to the remote resource.
provisioningState	string	The provisioning state of the private endpoint resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
subnet	object	Subnet in a virtual network resource.
tags	object	Resource tags.
type	string	Resource type.

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
applicationSecurityGroups	array	Application security groups in which the private endpoint IP configuration is included.
billingSku	string	The billing sku of the private endpoint. Known values are: "PayAsYouGo" and "Fixed". (PayAsYouGo, Fixed)
customDnsConfigs	array	An array of custom dns configurations.
customNetworkInterfaceName	string	The custom name of the network interface attached to the private endpoint.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
ipConfigurations	array	A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints.
ipVersionType	string	Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. Known values are: "IPv4", "IPv6", and "DualStack". (IPv4, IPv6, DualStack)
location	string	Resource location.
manualPrivateLinkServiceConnections	array	A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.
networkInterfaces	array	An array of references to the network interfaces created for this private endpoint.
privateLinkServiceConnections	array	A grouping of information about the connection to the remote resource.
provisioningState	string	The provisioning state of the private endpoint resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
subnet	object	Subnet in a virtual network resource.
tags	object	Resource tags.
type	string	Resource type.

list_by_subscription

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
applicationSecurityGroups	array	Application security groups in which the private endpoint IP configuration is included.
billingSku	string	The billing sku of the private endpoint. Known values are: "PayAsYouGo" and "Fixed". (PayAsYouGo, Fixed)
customDnsConfigs	array	An array of custom dns configurations.
customNetworkInterfaceName	string	The custom name of the network interface attached to the private endpoint.
etag	string	A unique read-only string that changes whenever the resource is updated.
extendedLocation	object	The extended location of the load balancer.
ipConfigurations	array	A list of IP configurations of the private endpoint. This will be used to map to the First Party Service's endpoints.
ipVersionType	string	Specifies the IP version type for the private IPs of the private endpoint. If not defined, this defaults to IPv4. Known values are: "IPv4", "IPv6", and "DualStack". (IPv4, IPv6, DualStack)
location	string	Resource location.
manualPrivateLinkServiceConnections	array	A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource.
networkInterfaces	array	An array of references to the network interfaces created for this private endpoint.
privateLinkServiceConnections	array	A grouping of information about the connection to the remote resource.
provisioningState	string	The provisioning state of the private endpoint resource. Known values are: "Failed", "Succeeded", "Canceled", "Creating", "Updating", and "Deleting". (Failed, Succeeded, Canceled, Creating, Updating, Deleting)
subnet	object	Subnet in a virtual network resource.
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, private_endpoint_name, subscription_id	$expand	Gets the specified private endpoint by resource group.
list	select	resource_group_name, subscription_id		Gets all private endpoints in a resource group.
list_by_subscription	select	subscription_id		Gets all private endpoints in a subscription.
create_or_update	insert	resource_group_name, private_endpoint_name, subscription_id		Creates or updates an private endpoint in the specified resource group.
create_or_update	replace	resource_group_name, private_endpoint_name, subscription_id		Creates or updates an private endpoint in the specified resource group.
delete	delete	resource_group_name, private_endpoint_name, subscription_id		Deletes the specified private endpoint.

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
private_endpoint_name	string	The name of the private endpoint. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	Expands referenced resources. Default value is None.

SELECT examples

get

Gets the specified private endpoint by resource group.

SELECT
id,
name,
applicationSecurityGroups,
billingSku,
customDnsConfigs,
customNetworkInterfaceName,
etag,
extendedLocation,
ipConfigurations,
ipVersionType,
location,
manualPrivateLinkServiceConnections,
networkInterfaces,
privateLinkServiceConnections,
provisioningState,
subnet,
tags,
type
FROM azure.network.private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND private_endpoint_name = '{{ private_endpoint_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

list

Gets all private endpoints in a resource group.

SELECT
id,
name,
applicationSecurityGroups,
billingSku,
customDnsConfigs,
customNetworkInterfaceName,
etag,
extendedLocation,
ipConfigurations,
ipVersionType,
location,
manualPrivateLinkServiceConnections,
networkInterfaces,
privateLinkServiceConnections,
provisioningState,
subnet,
tags,
type
FROM azure.network.private_endpoints
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets all private endpoints in a subscription.

SELECT
id,
name,
applicationSecurityGroups,
billingSku,
customDnsConfigs,
customNetworkInterfaceName,
etag,
extendedLocation,
ipConfigurations,
ipVersionType,
location,
manualPrivateLinkServiceConnections,
networkInterfaces,
privateLinkServiceConnections,
provisioningState,
subnet,
tags,
type
FROM azure.network.private_endpoints
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates an private endpoint in the specified resource group.

INSERT INTO azure.network.private_endpoints (
id,
location,
tags,
properties,
extendedLocation,
resource_group_name,
private_endpoint_name,
subscription_id
)
SELECT 
'{{ id }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ private_endpoint_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_endpoints
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the private_endpoints resource.
  - name: private_endpoint_name
    value: "{{ private_endpoint_name }}"
    description: Required parameter for the private_endpoints resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the private_endpoints 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 private endpoint.
    value:
      subnet:
        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 }}"
      networkInterfaces:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          location: "{{ location }}"
          tags: "{{ tags }}"
          properties:
            virtualMachine:
              id: "{{ id }}"
            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 }}"
            privateEndpoint:
              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 }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  gatewayLoadBalancer: "{{ gatewayLoadBalancer }}"
                  virtualNetworkTaps: "{{ virtualNetworkTaps }}"
                  applicationGatewayBackendAddressPools: "{{ applicationGatewayBackendAddressPools }}"
                  loadBalancerBackendAddressPools: "{{ loadBalancerBackendAddressPools }}"
                  loadBalancerInboundNatRules: "{{ loadBalancerInboundNatRules }}"
                  privateIPAddress: "{{ privateIPAddress }}"
                  privateIPAddressPrefixLength: {{ privateIPAddressPrefixLength }}
                  privateIPAllocationMethod: "{{ privateIPAllocationMethod }}"
                  privateIPAddressVersion: "{{ privateIPAddressVersion }}"
                  subnet: "{{ subnet }}"
                  primary: {{ primary }}
                  publicIPAddress: "{{ publicIPAddress }}"
                  applicationSecurityGroups: "{{ applicationSecurityGroups }}"
                  provisioningState: "{{ provisioningState }}"
                  privateLinkConnectionProperties: "{{ privateLinkConnectionProperties }}"
                etag: "{{ etag }}"
            tapConfigurations:
              - id: "{{ id }}"
                name: "{{ name }}"
                type: "{{ type }}"
                properties:
                  virtualNetworkTap: "{{ virtualNetworkTap }}"
                  provisioningState: "{{ provisioningState }}"
                etag: "{{ etag }}"
            dnsSettings:
              dnsServers:
                - "{{ dnsServers }}"
              appliedDnsServers:
                - "{{ appliedDnsServers }}"
              internalDnsNameLabel: "{{ internalDnsNameLabel }}"
              internalFqdn: "{{ internalFqdn }}"
              internalDomainNameSuffix: "{{ internalDomainNameSuffix }}"
            macAddress: "{{ macAddress }}"
            primary: {{ primary }}
            vnetEncryptionSupported: {{ vnetEncryptionSupported }}
            defaultOutboundConnectivityEnabled: {{ defaultOutboundConnectivityEnabled }}
            enableAcceleratedNetworking: {{ enableAcceleratedNetworking }}
            disableTcpStateTracking: {{ disableTcpStateTracking }}
            enableIPForwarding: {{ enableIPForwarding }}
            hostedWorkloads:
              - "{{ hostedWorkloads }}"
            dscpConfiguration:
              id: "{{ id }}"
            resourceGuid: "{{ resourceGuid }}"
            provisioningState: "{{ provisioningState }}"
            workloadType: "{{ workloadType }}"
            nicType: "{{ nicType }}"
            privateLinkService:
              id: "{{ id }}"
              name: "{{ name }}"
              type: "{{ type }}"
              location: "{{ location }}"
              tags: "{{ tags }}"
              properties:
                loadBalancerFrontendIpConfigurations: "{{ loadBalancerFrontendIpConfigurations }}"
                ipConfigurations: "{{ ipConfigurations }}"
                destinationIPAddress: "{{ destinationIPAddress }}"
                accessMode: "{{ accessMode }}"
                networkInterfaces: "{{ networkInterfaces }}"
                provisioningState: "{{ provisioningState }}"
                privateEndpointConnections: "{{ privateEndpointConnections }}"
                visibility: "{{ visibility }}"
                autoApproval: "{{ autoApproval }}"
                fqdns: "{{ fqdns }}"
                alias: "{{ alias }}"
                enableProxyProtocol: {{ enableProxyProtocol }}
              extendedLocation:
                name: "{{ name }}"
                type: "{{ type }}"
              etag: "{{ etag }}"
            migrationPhase: "{{ migrationPhase }}"
            auxiliaryMode: "{{ auxiliaryMode }}"
            auxiliarySku: "{{ auxiliarySku }}"
          extendedLocation:
            name: "{{ name }}"
            type: "{{ type }}"
          etag: "{{ etag }}"
      provisioningState: "{{ provisioningState }}"
      ipVersionType: "{{ ipVersionType }}"
      privateLinkServiceConnections:
        - id: "{{ id }}"
          properties:
            provisioningState: "{{ provisioningState }}"
            privateLinkServiceId: "{{ privateLinkServiceId }}"
            groupIds:
              - "{{ groupIds }}"
            requestMessage: "{{ requestMessage }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
          name: "{{ name }}"
          type: "{{ type }}"
          etag: "{{ etag }}"
      manualPrivateLinkServiceConnections:
        - id: "{{ id }}"
          properties:
            provisioningState: "{{ provisioningState }}"
            privateLinkServiceId: "{{ privateLinkServiceId }}"
            groupIds:
              - "{{ groupIds }}"
            requestMessage: "{{ requestMessage }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
          name: "{{ name }}"
          type: "{{ type }}"
          etag: "{{ etag }}"
      customDnsConfigs:
        - fqdn: "{{ fqdn }}"
          ipAddresses: "{{ ipAddresses }}"
      applicationSecurityGroups:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          location: "{{ location }}"
          tags: "{{ tags }}"
          properties:
            resourceGuid: "{{ resourceGuid }}"
            provisioningState: "{{ provisioningState }}"
          etag: "{{ etag }}"
      ipConfigurations:
        - properties:
            groupId: "{{ groupId }}"
            memberName: "{{ memberName }}"
            privateIPAddress: "{{ privateIPAddress }}"
          name: "{{ name }}"
          type: "{{ type }}"
          etag: "{{ etag }}"
      customNetworkInterfaceName: "{{ customNetworkInterfaceName }}"
      billingSku: "{{ billingSku }}"
  - name: extendedLocation
    description: |
      The extended location of the load balancer.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

REPLACE examples

create_or_update

Creates or updates an private endpoint in the specified resource group.

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

DELETE examples

delete

Deletes the specified private endpoint.

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