private_endpoints
Creates, updates, deletes, gets or lists a private_endpoints resource.
Overview
| Name | private_endpoints |
| Type | Resource |
| Id | azure.network.private_endpoints |
Fields
- vw_private_endpoints
- private_endpoints
| Name | Datatype | Description |
|---|---|---|
id | text | Resource ID. |
name | text | Resource name. |
application_security_groups | text | field from the properties object |
custom_dns_configs | text | field from the properties object |
custom_network_interface_name | text | field from the properties object |
etag | text | A unique read-only string that changes whenever the resource is updated. |
extended_location | text | field from the properties object |
ip_configurations | text | field from the properties object |
location | text | Resource location. |
manual_private_link_service_connections | text | field from the properties object |
network_interfaces | text | field from the properties object |
privateEndpointName | text | field from the properties object |
private_link_service_connections | text | field from the properties object |
provisioning_state | text | field from the properties object |
resourceGroupName | text | field from the properties object |
subnet | text | field from the properties object |
subscriptionId | text | field from the properties object |
tags | text | Resource tags. |
type | text | Resource type. |
| Name | Datatype | Description |
|---|---|---|
id | string | Resource ID. |
name | string | Resource name. |
etag | string | A unique read-only string that changes whenever the resource is updated. |
extendedLocation | object | ExtendedLocation complex type. |
location | string | Resource location. |
properties | object | Properties of the private endpoint. |
tags | object | Resource tags. |
type | string | Resource type. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
get | SELECT | privateEndpointName, resourceGroupName, subscriptionId | Gets the specified private endpoint by resource group. |
list | SELECT | resourceGroupName, subscriptionId | Gets all private endpoints in a resource group. |
list_by_subscription | SELECT | subscriptionId | Gets all private endpoints in a subscription. |
create_or_update | INSERT | privateEndpointName, resourceGroupName, subscriptionId | Creates or updates an private endpoint in the specified resource group. |
delete | DELETE | privateEndpointName, resourceGroupName, subscriptionId | Deletes the specified private endpoint. |
SELECT examples
Gets all private endpoints in a subscription.
- vw_private_endpoints
- private_endpoints
SELECT
id,
name,
application_security_groups,
custom_dns_configs,
custom_network_interface_name,
etag,
extended_location,
ip_configurations,
location,
manual_private_link_service_connections,
network_interfaces,
privateEndpointName,
private_link_service_connections,
provisioning_state,
resourceGroupName,
subnet,
subscriptionId,
tags,
type
FROM azure.network.vw_private_endpoints
WHERE subscriptionId = '{{ subscriptionId }}';
SELECT
id,
name,
etag,
extendedLocation,
location,
properties,
tags,
type
FROM azure.network.private_endpoints
WHERE subscriptionId = '{{ subscriptionId }}';
INSERT example
Use the following StackQL query and manifest file to create a new private_endpoints resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure.network.private_endpoints (
privateEndpointName,
resourceGroupName,
subscriptionId,
extendedLocation,
properties,
id,
location,
tags
)
SELECT
'{{ privateEndpointName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ extendedLocation }}',
'{{ properties }}',
'{{ id }}',
'{{ location }}',
'{{ tags }}'
;
- name: your_resource_model_name
props:
- name: extendedLocation
value:
- name: name
value: string
- name: type
value: []
- name: properties
value:
- name: subnet
value:
- name: properties
value:
- name: addressPrefix
value: string
- name: addressPrefixes
value:
- string
- name: networkSecurityGroup
value:
- name: properties
value:
- name: flushConnection
value: boolean
- name: securityRules
value:
- - name: properties
value:
- name: description
value: string
- name: protocol
value: string
- name: sourcePortRange
value: string
- name: destinationPortRange
value: string
- name: sourceAddressPrefix
value: string
- name: sourceAddressPrefixes
value:
- string
- name: sourceApplicationSecurityGroups
value:
- - name: properties
value:
- name: resourceGuid
value: string
- name: provisioningState
value: []
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: destinationAddressPrefix
value: string
- name: destinationAddressPrefixes
value:
- string
- name: destinationApplicationSecurityGroups
value:
- - name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: sourcePortRanges
value:
- string
- name: destinationPortRanges
value:
- string
- name: access
value: []
- name: priority
value: integer
- name: direction
value: []
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: defaultSecurityRules
value:
- - name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: networkInterfaces
value:
- - name: properties
value:
- name: virtualMachine
value:
- name: id
value: string
- name: privateEndpoint
value:
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: ipConfigurations
value:
- - name: properties
value:
- name: virtualNetworkTaps
value:
- - name: properties
value: []
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: applicationGatewayBackendAddressPools
value:
- - name: properties
value: []
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: loadBalancerBackendAddressPools
value:
- - name: properties
value: []
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: loadBalancerInboundNatRules
value:
- - name: properties
value: []
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: privateIPAddress
value: string
- name: privateIPAddressPrefixLength
value: integer
- name: privateIPAllocationMethod
value: []
- name: privateIPAddressVersion
value: []
- name: primary
value: boolean
- name: publicIPAddress
value:
- name: sku
value: []
- name: properties
value: []
- name: etag
value: string
- name: zones
value:
- string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: applicationSecurityGroups
value:
- - name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: privateLinkConnectionProperties
value:
- name: groupId
value: string
- name: requiredMemberName
value: string
- name: fqdns
value:
- string
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: tapConfigurations
value:
- - name: properties
value:
- name: virtualNetworkTap
value:
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: dnsSettings
value:
- name: dnsServers
value:
- string
- name: appliedDnsServers
value:
- string
- name: internalDnsNameLabel
value: string
- name: internalFqdn
value: string
- name: internalDomainNameSuffix
value: string
- name: macAddress
value: string
- name: primary
value: boolean
- name: vnetEncryptionSupported
value: boolean
- name: enableAcceleratedNetworking
value: boolean
- name: disableTcpStateTracking
value: boolean
- name: enableIPForwarding
value: boolean
- name: hostedWorkloads
value:
- string
- name: resourceGuid
value: string
- name: workloadType
value: string
- name: nicType
value: string
- name: privateLinkService
value:
- name: properties
value:
- name: loadBalancerFrontendIpConfigurations
value:
- - name: properties
value: []
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: zones
value:
- string
- name: id
value: string
- name: ipConfigurations
value:
- - name: properties
value: []
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: destinationIPAddress
value: string
- name: networkInterfaces
value:
- - name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: privateEndpointConnections
value:
- - name: properties
value: []
- name: name
value: string
- name: type
value: string
- name: etag
value: string
- name: id
value: string
- name: visibility
value: string
- name: autoApproval
value: string
- name: fqdns
value:
- string
- name: alias
value: string
- name: enableProxyProtocol
value: boolean
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: migrationPhase
value: string
- name: auxiliaryMode
value: string
- name: auxiliarySku
value: string
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: subnets
value:
- - name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: flowLogs
value:
- - name: properties
value:
- name: targetResourceId
value: string
- name: targetResourceGuid
value: string
- name: storageId
value: string
- name: enabledFilteringCriteria
value: string
- name: enabled
value: boolean
- name: retentionPolicy
value:
- name: days
value: integer
- name: enabled
value: boolean
- name: format
value:
- name: type
value: string
- name: version
value: integer
- name: flowAnalyticsConfiguration
value:
- name: networkWatcherFlowAnalyticsConfiguration
value:
- name: enabled
value: boolean
- name: workspaceId
value: string
- name: workspaceRegion
value: string
- name: workspaceResourceId
value: string
- name: trafficAnalyticsInterval
value: integer
- name: etag
value: string
- name: identity
value:
- name: principalId
value: string
- name: tenantId
value: string
- name: type
value: string
- name: userAssignedIdentities
value: object
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: resourceGuid
value: string
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: routeTable
value:
- name: properties
value:
- name: routes
value:
- - name: properties
value:
- name: addressPrefix
value: string
- name: nextHopType
value: []
- name: nextHopIpAddress
value: string
- name: hasBgpOverride
value: boolean
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: subnets
value:
- - name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: disableBgpRoutePropagation
value: boolean
- name: resourceGuid
value: string
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: serviceEndpoints
value:
- - name: service
value: string
- name: locations
value:
- string
- name: serviceEndpointPolicies
value:
- - name: properties
value:
- name: serviceEndpointPolicyDefinitions
value:
- - name: properties
value:
- name: description
value: string
- name: service
value: string
- name: serviceResources
value:
- string
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: subnets
value:
- - name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: resourceGuid
value: string
- name: serviceAlias
value: string
- name: contextualServiceEndpointPolicies
value:
- string
- name: etag
value: string
- name: kind
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: privateEndpoints
value:
- - name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: ipConfigurations
value:
- - name: properties
value:
- name: privateIPAddress
value: string
- name: name
value: string
- name: etag
value: string
- name: id
value: string
- name: ipConfigurationProfiles
value:
- - name: properties
value: []
- name: name
value: string
- name: type
value: string
- name: etag
value: string
- name: id
value: string
- name: ipAllocations
value:
- - name: id
value: string
- name: resourceNavigationLinks
value:
- - name: properties
value:
- name: linkedResourceType
value: string
- name: link
value: string
- name: name
value: string
- name: id
value: string
- name: etag
value: string
- name: type
value: string
- name: serviceAssociationLinks
value:
- - name: properties
value:
- name: linkedResourceType
value: string
- name: link
value: string
- name: allowDelete
value: boolean
- name: locations
value:
- string
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: delegations
value:
- - name: properties
value:
- name: serviceName
value: string
- name: actions
value:
- string
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: purpose
value: string
- name: privateEndpointNetworkPolicies
value: string
- name: privateLinkServiceNetworkPolicies
value: string
- name: applicationGatewayIPConfigurations
value:
- - name: properties
value: []
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: sharingScope
value: string
- name: defaultOutboundAccess
value: boolean
- name: name
value: string
- name: etag
value: string
- name: type
value: string
- name: id
value: string
- name: networkInterfaces
value:
- - name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: privateLinkServiceConnections
value:
- - name: properties
value:
- name: privateLinkServiceId
value: string
- name: groupIds
value:
- string
- name: requestMessage
value: string
- name: privateLinkServiceConnectionState
value:
- name: status
value: string
- name: description
value: string
- name: actionsRequired
value: string
- name: name
value: string
- name: type
value: string
- name: etag
value: string
- name: id
value: string
- name: manualPrivateLinkServiceConnections
value:
- - name: name
value: string
- name: type
value: string
- name: etag
value: string
- name: id
value: string
- name: customDnsConfigs
value:
- - name: fqdn
value: string
- name: ipAddresses
value:
- string
- name: applicationSecurityGroups
value:
- - name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
- name: ipConfigurations
value:
- - name: properties
value:
- name: groupId
value: string
- name: memberName
value: string
- name: privateIPAddress
value: string
- name: name
value: string
- name: type
value: string
- name: etag
value: string
- name: customNetworkInterfaceName
value: string
- name: etag
value: string
- name: id
value: string
- name: name
value: string
- name: type
value: string
- name: location
value: string
- name: tags
value: object
DELETE example
Deletes the specified private_endpoints resource.
/*+ delete */
DELETE FROM azure.network.private_endpoints
WHERE privateEndpointName = '{{ privateEndpointName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';