Microsoft.Network/trafficmanagerprofiles 2017-05-01 - Bicep, ARM template & Terraform AzAPI reference

Definição de recurso do Bicep

O tipo de recurso trafficmanagerprofiles pode ser implementado com operações que visam:

Grupos de recursos – veja os comandos de implementação do grupo de recursos

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

Formato do recurso

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

resource symbolicname 'Microsoft.Network/trafficmanagerprofiles@2017-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    dnsConfig: {
      relativeName: 'string'
      ttl: int
    }
    endpoints: [
      {
        properties: {
          endpointLocation: 'string'
          endpointMonitorStatus: 'string'
          endpointStatus: 'string'
          geoMapping: [
            'string'
          ]
          minChildEndpoints: int
          priority: int
          target: 'string'
          targetResourceId: 'string'
          weight: int
        }
      }
    ]
    monitorConfig: {
      intervalInSeconds: int
      path: 'string'
      port: int
      profileMonitorStatus: 'string'
      protocol: 'string'
      timeoutInSeconds: int
      toleratedNumberOfFailures: int
    }
    profileStatus: 'string'
    trafficRoutingMethod: 'string'
  }
}

Valores de propriedade

trafficmanagerprofiles

Nome	Descrição	Valor
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 1-63 Carateres válidos: Alfanuméricos, hífenes e períodos. Comece e termine com alfanumérico. O nome do recurso tem de ser exclusivo em todo o Azure.
localização	A Região do Azure onde reside o recurso	string
etiquetas	Etiquetas de recursos.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
propriedades	As propriedades do perfil do Gestor de Tráfego.	ProfileProperties

ProfileProperties

Nome	Descrição	Valor
dnsConfig	As definições de DNS do perfil do Gestor de Tráfego.	DnsConfig
pontos finais	A lista de pontos finais no perfil do Gestor de Tráfego.	Ponto final[]
monitorConfig	As definições de monitorização do ponto final do perfil do Gestor de Tráfego.	MonitorConfig
profileStatus	O estado do perfil do Gestor de Tráfego.	"Desativado" "Ativado"
trafficRoutingMethod	O método de encaminhamento de tráfego do perfil do Gestor de Tráfego.	'Geográfico' "Desempenho" "Prioridade" "Ponderado"

DnsConfig

Nome	Descrição	Valor
relativeName	O nome DNS relativo fornecido por este perfil do Gestor de Tráfego. Este valor é combinado com o nome de domínio DNS utilizado pelo Gestor de Tráfego do Azure para formar o nome de domínio completamente qualificado (FQDN) do perfil.	string
ttl	O TTL (Time-To-Live) do DNS em segundos. Isto informa os clientes DNS e resoluções DNS locais durante quanto tempo deve colocar em cache as respostas DNS fornecidas por este perfil do Gestor de Tráfego.	int

Ponto final

Nome	Descrição	Valor
propriedades	As propriedades do ponto final do Gestor de Tráfego.	EndpointProperties

EndpointProperties

Nome	Descrição	Valor
endpointLocation	Especifica a localização dos pontos finais externos ou aninhados ao utilizar o método de encaminhamento de tráfego "Desempenho".	string
endpointMonitorStatus	O estado de monitorização do ponto final.	"CheckingEndpoint" "Degradado" "Desativado" "Inativo" 'Online' 'Parado'
endpointStatus	O estado do ponto final. Se o ponto final estiver Ativado, é sondado para o estado de funcionamento do ponto final e está incluído no método de encaminhamento de tráfego.	"Desativado" "Ativado"
geoMapping	A lista de países/regiões mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Geográfico". Consulte a documentação do Traffic Manager Geographic para obter uma lista completa dos valores aceites.	cadeia[]
minChildEndpoints	O número mínimo de pontos finais que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".	int
prioridade	A prioridade deste ponto final ao utilizar o método de encaminhamento de tráfego "Prioridade". Os valores possíveis são de 1 a 1000, os valores mais baixos representam uma prioridade mais alta. Este é um parâmetro opcional. Se for especificado, tem de ser especificado em todos os pontos finais e nenhum dos dois pontos finais pode partilhar o mesmo valor de prioridade.	int
destino	O nome DNS completamente qualificado do ponto final. O Gestor de Tráfego devolve este valor em respostas DNS para direcionar o tráfego para este ponto final.	string
targetResourceId	O URI do Recurso do Azure do ponto final. Não aplicável aos pontos finais do tipo "ExternalEndpoints".	string
peso	O peso deste ponto final ao utilizar o método de encaminhamento de tráfego "Ponderado". Os valores possíveis são de 1 a 1000.	int

