Microsoft. Prévia do serviço/workspaces/diagnósticos do ApiManagement 2025-09-01-preview

Definição de recurso Bicep

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

  • Grupos de recursos - Veja grupos de recursos c1

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

Exemplos de uso

Módulos verificados do Azure

O módulos verificados do Azure a seguir pode ser usado para implantar esse tipo de recurso.

Module Descrição
Serviço de Gerenciamento de API - Workspace - Diagnósticos Módulo Filho AVM para Serviço de Gerenciamento de API - Workspace - Diagnósticos

Formato de recurso

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

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/diagnostics@2025-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysLog: 'string'
    backend: {
      request: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
    }
    frontend: {
      request: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    largeLanguageModel: {
      logs: 'string'
      requests: {
        maxSizeInBytes: int
        messages: 'string'
      }
      responses: {
        maxSizeInBytes: int
        messages: 'string'
      }
    }
    logClientIp: bool
    loggerId: 'string'
    metrics: bool
    operationNameFormat: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: 'string'
  }
}

Valores de propriedade

Microsoft.ApiManagement/service/workspaces/diagnostics

Nome Descrição Valor
name O nome do recurso string

Constraints:
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 mais informações, veja Child resource externo do pai.
Nome simbólico para o recurso do tipo: serviço/workspaces
Propriedades Propriedades do contrato de entidade de diagnóstico. DiagnosticContractProperties

BodyDiagnosticSettings

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

Constraints:
Valor máximo = 8192

Mascaramento de dados

Nome Descrição Valor
headers Configurações de mascaramento para cabeçalhos datamaskingentity[]
queryParams Configurações de mascaramento para parâmetros de consulta de URL datamaskingentity[]

Entidade de mascaramento de dados

Nome Descrição Valor
mode Modo de mascaramento de dados. 'Ocultar'
'Máscara'
value O nome de uma entidade a ser mascarada (por exemplo, um nome de um cabeçalho ou um parâmetro de consulta). cadeia

DiagnosticContractProperties

Nome Descrição Valor
sempreRegistar Especifica que tipo de configurações de amostragem de mensagens não devem ser aplicadas. 'todos os erros'
back-end Configurações de diagnóstico para mensagens HTTP de entrada/saída para o back-end PipelineDiagnosticSettings
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. 'Herdado'
'Nenhum'
'W3C'
largeLanguageModel Configurações de diagnóstico de modelos de linguagem grandes Configurações LLMDiagnostic
logClientIp Registre o ClientIP em log. O padrão é false. bool
loggerId ID de recurso de um agente de destino. cadeia de caracteres (obrigatório)
métricas Emita métricas personalizadas por meio da política de métrica de emissão. Aplicável somente às configurações de diagnóstico do Application Insights. bool
operationNameFormat O formato do nome da operação para telemetrias do Application Insights. O padrão é Nome. 'Nome'
'Url'
amostragem Configurações de amostragem para Diagnóstico. SamplingSettings
detalhamento O nível de verbosidade aplicado a rastreamentos emitidos por políticas de rastreamento. 'erro'
'Informação'
'detalhado'

Diagnóstico de Mensagem Http

Nome Descrição Valor
body Configurações de registro em log do corpo. BodyDiagnosticSettings
Mascaramento de dados Configurações de mascaramento de dados. datamasking
headers Matriz de cabeçalhos HTTP a serem registrados em log. string[]

Configurações LLMDiagnostic

Nome Descrição Valor
logs Especifica se o diagnóstico padrão deve ser habilitado para modelos de linguagem grande ou não. 'desabilitado'
'habilitado'
requests Configurações de diagnóstico para solicitações de modelos de linguagem grandes. LLMMessageDiagnosticSettings
responses Configurações de diagnóstico para respostas de modelos de linguagem grandes. LLMMessageDiagnosticSettings

LLMMessageDiagnosticSettings

Nome Descrição Valor
maxSizeInBytes Tamanho máximo da mensagem para logs em bytes. O tamanho padrão é 32 KB. int

