Microsoft.Network privateEndpoints

Definição de recursos do bíceps

O tipo de recurso privateEndpoints pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Network/privateEndpoints, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.Network/privateEndpoints@2025-03-01' = {
  scope: resourceSymbolicName or scope
  extendedLocation: {
    name: 'string'
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    applicationSecurityGroups: [
      {
        id: 'string'
        location: 'string'
        properties: {}
        tags: {
          {customized property}: 'string'
        }
      }
    ]
    customDnsConfigs: [
      {
        fqdn: 'string'
        ipAddresses: [
          'string'
        ]
      }
    ]
    customNetworkInterfaceName: 'string'
    ipConfigurations: [
      {
        name: 'string'
        properties: {
          groupId: 'string'
          memberName: 'string'
          privateIPAddress: 'string'
        }
      }
    ]
    ipVersionType: 'string'
    manualPrivateLinkServiceConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          groupIds: [
            'string'
          ]
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
          privateLinkServiceId: 'string'
          requestMessage: 'string'
        }
      }
    ]
    privateLinkServiceConnections: [
      {
        id: 'string'
        name: 'string'
        properties: {
          groupIds: [
            'string'
          ]
          privateLinkServiceConnectionState: {
            actionsRequired: 'string'
            description: 'string'
            status: 'string'
          }
          privateLinkServiceId: 'string'
          requestMessage: 'string'
        }
      }
    ]
    subnet: {
      id: 'string'
      name: 'string'
      properties: {
        addressPrefix: 'string'
        addressPrefixes: [
          'string'
        ]
        applicationGatewayIPConfigurations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              subnet: {
                id: 'string'
              }
            }
          }
        ]
        defaultOutboundAccess: bool
        delegations: [
          {
            id: 'string'
            name: 'string'
            properties: {
              serviceName: 'string'
            }
            type: 'string'
          }
        ]
        ipAllocations: [
          {
            id: 'string'
          }
        ]
        ipamPoolPrefixAllocations: [
          {
            numberOfIpAddresses: 'string'
            pool: {
              id: 'string'
            }
          }
        ]
        natGateway: {
          id: 'string'
        }
        networkSecurityGroup: {
          id: 'string'
          location: 'string'
          properties: {
            flushConnection: bool
            securityRules: [
              {
                id: 'string'
                name: 'string'
                properties: {
                  access: 'string'
                  description: 'string'
                  destinationAddressPrefix: 'string'
                  destinationAddressPrefixes: [
                    'string'
                  ]
                  destinationApplicationSecurityGroups: [
                    {
                      id: 'string'
                      location: 'string'
                      properties: {}
                      tags: {
                        {customized property}: 'string'
                      }
                    }
                  ]
                  destinationPortRange: 'string'
                  destinationPortRanges: [
                    'string'
                  ]
                  direction: 'string'
                  priority: int
                  protocol: 'string'
                  sourceAddressPrefix: 'string'
                  sourceAddressPrefixes: [
                    'string'
                  ]
                  sourceApplicationSecurityGroups: [
                    {
                      id: 'string'
                      location: 'string'
                      properties: {}
                      tags: {
                        {customized property}: 'string'
                      }
                    }
                  ]
                  sourcePortRange: 'string'
                  sourcePortRanges: [
                    'string'
                  ]
                }
                type: 'string'
              }
            ]
          }
          tags: {
            {customized property}: 'string'
          }
        }
        privateEndpointNetworkPolicies: 'string'
        privateLinkServiceNetworkPolicies: 'string'
        routeTable: {
          id: 'string'
          location: 'string'
          properties: {
            disableBgpRoutePropagation: bool
            routes: [
              {
                id: 'string'
                name: 'string'
                properties: {
                  addressPrefix: 'string'
                  nextHopIpAddress: 'string'
                  nextHopType: 'string'
                }
                type: 'string'
              }
            ]
          }
          tags: {
            {customized property}: 'string'
          }
        }
        serviceEndpointPolicies: [
          {
            id: 'string'
            location: 'string'
            properties: {
              contextualServiceEndpointPolicies: [
                'string'
              ]
              serviceAlias: 'string'
              serviceEndpointPolicyDefinitions: [
                {
                  id: 'string'
                  name: 'string'
                  properties: {
                    description: 'string'
                    service: 'string'
                    serviceResources: [
                      'string'
                    ]
                  }
                  type: 'string'
                }
              ]
            }
            tags: {
              {customized property}: 'string'
            }
          }
        ]
        serviceEndpoints: [
          {
            locations: [
              'string'
            ]
            networkIdentifier: {
              id: 'string'
            }
            service: 'string'
          }
        ]
        sharingScope: 'string'
      }
      type: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

