Compartilhar via

Microsoft.ApiManagement service/apis/diagnostics 2019-01-01

  • Artigo

Definição de recurso do Bicep

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

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

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/apis/diagnostics, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/apis/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

Nome Descrição Valor
Bytes Número de bytes do corpo da solicitação a serem registrados em log. int

Restrições:
Valor máximo = 8192

DiagnosticContractProperties

Nome Descrição Valor
alwaysLog Especifica que tipo de configurações de amostragem de mensagens 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 somente ao diagnóstico do Application Insights. O padrão é verdadeiro. Bool
front-end 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. 'Herdado'
'None'
'W3C'
loggerId ID de recurso de um agente de destino. cadeia de caracteres (obrigatório)
amostragem Configurações de amostragem para Diagnóstico. SamplingSettings
verbosidade O nível de verbosidade aplicado a rastreamentos emitidos por políticas de rastreamento. 'error'
'information'
'detalhado'

HttpMessageDiagnostic

Nome Descrição Valor
corpo Configurações de registro em log do corpo. BodyDiagnosticSettings
Cabeçalhos Matriz de cabeçalhos HTTP a serem registrados em log. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
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 o recurso do tipo: serviço/apis
Propriedades Propriedades do contrato de entidade de diagnóstico. DiagnosticContractProperties

PipelineDiagnosticSettings

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

SamplingSettings

Nome Descrição Valor
porcentagem Taxa de amostragem para amostragem de taxa fixa. int

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

Definição de recurso de modelo do ARM

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

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

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/apis/diagnostics, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/apis/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

Nome Descrição Valor
Bytes Número de bytes do corpo da solicitação a serem registrados em log. int

Restrições:
Valor máximo = 8192

DiagnosticContractProperties

Nome Descrição Valor
alwaysLog Especifica que tipo de configurações de amostragem de mensagens 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 somente ao diagnóstico do Application Insights. O padrão é verdadeiro. Bool
front-end 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. 'Herdado'
'None'
'W3C'
loggerId ID de recurso de um agente de destino. cadeia de caracteres (obrigatório)
amostragem Configurações de amostragem para Diagnóstico. SamplingSettings
verbosidade O nível de verbosidade aplicado a rastreamentos emitidos por políticas de rastreamento. 'error'
'information'
'detalhado'

HttpMessageDiagnostic

Nome Descrição Valor
corpo Configurações de registro em log do corpo. BodyDiagnosticSettings
Cabeçalhos Matriz de cabeçalhos HTTP a serem registrados em log. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nome Descrição Valor
apiVersion A versão da API '2019-01-01'
nome O nome do recurso corda

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

PipelineDiagnosticSettings

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

SamplingSettings

Nome Descrição Valor
porcentagem Taxa de amostragem para amostragem de taxa fixa. int

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

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso de serviço/apis/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 de log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/apis/diagnostics, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/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

Nome Descrição Valor
Bytes Número de bytes do corpo da solicitação a serem registrados em log. int

Restrições:
Valor máximo = 8192

DiagnosticContractProperties

Nome Descrição Valor
alwaysLog Especifica que tipo de configurações de amostragem de mensagens 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 somente ao diagnóstico do Application Insights. O padrão é verdadeiro. Bool
front-end 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. 'Herdado'
'None'
'W3C'
loggerId ID de recurso de um agente de destino. cadeia de caracteres (obrigatório)
amostragem Configurações de amostragem para Diagnóstico. SamplingSettings
verbosidade O nível de verbosidade aplicado a rastreamentos emitidos por políticas de rastreamento. 'error'
'information'
'detalhado'

HttpMessageDiagnostic

Nome Descrição Valor
corpo Configurações de registro em log do corpo. BodyDiagnosticSettings
Cabeçalhos Matriz de cabeçalhos HTTP a serem registrados em log. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nome Descrição Valor
nome O nome do recurso corda

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

PipelineDiagnosticSettings

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

SamplingSettings

Nome Descrição Valor
porcentagem Taxa de amostragem para amostragem de taxa fixa. int

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