Partilhar via

Serviço/diagnóstico Microsoft.ApiManagement 2019-01-01

  • Artigo

Definição de recursos do bíceps

O tipo de recurso de serviço/diagnóstico pode ser implantado com operações direcionadas:

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.ApiManagement/service/diagnostics, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2019-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysLog: 'string'
    backend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    enableHttpCorrelationHeaders: bool
    frontend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: 'string'
  }
}

Valores de propriedade

BodyDiagnosticSettings

Designação Descrição Valor
Bytes Número de bytes do corpo da solicitação para registrar. Int

Restrições:
Valor máximo = 8192

DiagnosticContractProperties

Designação Descrição Valor
sempreLog Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas. 'allErrors'
Back-end Configurações de diagnóstico para mensagens HTTP de entrada/saída para o back-end PipelineDiagnosticSettings
enableHttpCorrelationHeaders Se os cabeçalhos de correlação devem ser processados no Serviço de Gerenciamento de Api. Aplicável apenas ao diagnóstico do Application Insights. O padrão é true. Bool
frontend Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway. PipelineDiagnosticSettings
httpCorrelationProtocol Define o protocolo de correlação a ser usado para o diagnóstico do Application Insights. 'Legado'
'Nenhuma'
'W3C'
loggerId ID do recurso de um registrador de destino. string (obrigatório)
amostragem Configurações de amostragem para diagnóstico. SamplingSettings
Verborragia O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento. 'erro'
'informação'
'Verborrágico'

HttpMessageDiagnostic

Designação Descrição Valor
corpo Configurações de registro do corpo. BodyDiagnosticSettings
cabeçalhos Matriz de cabeçalhos HTTP para registrar. string[]

Microsoft.ApiManagement/serviço/diagnóstico

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte recurso filho fora do recurso pai.		 Nome simbólico para recurso do tipo: serviço
propriedades Propriedades do contrato da entidade de diagnóstico. DiagnosticContractProperties

PipelineDiagnosticSettings

Designação Descrição Valor
solicitar Configurações de diagnóstico para solicitação. HttpMessageDiagnostic
resposta Configurações de diagnóstico para resposta. HttpMessageDiagnostic

Configurações de amostragem

Designação Descrição Valor
percentagem Taxa de amostragem para amostragem de taxa fixa. Int

Restrições:
Valor mínimo = 0
Valor máximo = 100
samplingType Tipo de amostragem. 'Fixo'

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
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.
Criar gerenciamento de API em rede virtual interna com do App Gateway Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure.

Definição de recurso de modelo ARM

O tipo de recurso de serviço/diagnóstico pode ser implantado com operações direcionadas:

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.ApiManagement/service/diagnostics, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2019-01-01",
  "name": "string",
  "properties": {
    "alwaysLog": "string",
    "backend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "enableHttpCorrelationHeaders": "bool",
    "frontend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "string"
  }
}

Valores de propriedade

BodyDiagnosticSettings

Designação Descrição Valor
Bytes Número de bytes do corpo da solicitação para registrar. Int

Restrições:
Valor máximo = 8192

DiagnosticContractProperties

Designação Descrição Valor
sempreLog Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas. 'allErrors'
Back-end Configurações de diagnóstico para mensagens HTTP de entrada/saída para o back-end PipelineDiagnosticSettings
enableHttpCorrelationHeaders Se os cabeçalhos de correlação devem ser processados no Serviço de Gerenciamento de Api. Aplicável apenas ao diagnóstico do Application Insights. O padrão é true. Bool
frontend Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway. PipelineDiagnosticSettings
httpCorrelationProtocol Define o protocolo de correlação a ser usado para o diagnóstico do Application Insights. 'Legado'
'Nenhuma'
'W3C'
loggerId ID do recurso de um registrador de destino. string (obrigatório)
amostragem Configurações de amostragem para diagnóstico. SamplingSettings
Verborragia O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento. 'erro'
'informação'
'Verborrágico'

HttpMessageDiagnostic

Designação Descrição Valor
corpo Configurações de registro do corpo. BodyDiagnosticSettings
cabeçalhos Matriz de cabeçalhos HTTP para registrar. string[]

Microsoft.ApiManagement/serviço/diagnóstico

Designação Descrição Valor
apiVersion A versão api '2019-01-01'
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
propriedades Propriedades do contrato da entidade de diagnóstico. DiagnosticContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/diagnostics'

PipelineDiagnosticSettings

Designação Descrição Valor
solicitar Configurações de diagnóstico para solicitação. HttpMessageDiagnostic
resposta Configurações de diagnóstico para resposta. HttpMessageDiagnostic

Configurações de amostragem

Designação Descrição Valor
percentagem Taxa de amostragem para amostragem de taxa fixa. Int

Restrições:
Valor mínimo = 0
Valor máximo = 100
samplingType Tipo de amostragem. 'Fixo'

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Application Gateway com gerenciamento interno de API e de aplicativos Web

Implantar no Azure 		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.
Criar gerenciamento de API em rede virtual interna com do App Gateway

Implantar no Azure 		Este modelo demonstra como Criar uma instância do Gerenciamento de API do Azure em uma rede privada protegida pelo Gateway de Aplicativo do Azure.

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso de serviço/diagnóstico pode ser implantado com operações direcionadas:

  • Grupos de recursos

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.ApiManagement/service/diagnostics, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/diagnostics@2019-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "string"
      backend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      enableHttpCorrelationHeaders = bool
      frontend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "string"
    }
  })
}

Valores de propriedade

BodyDiagnosticSettings

Designação Descrição Valor
Bytes Número de bytes do corpo da solicitação para registrar. Int

Restrições:
Valor máximo = 8192

DiagnosticContractProperties

Designação Descrição Valor
sempreLog Especifica para que tipo de mensagens as configurações de amostragem não devem ser aplicadas. 'allErrors'
Back-end Configurações de diagnóstico para mensagens HTTP de entrada/saída para o back-end PipelineDiagnosticSettings
enableHttpCorrelationHeaders Se os cabeçalhos de correlação devem ser processados no Serviço de Gerenciamento de Api. Aplicável apenas ao diagnóstico do Application Insights. O padrão é true. Bool
frontend Configurações de diagnóstico para mensagens HTTP de entrada/saída para o Gateway. PipelineDiagnosticSettings
httpCorrelationProtocol Define o protocolo de correlação a ser usado para o diagnóstico do Application Insights. 'Legado'
'Nenhuma'
'W3C'
loggerId ID do recurso de um registrador de destino. string (obrigatório)
amostragem Configurações de amostragem para diagnóstico. SamplingSettings
Verborragia O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento. 'erro'
'informação'
'Verborrágico'

HttpMessageDiagnostic

Designação Descrição Valor
corpo Configurações de registro do corpo. BodyDiagnosticSettings
cabeçalhos Matriz de cabeçalhos HTTP para registrar. string[]

Microsoft.ApiManagement/serviço/diagnóstico

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 80
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id A ID do recurso que é o pai para este recurso. ID do recurso do tipo: serviço
propriedades Propriedades do contrato da entidade de diagnóstico. DiagnosticContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/diagnostics@2019-01-01"

PipelineDiagnosticSettings

Designação Descrição Valor
solicitar Configurações de diagnóstico para solicitação. HttpMessageDiagnostic
resposta Configurações de diagnóstico para resposta. HttpMessageDiagnostic

Configurações de amostragem

Designação Descrição Valor
percentagem Taxa de amostragem para amostragem de taxa fixa. Int

Restrições:
Valor mínimo = 0
Valor máximo = 100
samplingType Tipo de amostragem. 'Fixo'