Microsoft.Network/privateEndpoints

ApplicationGatewayIPConfiguration

ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationSecurityGroup

ApplicationSecurityGroupPropertiesFormat

CustomDnsConfigPropertiesFormat

Delegação

Localização Estendida

IpamPoolPrefixAllocation

IpamPoolPrefixAllocationPool

NetworkSecurityGroup

NetworkSecurityGroupPropertiesFormat

PrivateEndpointIPConfiguration

PrivateEndpointIPConfigurationProperties

PrivateEndpointProperties

PrivateLinkServiceConnection

PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionState

Tags de Recursos

Tags de Recursos

Tags de Recursos

Tags de Recursos

Tags de Recursos

Percurso

RoutePropertiesFormat

Tabela de Rotas

RouteTablePropertiesFormat

Regra de Segurança

SecurityRulePropertiesFormat

ServiceDelegationPropertiesFormat

ServiceEndpointPolicy

ServiceEndpointPolicyDefinition

ServiceEndpointPolicyDefinitionPropertiesFormat

ServiceEndpointPolicyPropertiesFormat

ServiceEndpointPropertiesFormat

Sub-rede

SubnetPropertiesFormat

Subrecurso

Exemplos de uso

Módulos verificados do Azure

Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.

Exemplos de início rápido do Azure

Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.

Definição de recurso de modelo ARM

