Partilhar via

Serviço/apis/diagnóstico Microsoft.ApiManagement 2018-06-01-preview

  • Artigo

Definição de recursos do bíceps

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview' = {
  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'
        ]
      }
    }
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: '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
loggerId ID do recurso de um registrador de destino. string (obrigatório)
amostragem Configurações de amostragem para diagnóstico. SamplingSettings

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/service/apis/diagnostics

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: service/apis
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'

Definição de recurso de modelo ARM

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

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2018-06-01-preview",
  "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" ]
      }
    },
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "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
loggerId ID do recurso de um registrador de destino. string (obrigatório)
amostragem Configurações de amostragem para diagnóstico. SamplingSettings

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/service/apis/diagnostics

Designação Descrição Valor
apiVersion A versão api '2018-06-01-pré-visualização'
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/apis/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'

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso service/apis/diagnostics pode ser implantado com operações que visam:

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview"
  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"
          ]
        }
      }
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "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
loggerId ID do recurso de um registrador de destino. string (obrigatório)
amostragem Configurações de amostragem para diagnóstico. SamplingSettings

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/service/apis/diagnostics

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: service/apis
propriedades Propriedades do contrato da entidade de diagnóstico. DiagnosticContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview"

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'