Microsoft.ApiManagement service/workspaces/apis/diagnostics 2024-05-01
Definição de recurso do Bicep
O tipo de recurso service/workspaces/apis/diagnostics pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação do grupo 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/workspaces/apis/diagnostics, adicione o Bicep a seguir ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/diagnostics@2024-05-01' = {
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'
logClientIp: bool
loggerId: 'string'
metrics: bool
operationNameFormat: '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 |
DataMasking
| Nome | Descrição | Valor |
|---|---|---|
| Cabeçalhos | Configurações de mascaramento para cabeçalhos | datamaskingentity[] |
| queryParams | Configurações de mascaramento para parâmetros de consulta de URL | datamaskingentity[] |
DataMaskingEntity
| Nome | Descrição | Valor |
|---|---|---|
| modo | Modo de mascaramento de dados. | 'Ocultar' 'Máscara' |
| valor | O nome de uma entidade a ser mascarada (por exemplo, um nome de um cabeçalho ou um parâmetro de consulta). | corda |
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 |
| 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' |
| 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. | |
| 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 |
| dataMasking | Configurações de mascaramento de dados. | datamasking |
| Cabeçalhos | Matriz de cabeçalhos HTTP a serem registrados em log. | string[] |
Microsoft.ApiManagement/service/workspaces/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/workspaces/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 service/workspaces/apis/diagnostics pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação do grupo 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/workspaces/apis/diagnostics, adicione o JSON a seguir ao modelo.
{
"type": "Microsoft.ApiManagement/service/workspaces/apis/diagnostics",
"apiVersion": "2024-05-01",
"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",
"logClientIp": "bool",
"loggerId": "string",
"metrics": "bool",
"operationNameFormat": "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 |
DataMasking
| Nome | Descrição | Valor |
|---|---|---|
| Cabeçalhos | Configurações de mascaramento para cabeçalhos | datamaskingentity[] |
| queryParams | Configurações de mascaramento para parâmetros de consulta de URL | datamaskingentity[] |
DataMaskingEntity
| Nome | Descrição | Valor |
|---|---|---|
| modo | Modo de mascaramento de dados. | 'Ocultar' 'Máscara' |
| valor | O nome de uma entidade a ser mascarada (por exemplo, um nome de um cabeçalho ou um parâmetro de consulta). | corda |
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 |
| 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' |
| 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. | |
| 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 |
| dataMasking | Configurações de mascaramento de dados. | datamasking |
| Cabeçalhos | Matriz de cabeçalhos HTTP a serem registrados em log. | string[] |
Microsoft.ApiManagement/service/workspaces/apis/diagnostics
| Nome | Descrição | Valor |
|---|---|---|
| apiVersion | A versão da API | '2024-05-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/workspaces/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 service/workspaces/apis/diagnostics 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/workspaces/apis/diagnostics, adicione o Terraform a seguir ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/apis/diagnostics@2024-05-01"
name = "string"
body = jsonencode({
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"
logClientIp = bool
loggerId = "string"
metrics = bool
operationNameFormat = "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 |
DataMasking
| Nome | Descrição | Valor |
|---|---|---|
| Cabeçalhos | Configurações de mascaramento para cabeçalhos | datamaskingentity[] |
| queryParams | Configurações de mascaramento para parâmetros de consulta de URL | datamaskingentity[] |
DataMaskingEntity
| Nome | Descrição | Valor |
|---|---|---|
| modo | Modo de mascaramento de dados. | 'Ocultar' 'Máscara' |
| valor | O nome de uma entidade a ser mascarada (por exemplo, um nome de um cabeçalho ou um parâmetro de consulta). | corda |
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 |
| 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' |
| 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. | |
| 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 |
| dataMasking | Configurações de mascaramento de dados. | datamasking |
| Cabeçalhos | Matriz de cabeçalhos HTTP a serem registrados em log. | string[] |
Microsoft.ApiManagement/service/workspaces/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/workspaces/apis |
| Propriedades | Propriedades do contrato de entidade de diagnóstico. | DiagnosticContractProperties |
| tipo | O tipo de recurso | "Microsoft.ApiManagement/service/workspaces/apis/diagnostics@2024-05-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' |