O tipo de recurso privateEndpoints pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Network/privateEndpoints, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.Network/privateEndpoints",
  "apiVersion": "2025-03-01",
  "name": "string",
  "extendedLocation": {
    "name": "string",
    "type": "string"
  },
  "location": "string",
  "properties": {
    "applicationSecurityGroups": [
      {
        "id": "string",
        "location": "string",
        "properties": {
        },
        "tags": {
          "{customized property}": "string"
        }
      }
    ],
    "customDnsConfigs": [
      {
        "fqdn": "string",
        "ipAddresses": [ "string" ]
      }
    ],
    "customNetworkInterfaceName": "string",
    "ipConfigurations": [
      {
        "name": "string",
        "properties": {
          "groupId": "string",
          "memberName": "string",
          "privateIPAddress": "string"
        }
      }
    ],
    "ipVersionType": "string",
    "manualPrivateLinkServiceConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "groupIds": [ "string" ],
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          },
          "privateLinkServiceId": "string",
          "requestMessage": "string"
        }
      }
    ],
    "privateLinkServiceConnections": [
      {
        "id": "string",
        "name": "string",
        "properties": {
          "groupIds": [ "string" ],
          "privateLinkServiceConnectionState": {
            "actionsRequired": "string",
            "description": "string",
            "status": "string"
          },
          "privateLinkServiceId": "string",
          "requestMessage": "string"
        }
      }
    ],
    "subnet": {
      "id": "string",
      "name": "string",
      "properties": {
        "addressPrefix": "string",
        "addressPrefixes": [ "string" ],
        "applicationGatewayIPConfigurations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "subnet": {
                "id": "string"
              }
            }
          }
        ],
        "defaultOutboundAccess": "bool",
        "delegations": [
          {
            "id": "string",
            "name": "string",
            "properties": {
              "serviceName": "string"
            },
            "type": "string"
          }
        ],
        "ipAllocations": [
          {
            "id": "string"
          }
        ],
        "ipamPoolPrefixAllocations": [
          {
            "numberOfIpAddresses": "string",
            "pool": {
              "id": "string"
            }
          }
        ],
        "natGateway": {
          "id": "string"
        },
        "networkSecurityGroup": {
          "id": "string",
          "location": "string",
          "properties": {
            "flushConnection": "bool",
            "securityRules": [
              {
                "id": "string",
                "name": "string",
                "properties": {
                  "access": "string",
                  "description": "string",
                  "destinationAddressPrefix": "string",
                  "destinationAddressPrefixes": [ "string" ],
                  "destinationApplicationSecurityGroups": [
                    {
                      "id": "string",
                      "location": "string",
                      "properties": {
                      },
                      "tags": {
                        "{customized property}": "string"
                      }
                    }
                  ],
                  "destinationPortRange": "string",
                  "destinationPortRanges": [ "string" ],
                  "direction": "string",
                  "priority": "int",
                  "protocol": "string",
                  "sourceAddressPrefix": "string",
                  "sourceAddressPrefixes": [ "string" ],
                  "sourceApplicationSecurityGroups": [
                    {
                      "id": "string",
                      "location": "string",
                      "properties": {
                      },
                      "tags": {
                        "{customized property}": "string"
                      }
                    }
                  ],
                  "sourcePortRange": "string",
                  "sourcePortRanges": [ "string" ]
                },
                "type": "string"
              }
            ]
          },
          "tags": {
            "{customized property}": "string"
          }
        },
        "privateEndpointNetworkPolicies": "string",
        "privateLinkServiceNetworkPolicies": "string",
        "routeTable": {
          "id": "string",
          "location": "string",
          "properties": {
            "disableBgpRoutePropagation": "bool",
            "routes": [
              {
                "id": "string",
                "name": "string",
                "properties": {
                  "addressPrefix": "string",
                  "nextHopIpAddress": "string",
                  "nextHopType": "string"
                },
                "type": "string"
              }
            ]
          },
          "tags": {
            "{customized property}": "string"
          }
        },
        "serviceEndpointPolicies": [
          {
            "id": "string",
            "location": "string",
            "properties": {
              "contextualServiceEndpointPolicies": [ "string" ],
              "serviceAlias": "string",
              "serviceEndpointPolicyDefinitions": [
                {
                  "id": "string",
                  "name": "string",
                  "properties": {
                    "description": "string",
                    "service": "string",
                    "serviceResources": [ "string" ]
                  },
                  "type": "string"
                }
              ]
            },
            "tags": {
              "{customized property}": "string"
            }
          }
        ],
        "serviceEndpoints": [
          {
            "locations": [ "string" ],
            "networkIdentifier": {
              "id": "string"
            },
            "service": "string"
          }
        ],
        "sharingScope": "string"
      },
      "type": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

Microsoft.Network/privateEndpoints

ApplicationGatewayIPConfiguration

ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationSecurityGroup

ApplicationSecurityGroupPropertiesFormat

CustomDnsConfigPropertiesFormat

Delegação

Localização Estendida

IpamPoolPrefixAllocation

IpamPoolPrefixAllocationPool

NetworkSecurityGroup

NetworkSecurityGroupPropertiesFormat

PrivateEndpointIPConfiguration

PrivateEndpointIPConfigurationProperties

PrivateEndpointProperties

PrivateLinkServiceConnection

PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionState

Tags de Recursos

Tags de Recursos

Tags de Recursos

Tags de Recursos

Tags de Recursos

Percurso

RoutePropertiesFormat

Tabela de Rotas

RouteTablePropertiesFormat

Regra de Segurança

SecurityRulePropertiesFormat

ServiceDelegationPropertiesFormat

ServiceEndpointPolicy

ServiceEndpointPolicyDefinition

ServiceEndpointPolicyDefinitionPropertiesFormat

ServiceEndpointPolicyPropertiesFormat

ServiceEndpointPropertiesFormat

Sub-rede

SubnetPropertiesFormat

Subrecurso

Exemplos de uso

Modelos de início rápido do Azure

Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.