MonitorConfig

Nome	Descrição	Valor
intervalInSeconds	O intervalo de monitorização para pontos finais neste perfil. Este é o intervalo em que o Gestor de Tráfego verificará o estado de funcionamento de cada ponto final neste perfil.	int
caminho	O caminho relativo ao nome de domínio do ponto final utilizado para sondar o estado de funcionamento do ponto final.	string
porta	A porta TCP utilizada para sondar o estado de funcionamento do ponto final.	int
profileMonitorStatus	O estado de monitorização ao nível do perfil do Gestor de Tráfego.	"CheckingEndpoints" "Degradado" "Desativado" "Inativo" 'Online'
protocolo	O protocolo (HTTP, HTTPS ou TCP) utilizado para sondar o estado de funcionamento do ponto final.	'HTTP' "HTTPS" 'TCP'
timeoutInSeconds	O tempo limite do monitor para pontos finais neste perfil. Esta é a hora em que o Gestor de Tráfego permite que os pontos finais neste perfil possam responder à verificação de estado de funcionamento.	int
toleratedNumberOfFailures	O número de falhas consecutivas do estado de funcionamento verifica se o Gestor de Tráfego tolera antes de declarar um ponto final neste perfil Degradado após a verificação de estado de funcionamento falhada seguinte.	int

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Gestor de tráfego de várias camadas, L4 ILB, L7 AppGateway	Este modelo implementa uma Rede Virtual, segrega a rede através de sub-redes, implementa VMs e configura o balanceamento de carga
Gestor de Tráfego do Azure + Configuração da Demonstração de Gateways de Aplicação	Este modelo permite-lhe implementar rapidamente o Gestor de Tráfego do Azure na demonstração de Gateways de Aplicação para testar a distribuição de tráfego entre diferentes regiões.
Configuração da Demonstração do Gestor de Tráfego do Azure	Este modelo permite-lhe implementar rapidamente a demonstração do Gestor de Tráfego do Azure para testar a distribuição de tráfego entre diferentes regiões.
Exemplo de ponto final externo do Gestor de Tráfego do Azure	Este modelo mostra como criar um perfil do Gestor de Tráfego do Azure com pontos finais externos.
Encaminhamento de vários valores do Gestor de Tráfego do Azure	Este modelo mostra como criar um perfil do Gestor de Tráfego do Azure através de pontos finais aninhados com encaminhamento min-child e multi-valor.
Exemplo de VM do Gestor de Tráfego do Azure	Este modelo mostra como criar um balanceamento de carga do perfil do Gestor de Tráfego do Azure em várias máquinas virtuais.
Exemplo de VM do Gestor de Tráfego do Azure com Zonas de Disponibilidade	Este modelo mostra como criar um balanceamento de carga do perfil do Gestor de Tráfego do Azure em várias máquinas virtuais colocadas no Zonas de Disponibilidade.
Exemplo de aplicação Web do Gestor de Tráfego do Azure	Este modelo mostra como criar um perfil do Gestor de Tráfego do Azure para um Serviço de Aplicações.

Definição de recurso de modelo do ARM

O tipo de recurso trafficmanagerprofiles pode ser implementado com operações que visam:

Grupos de recursos – veja comandos de implementação de grupos de recursos

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

Formato do recurso

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

{
  "type": "Microsoft.Network/trafficmanagerprofiles",
  "apiVersion": "2017-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "dnsConfig": {
      "relativeName": "string",
      "ttl": "int"
    },
    "endpoints": [
      {
        "properties": {
          "endpointLocation": "string",
          "endpointMonitorStatus": "string",
          "endpointStatus": "string",
          "geoMapping": [ "string" ],
          "minChildEndpoints": "int",
          "priority": "int",
          "target": "string",
          "targetResourceId": "string",
          "weight": "int"
        }
      }
    ],
    "monitorConfig": {
      "intervalInSeconds": "int",
      "path": "string",
      "port": "int",
      "profileMonitorStatus": "string",
      "protocol": "string",
      "timeoutInSeconds": "int",
      "toleratedNumberOfFailures": "int"
    },
    "profileStatus": "string",
    "trafficRoutingMethod": "string"
  }
}

Valores de propriedade

