Serviço/diagnóstico Microsoft.ApiManagement 2021-12-01-preview
O tipo de recurso de serviço/diagnóstico pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Para criar um recurso Microsoft.ApiManagement/service/diagnostics, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2021-12-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'
logClientIp: bool
loggerId: 'string'
metrics: bool
operationNameFormat: 'string'
sampling: {
percentage: int
samplingType: 'string'
}
verbosity: 'string'
}
}
Designação | Descrição | Valor |
---|---|---|
Bytes | Número de bytes do corpo da solicitação para registrar. | Int Restrições: Valor máximo = 8192 |
Designação | Descrição | Valor |
---|---|---|
cabeçalhos | Configurações de mascaramento para cabeçalhos | DataMaskingEntity[] |
queryParams | Configurações de mascaramento para parâmetros de consulta Url | DataMaskingEntity[] |
Designação | Descrição | Valor |
---|---|---|
modo | Modo de mascaramento de dados. | 'Esconder' '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). | string |
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 |
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' |
logClientIp | Registre o ClientIP. O padrão é false. | Bool |
loggerId | ID do recurso de um registrador de destino. | string (obrigatório) |
métricas | Emita métricas personalizadas por meio da política de métricas de emissão. Aplicável apenas à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 |
Verborragia | O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento. | 'erro' 'informação' 'Verborrágico' |
Designação | Descrição | Valor |
---|---|---|
corpo | Configurações de registro do corpo. | BodyDiagnosticSettings |
mascaramento de dados | Configurações de mascaramento de dados. | DataMasking |
cabeçalhos | Matriz de cabeçalhos HTTP para registrar. | string[] |
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 |
Designação | Descrição | Valor |
---|---|---|
solicitar | Configurações de diagnóstico para solicitação. | HttpMessageDiagnostic |
resposta | Configurações de diagnóstico para resposta. | HttpMessageDiagnostic |
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' |
Os seguintes modelos início rápido do Azure contêm exemplos de Bicep para implantar 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. |
O tipo de recurso de serviço/diagnóstico pode ser implantado com operações direcionadas:
- Grupos de recursos - Consulte comandos de implantação de grupo de recursos
Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.
Para criar um recurso Microsoft.ApiManagement/service/diagnostics, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.ApiManagement/service/diagnostics",
"apiVersion": "2021-12-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",
"logClientIp": "bool",
"loggerId": "string",
"metrics": "bool",
"operationNameFormat": "string",
"sampling": {
"percentage": "int",
"samplingType": "string"
},
"verbosity": "string"
}
}
Designação | Descrição | Valor |
---|---|---|
Bytes | Número de bytes do corpo da solicitação para registrar. | Int Restrições: Valor máximo = 8192 |
Designação | Descrição | Valor |
---|---|---|
cabeçalhos | Configurações de mascaramento para cabeçalhos | DataMaskingEntity[] |
queryParams | Configurações de mascaramento para parâmetros de consulta Url | DataMaskingEntity[] |
Designação | Descrição | Valor |
---|---|---|
modo | Modo de mascaramento de dados. | 'Esconder' '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). | string |
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 |
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' |
logClientIp | Registre o ClientIP. O padrão é false. | Bool |
loggerId | ID do recurso de um registrador de destino. | string (obrigatório) |
métricas | Emita métricas personalizadas por meio da política de métricas de emissão. Aplicável apenas à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 |
Verborragia | O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento. | 'erro' 'informação' 'Verborrágico' |
Designação | Descrição | Valor |
---|---|---|
corpo | Configurações de registro do corpo. | BodyDiagnosticSettings |
mascaramento de dados | Configurações de mascaramento de dados. | DataMasking |
cabeçalhos | Matriz de cabeçalhos HTTP para registrar. | string[] |
Designação | Descrição | Valor |
---|---|---|
solicitar | Configurações de diagnóstico para solicitação. | HttpMessageDiagnostic |
resposta | Configurações de diagnóstico para resposta. | HttpMessageDiagnostic |
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' |
Os seguintes modelos de início rápido do Azure implantar esse tipo de recurso.
Modelo | 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. |
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.
Para criar um recurso Microsoft.ApiManagement/service/diagnostics, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/diagnostics@2021-12-01-preview"
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"
}
})
}
Designação | Descrição | Valor |
---|---|---|
Bytes | Número de bytes do corpo da solicitação para registrar. | Int Restrições: Valor máximo = 8192 |
Designação | Descrição | Valor |
---|---|---|
cabeçalhos | Configurações de mascaramento para cabeçalhos | DataMaskingEntity[] |
queryParams | Configurações de mascaramento para parâmetros de consulta Url | DataMaskingEntity[] |
Designação | Descrição | Valor |
---|---|---|
modo | Modo de mascaramento de dados. | 'Esconder' '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). | string |
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 |
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' |
logClientIp | Registre o ClientIP. O padrão é false. | Bool |
loggerId | ID do recurso de um registrador de destino. | string (obrigatório) |
métricas | Emita métricas personalizadas por meio da política de métricas de emissão. Aplicável apenas à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 |
Verborragia | O nível de detalhamento aplicado aos traços emitidos pelas políticas de rastreamento. | 'erro' 'informação' 'Verborrágico' |
Designação | Descrição | Valor |
---|---|---|
corpo | Configurações de registro do corpo. | BodyDiagnosticSettings |
mascaramento de dados | Configurações de mascaramento de dados. | DataMasking |
cabeçalhos | Matriz de cabeçalhos HTTP para registrar. | string[] |
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@2021-12-01-preview" |
Designação | Descrição | Valor |
---|---|---|
solicitar | Configurações de diagnóstico para solicitação. | HttpMessageDiagnostic |
resposta | Configurações de diagnóstico para resposta. | HttpMessageDiagnostic |
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' |