Modelo	Descrição
Cluster AKS com um gateway NAT e um gateway de aplicativo	Este exemplo mostra como implantar um cluster AKS com o NAT Gateway para conexões de saída e um Application Gateway para conexões de entrada.
cluster AKS com o Application Gateway Ingress Controller	Este exemplo mostra como implantar um cluster AKS com o Application Gateway, o Application Gateway Ingress Controller, o Azure Container Registry, o Log Analytics e o Key Vault
Ambiente do Serviço de Aplicativo com back-end SQL do Azure	Este modelo cria um Ambiente do Serviço de Aplicativo com um back-end SQL do Azure junto com pontos de extremidade privados junto com recursos associados normalmente usados em um ambiente privado/isolado.
Application Gateway com gerenciamento interno de API e de aplicativos Web	Gateway de Aplicativo roteando tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno) que atende uma API Web hospedada em um Aplicativo Web do Azure.
Azure AI Foundry Network Restrito	Este conjunto de modelos demonstra como configurar o Azure AI Foundry com link privado e saída desabilitados, usando chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
Rede Restrita do Azure AI Studio	Este conjunto de modelos demonstra como configurar o Azure AI Studio com link privado e saída desabilitados, usando chaves gerenciadas pela Microsoft para criptografia e configuração de identidade gerenciada pela Microsoft para o recurso de IA.
pool de lotes do Azure sem endereços IP públicos	Este modelo cria o pool de comunicação de nó simplificado do Lote do Azure sem endereços IP públicos.
Azure Cloud Shell - VNet	Este modelo implanta recursos do Azure Cloud Shell em uma rede virtual do Azure.
serviço de Pesquisa Cognitiva do Azure com de ponto de extremidade privado	Este modelo cria um serviço de Pesquisa Cognitiva do Azure com um ponto de extremidade privado.
Templat Templat tudo-em-um do Azure Databricks VNetInjection-Pvtendpt	Este modelo permite criar um grupo de segurança de rede, uma rede virtual e um espaço de trabalho do Azure Databricks com a rede virtual e o Ponto de Extremidade Privado.
Gêmeos Digitais do Azure com função e serviço de link privado	Este modelo cria um serviço de Gêmeos Digitais do Azure configurado com uma Função do Azure conectada à Rede Virtual que pode se comunicar por meio de um Ponto de Extremidade de Link Privado para Gêmeos Digitais. Ele também cria uma Zona DNS Privada para permitir a resolução perfeita do nome de host do Ponto de Extremidade Digital da Rede Virtual para o endereço IP da sub-rede interna do Ponto Final Privado. O nome do host é armazenado como uma configuração para a Função do Azure com o nome 'ADT_ENDPOINT'.
configuração segura completa do Azure Machine Learning	Este conjunto de modelos Bicep demonstra como configurar o Azure Machine Learning de ponta a ponta em uma configuração segura. Esta implementação de referência inclui o espaço de trabalho, um cluster de computação, instância de computação e cluster AKS privado anexado.
Configuração segura de ponta a ponta do Aprendizado de Máquina do Azure	Este conjunto de modelos Bicep demonstra como configurar o Azure Machine Learning de ponta a ponta em uma configuração segura. Esta implementação de referência inclui o espaço de trabalho, um cluster de computação, instância de computação e cluster AKS privado anexado.
modelo AzureDatabricks para de firewall de armazenamento padrão	Este modelo permite criar um grupo de segurança de rede, uma rede virtual, um ponto de extremidade privado e um espaço de trabalho do Azure Databricks habilitado para firewall de armazenamento padrão com a rede virtual e o conector de acesso atribuído pelo sistema.
modelo AzureDatabricks com firewall de armazenamento padrão	Este modelo permite que você crie um espaço de trabalho do Azure Databricks habilitado para Firewall de Armazenamento Padrão com Privateendpoint, todas as três formas de CMK e User-Assigned Access Connector.
Conectar-se a um namespace de Hubs de Eventos por meio de de ponto de extremidade privado	Este exemplo mostra como usar configurar uma rede virtual e uma zona DNS privada para acessar um namespace de Hubs de Eventos por meio de um ponto de extremidade privado.
Conecte-se a um Cofre de Chaves por meio de de ponto final privado	Este exemplo mostra como usar configurar uma rede virtual e uma zona DNS privada para acessar o Cofre da Chave por meio do ponto de extremidade privado.
Conectar-se a um namespace do Service Bus por meio de de ponto de extremidade privado	Este exemplo mostra como usar configurar uma rede virtual e uma zona DNS privada para acessar um namespace do Service Bus por meio do ponto de extremidade privado.
Conectar-se a uma conta de armazenamento a partir de uma VM via de ponto de extremidade privado	Este exemplo mostra como usar conectar uma rede virtual para acessar uma conta de armazenamento de blob por meio de um ponto de extremidade privado.
conectar-se a um compartilhamento de arquivos do Azure por meio de um ponto de extremidade privado	Este exemplo mostra como usar configurar uma rede virtual e uma zona DNS privada para acessar um Compartilhamento de Arquivos do Azure por meio de um ponto de extremidade privado.
Criar um cluster AKS privado	Este exemplo mostra como criar um cluster AKS privado em uma rede virtual junto com uma máquina virtual jumpbox.
Criar um cluster AKS privado com uma zona DNS pública	Este exemplo mostra como implantar um cluster AKS privado com uma zona DNS pública.
Criar um aplicativo Web, PE e Application Gateway v2	Este modelo cria um Aplicativo Web do Azure com ponto de extremidade Privado na Sub-rede de Rede Virtual do Azure , um Gateway de Aplicativo v2. O Application Gateway é implantado em uma vNet (sub-rede). O Web App restringe o acesso ao tráfego da sub-rede usando ponto de extremidade privado
Crie AKS com Prometheus e Grafana com link privae	Isso criará um Azure grafana, AKS e instalará o Prometheus, um kit de ferramentas de monitoramento e alerta de código aberto, em um cluster do Serviço Kubernetes do Azure (AKS). Em seguida, você usa o ponto de extremidade privado gerenciado do Azure Managed Grafana para se conectar a esse servidor Prometheus e exibir os dados do Prometheus em um painel do Grafana
Criar um serviço de Gerenciamento de API com um ponto de extremidade privado	Este modelo criará um serviço de Gerenciamento de API, uma rede virtual e um ponto de extremidade privado expondo o serviço de Gerenciamento de API à rede virtual.
Criar uma conta do Azure Cosmos DB com um ponto de extremidade privado	Este modelo criará uma conta Cosmos, uma rede virtual e um ponto de extremidade privado expondo a conta Cosmos à rede virtual.
Criar um espaço de trabalho de serviço do Azure Machine Learning (legado)	Este modelo de implantação especifica um espaço de trabalho do Azure Machine Learning e seus recursos associados, incluindo o Azure Key Vault, o Armazenamento do Azure, o Azure Application Insights e o Azure Container Registry. Essa configuração descreve o conjunto de recursos necessários para começar a usar o Aprendizado de Máquina do Azure em uma configuração isolada de rede.
Criar um espaço de trabalho de serviço do Azure Machine Learning (vnet)	Este modelo de implantação especifica um espaço de trabalho do Azure Machine Learning e seus recursos associados, incluindo o Azure Key Vault, o Armazenamento do Azure, o Azure Application Insights e o Azure Container Registry. Essa configuração descreve o conjunto de recursos necessários para começar a usar o Aprendizado de Máquina do Azure em uma configuração isolada de rede.
Criar AVD com FSLogix e AD DS Join	Este modelo permite que você crie recursos da Área de Trabalho Virtual do Azure, como pool de hosts, grupo de aplicativos, espaço de trabalho, conta de armazenamento FSLogix, compartilhamento de arquivos, cofre de serviço de recuperação para backup de compartilhamento de arquivos, um host de sessão de teste, suas extensões com o Microsoft Entra ID ingressar no domínio pr Ative Directory.
Criar replicação de VM do Azure e de recuperação de desastres	Este modelo permite criar a recuperação de desastres de replicação de site da máquina virtual do Azure.
Criar aplicativo de função e de armazenamento protegido por endpoint privado	Este modelo permite implantar um Aplicativo de Função do Azure que se comunica com o Armazenamento do Azure em pontos de extremidade privados.
Cria um recurso de ponto de extremidade privado entre locatários	Este modelo permite que você crie o recurso Priavate Endpoint dentro do mesmo ambiente ou entre locatários e adicione a configuração da zona dns.
Implantar um espaço de trabalho do Azure Databricks com PE,CMK todos os formulários	Este modelo permite criar um espaço de trabalho do Azure Databricks com PrivateEndpoint e serviços gerenciados e CMK com criptografia DBFS.
implantar o MySQL Flexible Server com o Private Endpoint	Este modelo fornece uma maneira de implantar um Banco de Dados do Azure para o Servidor Flexível MySQL com Ponto de Extremidade Privado.
hub FinOps	Este modelo cria uma nova instância de hub FinOps, incluindo Data Explorer, armazenamento Data Lake e Data Factory.
Function App protegido pelo Azure Frontdoor	Este modelo permite implantar uma função azure premium protegida e publicada pelo Azure Frontdoor premium. A conexão entre o Azure Frontdoor e o Azure Functions é protegida pelo Azure Private Link.
min.io Gateway do Azure	Implantação totalmente privada min.io Gateway do Azure para fornecer uma API de armazenamento compatível com o S3 apoiada por armazenamento de blob
Agente Protegido em Rede com de Identidade Gerenciada pelo Usuário	Este conjunto de modelos demonstra como configurar o Azure AI Agent Service com isolamento de rede virtual usando a autenticação de Identidade Gerenciada pelo Usuário para a conexão AI Service/AOAI e links de rede privada para conectar o agente aos seus dados seguros.
Exemplo de Ponto Final Privado	Este modelo mostra como criar um ponto de extremidade privado apontando para o SQL Server do Azure
Private Function App e de armazenamento privado protegido por endpoints	Este modelo provisiona um aplicativo de função em um plano Premium que tem pontos de extremidade privados e se comunica com o Armazenamento do Azure por meio de pontos de extremidade privados.
Exemplo de serviço Private Link	Este modelo mostra como criar um serviço de link privado
Aplicativo Web seguro de N camadas	Este modelo permite que você crie uma solução segura de ponta a ponta com dois aplicativos Web com slots de preparação, front-end e back-end, o front-end consumirá com segurança a parte traseira através da injeção de VNet e Private Endpoint
Usar o Firewall do Azure como um proxy DNS em um de topologia do Hub & Spoke	Este exemplo mostra como implantar uma topologia hub-spoke no Azure usando o Firewall do Azure. A rede virtual do hub atua como um ponto central de conectividade para muitas redes virtuais faladas que estão conectadas à rede virtual do hub por meio do emparelhamento de rede virtual.
Web App com Private Endpoint	Este modelo permite-lhe criar uma Aplicação Web e expô-la através do Ponto de Extremidade Privado
Web App com injeção de rede virtual e de ponto final privado	Este modelo permite que você crie uma solução segura de ponta a ponta com dois aplicativos Web, front-end e back-end, o front-end consumirá com segurança a parte traseira através da injeção de VNet e Private Endpoint
WebApp consumindo um de Ponto de Extremidade Privado do SQL do Azure	Este modelo mostra como criar um aplicativo Web que consome um ponto de extremidade privado apontando para o SQL Server do Azure

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso privateEndpoints pode ser implantado com operações que visam:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato do recurso