trafficmanagerprofiles

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Network/trafficmanagerprofiles"
apiVersion	A versão da API de recursos	'2017-05-01'
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 1-63 Carateres válidos: Alfanuméricos, hífenes e períodos. Comece e termine com alfanumérico. O nome do recurso tem de ser exclusivo em todo o Azure.
localização	A Região do Azure onde reside o recurso	string
etiquetas	Etiquetas de recursos.	Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
propriedades	As propriedades do perfil do Gestor de Tráfego.	ProfileProperties

ProfileProperties

Nome	Descrição	Valor
dnsConfig	As definições de DNS do perfil do Gestor de Tráfego.	DnsConfig
pontos finais	A lista de pontos finais no perfil do Gestor de Tráfego.	Ponto final[]
monitorConfig	As definições de monitorização do ponto final do perfil do Gestor de Tráfego.	MonitorConfig
profileStatus	O estado do perfil do Gestor de Tráfego.	"Desativado" "Ativado"
trafficRoutingMethod	O método de encaminhamento de tráfego do perfil do Gestor de Tráfego.	'Geográfico' "Desempenho" "Prioridade" "Ponderado"

DnsConfig

Nome	Descrição	Valor
relativeName	O nome DNS relativo fornecido por este perfil do Gestor de Tráfego. Este valor é combinado com o nome de domínio DNS utilizado pelo Gestor de Tráfego do Azure para formar o nome de domínio completamente qualificado (FQDN) do perfil.	string
ttl	O TTL (Time-To-Live) do DNS em segundos. Isto informa os clientes DNS e resoluções DNS locais durante quanto tempo deve colocar em cache as respostas DNS fornecidas por este perfil do Gestor de Tráfego.	int

Ponto final

Nome	Descrição	Valor
propriedades	As propriedades do ponto final do Gestor de Tráfego.	EndpointProperties

EndpointProperties

Nome	Descrição	Valor
endpointLocation	Especifica a localização dos pontos finais externos ou aninhados ao utilizar o método de encaminhamento de tráfego "Desempenho".	string
endpointMonitorStatus	O estado de monitorização do ponto final.	"CheckingEndpoint" "Degradado" "Desativado" "Inativo" 'Online' 'Parado'
endpointStatus	O estado do ponto final. Se o ponto final estiver Ativado, será sondado para o estado de funcionamento do ponto final e incluído no método de encaminhamento de tráfego.	"Desativado" "Ativado"
geoMapping	A lista de países/regiões mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Geográfico". Consulte a documentação geográfica do Gestor de Tráfego para obter uma lista completa dos valores aceites.	string[]
minChildEndpoints	O número mínimo de pontos finais que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".	int
prioridade	A prioridade deste ponto final ao utilizar o método de encaminhamento de tráfego "Priority". Os valores possíveis são de 1 a 1000, os valores mais baixos representam uma prioridade mais alta. Este é um parâmetro opcional. Se especificado, tem de ser especificado em todos os pontos finais e nenhum dos dois pontos finais pode partilhar o mesmo valor de prioridade.	int
destino	O nome DNS completamente qualificado do ponto final. O Gestor de Tráfego devolve este valor em respostas DNS para direcionar o tráfego para este ponto final.	string
targetResourceId	O URI do Recurso do Azure do ponto final. Não aplicável aos pontos finais do tipo "ExternalEndpoints".	string
peso	A ponderação deste ponto final ao utilizar o método de encaminhamento de tráfego "Ponderado". Os valores possíveis são de 1 a 1000.	int

MonitorConfig