Constraints:
Valor mínimo = 1
Valor máximo = 262144
messages Especifica qual mensagem deve ser registrada. Atualmente, há apenas a opção "todos". 'Todos'

PipelineDiagnosticSettings

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

Configurações de amostragem

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

Constraints:
Valor mínimo = 0
Valor máximo = 100
tipo de amostragem Tipo de amostragem. 'corrigido'

Definição de recurso de modelo do ARM

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

Exemplos de uso

Formato de recurso

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

{
  "type": "Microsoft.ApiManagement/service/workspaces/diagnostics",
  "apiVersion": "2025-09-01-preview",
  "name": "string",
  "properties": {
    "alwaysLog": "string",
    "backend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      }
    },
    "frontend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "largeLanguageModel": {
      "logs": "string",
      "requests": {
        "maxSizeInBytes": "int",
        "messages": "string"
      },
      "responses": {
        "maxSizeInBytes": "int",
        "messages": "string"
      }
    },
    "logClientIp": "bool",
    "loggerId": "string",
    "metrics": "bool",
    "operationNameFormat": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "string"
  }
}

Valores de propriedade

Microsoft.ApiManagement/service/workspaces/diagnostics

Nome Descrição Valor
apiVersion A versão da API '2025-09-01-preview'
name O nome do recurso string

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

BodyDiagnosticSettings

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

Constraints:
Valor máximo = 8192

Mascaramento de dados

Nome Descrição Valor
headers Configurações de mascaramento para cabeçalhos datamaskingentity[]
queryParams Configurações de mascaramento para parâmetros de consulta de URL datamaskingentity[]

Entidade de mascaramento de dados

Nome Descrição Valor
mode Modo de mascaramento de dados. 'Ocultar'
'Máscara'
value O nome de uma entidade a ser mascarada (por exemplo, um nome de um cabeçalho ou um parâmetro de consulta). cadeia

DiagnosticContractProperties

Nome Descrição Valor
sempreRegistar Especifica que tipo de configurações de amostragem de mensagens não devem ser aplicadas. 'todos os erros'
back-end Configurações de diagnóstico para mensagens HTTP de entrada/saída para o back-end PipelineDiagnosticSettings
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. 'Herdado'
'Nenhum'
'W3C'
largeLanguageModel Configurações de diagnóstico de modelos de linguagem grandes Configurações LLMDiagnostic
logClientIp Registre o ClientIP em log. O padrão é false. bool
loggerId ID de recurso de um agente de destino. cadeia de caracteres (obrigatório)
métricas Emita métricas personalizadas por meio da política de métrica de emissão. Aplicável somente às configurações de diagnóstico do Application Insights. bool
operationNameFormat O formato do nome da operação para telemetrias do Application Insights. O padrão é Nome. 'Nome'
'Url'
amostragem Configurações de amostragem para Diagnóstico. SamplingSettings
detalhamento O nível de verbosidade aplicado a rastreamentos emitidos por políticas de rastreamento. 'erro'
'Informação'
'detalhado'

Diagnóstico de Mensagem Http

Nome Descrição Valor
body Configurações de registro em log do corpo. BodyDiagnosticSettings
Mascaramento de dados Configurações de mascaramento de dados. datamasking
headers Matriz de cabeçalhos HTTP a serem registrados em log. string[]

Configurações LLMDiagnostic

Nome Descrição Valor
logs Especifica se o diagnóstico padrão deve ser habilitado para modelos de linguagem grande ou não. 'desabilitado'
'habilitado'
requests Configurações de diagnóstico para solicitações de modelos de linguagem grandes. LLMMessageDiagnosticSettings
responses Configurações de diagnóstico para respostas de modelos de linguagem grandes. LLMMessageDiagnosticSettings

LLMMessageDiagnosticSettings

Nome Descrição Valor
maxSizeInBytes Tamanho máximo da mensagem para logs em bytes. O tamanho padrão é 32 KB. int