Para criar um recurso Microsoft.Network/privateEndpoints, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/privateEndpoints@2025-03-01"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    extendedLocation = {
      name = "string"
      type = "string"
    }
    properties = {
      applicationSecurityGroups = [
        {
          id = "string"
          location = "string"
          properties = {
          }
          tags = {
            {customized property} = "string"
          }
        }
      ]
      customDnsConfigs = [
        {
          fqdn = "string"
          ipAddresses = [
            "string"
          ]
        }
      ]
      customNetworkInterfaceName = "string"
      ipConfigurations = [
        {
          name = "string"
          properties = {
            groupId = "string"
            memberName = "string"
            privateIPAddress = "string"
          }
        }
      ]
      ipVersionType = "string"
      manualPrivateLinkServiceConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            groupIds = [
              "string"
            ]
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
            privateLinkServiceId = "string"
            requestMessage = "string"
          }
        }
      ]
      privateLinkServiceConnections = [
        {
          id = "string"
          name = "string"
          properties = {
            groupIds = [
              "string"
            ]
            privateLinkServiceConnectionState = {
              actionsRequired = "string"
              description = "string"
              status = "string"
            }
            privateLinkServiceId = "string"
            requestMessage = "string"
          }
        }
      ]
      subnet = {
        id = "string"
        name = "string"
        properties = {
          addressPrefix = "string"
          addressPrefixes = [
            "string"
          ]
          applicationGatewayIPConfigurations = [
            {
              id = "string"
              name = "string"
              properties = {
                subnet = {
                  id = "string"
                }
              }
            }
          ]
          defaultOutboundAccess = bool
          delegations = [
            {
              id = "string"
              name = "string"
              properties = {
                serviceName = "string"
              }
              type = "string"
            }
          ]
          ipAllocations = [
            {
              id = "string"
            }
          ]
          ipamPoolPrefixAllocations = [
            {
              numberOfIpAddresses = "string"
              pool = {
                id = "string"
              }
            }
          ]
          natGateway = {
            id = "string"
          }
          networkSecurityGroup = {
            id = "string"
            location = "string"
            properties = {
              flushConnection = bool
              securityRules = [
                {
                  id = "string"
                  name = "string"
                  properties = {
                    access = "string"
                    description = "string"
                    destinationAddressPrefix = "string"
                    destinationAddressPrefixes = [
                      "string"
                    ]
                    destinationApplicationSecurityGroups = [
                      {
                        id = "string"
                        location = "string"
                        properties = {
                        }
                        tags = {
                          {customized property} = "string"
                        }
                      }
                    ]
                    destinationPortRange = "string"
                    destinationPortRanges = [
                      "string"
                    ]
                    direction = "string"
                    priority = int
                    protocol = "string"
                    sourceAddressPrefix = "string"
                    sourceAddressPrefixes = [
                      "string"
                    ]
                    sourceApplicationSecurityGroups = [
                      {
                        id = "string"
                        location = "string"
                        properties = {
                        }
                        tags = {
                          {customized property} = "string"
                        }
                      }
                    ]
                    sourcePortRange = "string"
                    sourcePortRanges = [
                      "string"
                    ]
                  }
                  type = "string"
                }
              ]
            }
            tags = {
              {customized property} = "string"
            }
          }
          privateEndpointNetworkPolicies = "string"
          privateLinkServiceNetworkPolicies = "string"
          routeTable = {
            id = "string"
            location = "string"
            properties = {
              disableBgpRoutePropagation = bool
              routes = [
                {
                  id = "string"
                  name = "string"
                  properties = {
                    addressPrefix = "string"
                    nextHopIpAddress = "string"
                    nextHopType = "string"
                  }
                  type = "string"
                }
              ]
            }
            tags = {
              {customized property} = "string"
            }
          }
          serviceEndpointPolicies = [
            {
              id = "string"
              location = "string"
              properties = {
                contextualServiceEndpointPolicies = [
                  "string"
                ]
                serviceAlias = "string"
                serviceEndpointPolicyDefinitions = [
                  {
                    id = "string"
                    name = "string"
                    properties = {
                      description = "string"
                      service = "string"
                      serviceResources = [
                        "string"
                      ]
                    }
                    type = "string"
                  }
                ]
              }
              tags = {
                {customized property} = "string"
              }
            }
          ]
          serviceEndpoints = [
            {
              locations = [
                "string"
              ]
              networkIdentifier = {
                id = "string"
              }
              service = "string"
            }
          ]
          sharingScope = "string"
        }
        type = "string"
      }
    }
  }
}