Nome	Descrição	Valor
intervalInSeconds	O intervalo de monitorização para pontos finais neste perfil. Este é o intervalo no qual o Gestor de Tráfego verificará o estado de funcionamento de cada ponto final neste perfil.	int
caminho	O caminho relativo ao nome de domínio do ponto final utilizado para pesquisar o estado de funcionamento do ponto final.	string
porta	A porta TCP utilizada para sondar o estado de funcionamento do ponto final.	int
profileMonitorStatus	O estado de monitorização ao nível do perfil do Gestor de Tráfego.	"CheckingEndpoints" "Degradado" "Desativado" "Inativo" 'Online'
protocolo	O protocolo (HTTP, HTTPS ou TCP) utilizado para pesquisar o estado de funcionamento do ponto final.	"HTTP" "HTTPS" "TCP"
timeoutInSeconds	O tempo limite de monitorização para pontos finais neste perfil. Esta é a hora em que o Gestor de Tráfego permite que os pontos finais neste perfil reem resposta à verificação de estado de funcionamento.	int
toleratedNumberOfFailures	O número de verificações de estado de funcionamento falhadas consecutivas que o Gestor de Tráfego tolera antes de declarar um ponto final neste perfil Degradado após a próxima verificação de estado de funcionamento falhada.	int

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Gestor de tráfego de várias camadas, L4 ILB, L7 AppGateway	Este modelo implementa uma Rede Virtual, segrega a rede através de sub-redes, implementa VMs e configura o balanceamento de carga
Configuração da Demonstração do Gestor de Tráfego do Azure + Gateways de Aplicação	Este modelo permite-lhe implementar rapidamente o Gestor de Tráfego do Azure na demonstração dos Gateways de Aplicação para testar a distribuição de tráfego entre diferentes regiões.
Configuração da Demonstração do Gestor de Tráfego do Azure	Este modelo permite-lhe implementar rapidamente a demonstração do Gestor de Tráfego do Azure para testar a distribuição de tráfego entre diferentes regiões.
Exemplo de ponto final externo do Gestor de Tráfego do Azure	Este modelo mostra como criar um perfil do Gestor de Tráfego do Azure com pontos finais externos.
Encaminhamento de valores múltiplos do Gestor de Tráfego do Azure	Este modelo mostra como criar um perfil do Gestor de Tráfego do Azure com pontos finais aninhados com encaminhamento mínimo-subordinado e de múltiplos valores.
Exemplo de VM do Gestor de Tráfego do Azure	Este modelo mostra como criar um balanceamento de carga do perfil do Gestor de Tráfego do Azure em várias máquinas virtuais.
Exemplo de VM do Gestor de Tráfego do Azure com Zonas de Disponibilidade	Este modelo mostra como criar um balanceamento de carga do perfil do Gestor de Tráfego do Azure em várias máquinas virtuais colocadas no Zonas de Disponibilidade.
Exemplo de aplicação Web do Gestor de Tráfego do Azure	Este modelo mostra como criar um perfil do Gestor de Tráfego do Azure para uma Serviço de Aplicações.

Definição de recurso terraform (fornecedor AzAPI)

O tipo de recurso trafficmanagerprofiles pode ser implementado com operações que visam:

Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Network/trafficmanagerprofiles@2017-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      dnsConfig = {
        relativeName = "string"
        ttl = int
      }
      endpoints = [
        {
          properties = {
            endpointLocation = "string"
            endpointMonitorStatus = "string"
            endpointStatus = "string"
            geoMapping = [
              "string"
            ]
            minChildEndpoints = int
            priority = int
            target = "string"
            targetResourceId = "string"
            weight = int
          }
        }
      ]
      monitorConfig = {
        intervalInSeconds = int
        path = "string"
        port = int
        profileMonitorStatus = "string"
        protocol = "string"
        timeoutInSeconds = int
        toleratedNumberOfFailures = int
      }
      profileStatus = "string"
      trafficRoutingMethod = "string"
    }
  })
}

Valores de propriedade

trafficmanagerprofiles

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.Network/trafficmanagerprofiles@2017-05-01"
name	O nome do recurso	cadeia (obrigatório) Limite de carateres: 1-63 Carateres válidos: Alfanuméricos, hífenes e períodos. Comece e termine com alfanumérico. O nome do recurso tem de ser exclusivo em todo o Azure.
localização	A Região do Azure onde reside o recurso	string
parent_id	Para implementar num grupo de recursos, utilize o ID desse grupo de recursos.	cadeia (obrigatório)
etiquetas	Etiquetas de recursos.	Dicionário de nomes e valores de etiquetas.
propriedades	As propriedades do perfil do Gestor de Tráfego.	ProfileProperties

ProfileProperties

Nome	Descrição	Valor
dnsConfig	As definições de DNS do perfil do Gestor de Tráfego.	DnsConfig
pontos finais	A lista de pontos finais no perfil do Gestor de Tráfego.	Ponto final[]
monitorConfig	As definições de monitorização do ponto final do perfil do Gestor de Tráfego.	MonitorConfig
profileStatus	O estado do perfil do Gestor de Tráfego.	"Desativado" "Ativado"
trafficRoutingMethod	O método de encaminhamento de tráfego do perfil do Gestor de Tráfego.	"Geográfico" "Desempenho" "Prioridade" "Ponderado"

DnsConfig