Constraints:
Valor mínimo = 1
Valor máximo = 262144
messages Especifica qual mensagem deve ser registrada. Atualmente, há apenas a opção "todos". 'Todos'

PipelineDiagnosticSettings

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

Configurações de amostragem

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

Constraints:
Valor mínimo = 0
Valor máximo = 100
tipo de amostragem Tipo de amostragem. 'corrigido'

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

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/diagnostics@2025-09-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      alwaysLog = "string"
      backend = {
        request = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
      }
      frontend = {
        request = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      largeLanguageModel = {
        logs = "string"
        requests = {
          maxSizeInBytes = int
          messages = "string"
        }
        responses = {
          maxSizeInBytes = int
          messages = "string"
        }
      }
      logClientIp = bool
      loggerId = "string"
      metrics = bool
      operationNameFormat = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "string"
    }
  }
}

Valores de propriedade

Microsoft.ApiManagement/service/workspaces/diagnostics

Nome Descrição Valor
name O nome do recurso string

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

BodyDiagnosticSettings

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

Constraints:
Valor máximo = 8192

Mascaramento de dados

Nome Descrição Valor
headers Configurações de mascaramento para cabeçalhos datamaskingentity[]
queryParams Configurações de mascaramento para parâmetros de consulta de URL datamaskingentity[]

Entidade de mascaramento de dados

Nome Descrição Valor
mode Modo de mascaramento de dados. 'Ocultar'
'Máscara'
value O nome de uma entidade a ser mascarada (por exemplo, um nome de um cabeçalho ou um parâmetro de consulta). cadeia

DiagnosticContractProperties

Nome Descrição Valor
sempreRegistar Especifica que tipo de configurações de amostragem de mensagens não devem ser aplicadas. 'todos os erros'
back-end Configurações de diagnóstico para mensagens HTTP de entrada/saída para o back-end PipelineDiagnosticSettings
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. 'Herdado'
'Nenhum'
'W3C'
largeLanguageModel Configurações de diagnóstico de modelos de linguagem grandes Configurações LLMDiagnostic
logClientIp Registre o ClientIP em log. O padrão é false. bool
loggerId ID de recurso de um agente de destino. cadeia de caracteres (obrigatório)
métricas Emita métricas personalizadas por meio da política de métrica de emissão. Aplicável somente às configurações de diagnóstico do Application Insights. bool
operationNameFormat O formato do nome da operação para telemetrias do Application Insights. O padrão é Nome. 'Nome'
'Url'
amostragem Configurações de amostragem para Diagnóstico. SamplingSettings
detalhamento O nível de verbosidade aplicado a rastreamentos emitidos por políticas de rastreamento. 'erro'
'Informação'
'detalhado'

Diagnóstico de Mensagem Http

Nome Descrição Valor
body Configurações de registro em log do corpo. BodyDiagnosticSettings
Mascaramento de dados Configurações de mascaramento de dados. datamasking
headers Matriz de cabeçalhos HTTP a serem registrados em log. string[]

Configurações LLMDiagnostic

Nome Descrição Valor
logs Especifica se o diagnóstico padrão deve ser habilitado para modelos de linguagem grande ou não. 'desabilitado'
'habilitado'
requests Configurações de diagnóstico para solicitações de modelos de linguagem grandes. LLMMessageDiagnosticSettings
responses Configurações de diagnóstico para respostas de modelos de linguagem grandes. LLMMessageDiagnosticSettings

LLMMessageDiagnosticSettings

Nome Descrição Valor
maxSizeInBytes Tamanho máximo da mensagem para logs em bytes. O tamanho padrão é 32 KB. int

Constraints:
Valor mínimo = 1
Valor máximo = 262144
messages Especifica qual mensagem deve ser registrada. Atualmente, há apenas a opção "todos". 'Todos'

PipelineDiagnosticSettings

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

Configurações de amostragem

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

Constraints:
Valor mínimo = 0
Valor máximo = 100
tipo de amostragem Tipo de amostragem. 'corrigido'