Valores de propriedade

Microsoft.Network/privateEndpoints

ApplicationGatewayIPConfiguration

ApplicationGatewayIPConfigurationPropertiesFormat

ApplicationSecurityGroup

ApplicationSecurityGroupPropertiesFormat

CustomDnsConfigPropertiesFormat

Delegação

Localização Estendida

IpamPoolPrefixAllocation

IpamPoolPrefixAllocationPool

NetworkSecurityGroup

NetworkSecurityGroupPropertiesFormat

PrivateEndpointIPConfiguration

PrivateEndpointIPConfigurationProperties

PrivateEndpointProperties

PrivateLinkServiceConnection

PrivateLinkServiceConnectionProperties

PrivateLinkServiceConnectionState

Tags de Recursos

Tags de Recursos

Tags de Recursos

Tags de Recursos

Tags de Recursos

Percurso

RoutePropertiesFormat

Tabela de Rotas

RouteTablePropertiesFormat

Regra de Segurança

SecurityRulePropertiesFormat

ServiceDelegationPropertiesFormat

ServiceEndpointPolicy

ServiceEndpointPolicyDefinition

ServiceEndpointPolicyDefinitionPropertiesFormat

ServiceEndpointPolicyPropertiesFormat

ServiceEndpointPropertiesFormat