Nome	Descrição	Valor
relativeName	O nome DNS relativo fornecido por este perfil do Gestor de Tráfego. Este valor é combinado com o nome de domínio DNS utilizado pelo Gestor de Tráfego do Azure para formar o nome de domínio completamente qualificado (FQDN) do perfil.	string
ttl	O TTL (Time-To-Live) do DNS em segundos. Isto informa os clientes DNS e resoluções DNS locais durante quanto tempo deve colocar em cache as respostas DNS fornecidas por este perfil do Gestor de Tráfego.	int

Ponto final

Nome	Descrição	Valor
propriedades	As propriedades do ponto final do Gestor de Tráfego.	EndpointProperties

EndpointProperties

Nome	Descrição	Valor
endpointLocation	Especifica a localização dos pontos finais externos ou aninhados ao utilizar o método de encaminhamento de tráfego "Desempenho".	string
endpointMonitorStatus	O estado de monitorização do ponto final.	"CheckingEndpoint" "Degradado" "Desativado" "Inativo" "Online" "Parado"
endpointStatus	O estado do ponto final. Se o ponto final estiver Ativado, será sondado para o estado de funcionamento do ponto final e incluído no método de encaminhamento de tráfego.	"Desativado" "Ativado"
geoMapping	A lista de países/regiões mapeados para este ponto final ao utilizar o método de encaminhamento de tráfego "Geográfico". Consulte a documentação geográfica do Gestor de Tráfego para obter uma lista completa dos valores aceites.	string[]
minChildEndpoints	O número mínimo de pontos finais que têm de estar disponíveis no perfil subordinado para que o perfil principal seja considerado disponível. Apenas aplicável ao ponto final do tipo "NestedEndpoints".	int
prioridade	A prioridade deste ponto final ao utilizar o método de encaminhamento de tráfego "Priority". Os valores possíveis são de 1 a 1000, os valores mais baixos representam uma prioridade mais alta. Este é um parâmetro opcional. Se especificado, tem de ser especificado em todos os pontos finais e nenhum dos dois pontos finais pode partilhar o mesmo valor de prioridade.	int
destino	O nome DNS completamente qualificado do ponto final. O Gestor de Tráfego devolve este valor em respostas DNS para direcionar o tráfego para este ponto final.	string
targetResourceId	O URI do Recurso do Azure do ponto final. Não aplicável aos pontos finais do tipo "ExternalEndpoints".	string
peso	A ponderação deste ponto final ao utilizar o método de encaminhamento de tráfego "Ponderado". Os valores possíveis são de 1 a 1000.	int

MonitorConfig

Nome	Descrição	Valor
intervalInSeconds	O intervalo de monitorização para pontos finais neste perfil. Este é o intervalo em que o Gestor de Tráfego verificará o estado de funcionamento de cada ponto final neste perfil.	int
caminho	O caminho relativo ao nome de domínio do ponto final utilizado para sondar o estado de funcionamento do ponto final.	string
porta	A porta TCP utilizada para sondar o estado de funcionamento do ponto final.	int
profileMonitorStatus	O estado de monitorização ao nível do perfil do Gestor de Tráfego.	"CheckingEndpoints" "Degradado" "Desativado" "Inativo" "Online"
protocolo	O protocolo (HTTP, HTTPS ou TCP) utilizado para sondar o estado de funcionamento do ponto final.	"HTTP" "HTTPS" "TCP"
timeoutInSeconds	O tempo limite do monitor para pontos finais neste perfil. Esta é a hora em que o Gestor de Tráfego permite que os pontos finais neste perfil possam responder à verificação de estado de funcionamento.	int
toleratedNumberOfFailures	O número de falhas consecutivas do estado de funcionamento verifica se o Gestor de Tráfego tolera antes de declarar um ponto final neste perfil Degradado após a verificação de estado de funcionamento falhada seguinte.	int

Partilhar via

Microsoft.Network trafficmanagerprofiles 2017-05-01

Definição de recurso do Bicep

Formato do recurso

Valores de propriedade

trafficmanagerprofiles

ProfileProperties

DnsConfig

Ponto final

EndpointProperties

MonitorConfig

Modelos de início rápido

Definição de recurso de modelo do ARM

Formato do recurso

Valores de propriedade

trafficmanagerprofiles

ProfileProperties

DnsConfig

Ponto final

EndpointProperties

MonitorConfig

Modelos de início rápido

Definição de recurso terraform (fornecedor AzAPI)

Formato do recurso

Valores de propriedade

trafficmanagerprofiles

ProfileProperties

DnsConfig

Ponto final

EndpointProperties

MonitorConfig

Comentários

Recursos adicionais