Sub-rede

SubnetPropertiesFormat

Subrecurso

Exemplos de uso

Amostras Terraform

Um exemplo básico de implantação do Private Endpoint.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "virtualNetwork" {
  type      = "Microsoft.Network/virtualNetworks@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      addressSpace = {
        addressPrefixes = [
          "10.5.0.0/16",
        ]
      }
      dhcpOptions = {
        dnsServers = [
        ]
      }
      subnets = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
  lifecycle {
    ignore_changes = [body.properties.subnets]
  }
}

resource "azapi_resource" "publicIPAddress" {
  type      = "Microsoft.Network/publicIPAddresses@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      ddosSettings = {
        protectionMode = "VirtualNetworkInherited"
      }
      idleTimeoutInMinutes     = 4
      publicIPAddressVersion   = "IPv4"
      publicIPAllocationMethod = "Static"
    }
    sku = {
      name = "Standard"
      tier = "Regional"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "loadBalancer" {
  type      = "Microsoft.Network/loadBalancers@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      frontendIPConfigurations = [
        {
          name = var.resource_name
          properties = {
            publicIPAddress = {
              id = azapi_resource.publicIPAddress.id
            }
          }
        },
      ]
    }
    sku = {
      name = "Standard"
      tier = "Regional"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "subnet" {
  type      = "Microsoft.Network/virtualNetworks/subnets@2022-07-01"
  parent_id = azapi_resource.virtualNetwork.id
  name      = var.resource_name
  body = {
    properties = {
      addressPrefix = "10.5.4.0/24"
      delegations = [
      ]
      privateEndpointNetworkPolicies    = "Enabled"
      privateLinkServiceNetworkPolicies = "Disabled"
      serviceEndpointPolicies = [
      ]
      serviceEndpoints = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "privateLinkService" {
  type      = "Microsoft.Network/privateLinkServices@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      autoApproval = {
        subscriptions = [
        ]
      }
      enableProxyProtocol = false
      fqdns = [
      ]
      ipConfigurations = [
        {
          name = "primaryIpConfiguration-230630033653892379"
          properties = {
            primary                   = true
            privateIPAddress          = ""
            privateIPAddressVersion   = "IPv4"
            privateIPAllocationMethod = "Dynamic"
            subnet = {
              id = azapi_resource.subnet.id
            }
          }
        },
      ]
      loadBalancerFrontendIpConfigurations = [
        {
          id = azapi_resource.loadBalancer.output.properties.frontendIPConfigurations[0].id
        },
      ]
      visibility = {
        subscriptions = [
        ]
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "privateEndpoint" {
  type      = "Microsoft.Network/privateEndpoints@2022-07-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      privateLinkServiceConnections = [
        {
          name = azapi_resource.privateLinkService.name
          properties = {
            privateLinkServiceId = azapi_resource.privateLinkService.id
          }
        }
      ]
      subnet = {
        id = azapi_resource.subnet.id
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Módulos verificados do Azure

Os seguintes de Módulos Verificados do Azure podem ser usados para implantar esse tipo de recurso.