Compartilhar via


Microsoft.ApiManagement service/loggers 2017-03-01

Definição de recurso do Bicep

O tipo de recurso de serviço/agente pode ser implantado com operações de destino:

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/loggers, adicione o Bicep a seguir ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/loggers@2017-03-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    credentials: {
      {customized property}: 'string'
    }
    description: 'string'
    isBuffered: bool
    loggerType: 'string'
    sampling: {
      properties: {
        evaluationInterval: 'string'
        initialPercentage: int
        maxPercentage: int
        maxTelemetryItemsPerSecond: int
        minPercentage: int
        movingAverageRatio: int
        percentage: int
        percentageDecreaseTimeout: 'string'
        percentageIncreaseTimeout: 'string'
        samplingType: 'string'
      }
    }
  }
}

Valores de propriedade

LoggerContractProperties

Nome Descrição Valor
credenciais O nome e a cadeia de conexão SendRule do hub de eventos do agente do azureEventHub.
Chave de instrumentação para o agente applicationInsights.
LoggerContractPropertiesCredentials (obrigatório)
descrição Descrição do agente. corda

Restrições:
Comprimento máximo =
isBuffered Se os registros são armazenados em buffer no agente antes da publicação. O padrão é considerado verdadeiro. Bool
loggerType Tipo de agente. 'applicationInsights'
'azureEventHub' (obrigatório)
amostragem Configurações de amostragem para um agente do ApplicationInsights. LoggerSamplingContract

LoggerContractPropertiesCredentials

Nome Descrição Valor

LoggerSamplingContract

Nome Descrição Valor
Propriedades Propriedades do contrato de entidade de configurações de amostragem. LoggerSamplingProperties

LoggerSamplingProperties

Nome Descrição Valor
evaluationInterval Intervalo de reavaliação de taxa no formato ISO8601. corda
initialPercentage Taxa de amostragem inicial. int
maxPercentage Taxa máxima permitida de amostragem. int
maxTelemetryItemsPerSecond Taxa de destino de itens de telemetria por segundo. int
minPercentage Taxa mínima permitida de amostragem. int
movingAverageRatio Ração média móvel atribuída ao valor mais recente. int
porcentagem Taxa de amostragem para amostragem de taxa fixa. int
percentageDecreaseTimeout Duração em ISO8601 formato após o qual é permitido reduzir a taxa de amostragem. corda
percentageIncreaseTimeout Duração em ISO8601 formato após o qual é permitido aumentar a taxa de amostragem. corda
samplingType Tipo de amostragem. 'adaptável'
'corrigido'

Microsoft.ApiManagement/service/loggers

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

Restrições:
Comprimento máximo =
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 do recurso do tipo: de serviço
Propriedades Propriedades do contrato de entidade do agente. LoggerContractProperties

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Gateway de Aplicativo com gerenciamento de API interno e de aplicativo Web Gateway de Aplicativo roteando o tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno), que atende a uma API Web hospedada em um Aplicativo Web do Azure.
criar gerenciamento de API na VNet interna com o Gateway de Aplicativo 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.
de Análise e Monetização da API moesif O modelo registrará chamadas de API do Gerenciamento de API do Azure para a plataforma de análise e monetização da API moesif

Definição de recurso de modelo do ARM

O tipo de recurso de serviço/agente pode ser implantado com operações de destino:

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/loggers, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/loggers",
  "apiVersion": "2017-03-01",
  "name": "string",
  "properties": {
    "credentials": {
      "{customized property}": "string"
    },
    "description": "string",
    "isBuffered": "bool",
    "loggerType": "string",
    "sampling": {
      "properties": {
        "evaluationInterval": "string",
        "initialPercentage": "int",
        "maxPercentage": "int",
        "maxTelemetryItemsPerSecond": "int",
        "minPercentage": "int",
        "movingAverageRatio": "int",
        "percentage": "int",
        "percentageDecreaseTimeout": "string",
        "percentageIncreaseTimeout": "string",
        "samplingType": "string"
      }
    }
  }
}

Valores de propriedade

LoggerContractProperties

Nome Descrição Valor
credenciais O nome e a cadeia de conexão SendRule do hub de eventos do agente do azureEventHub.
Chave de instrumentação para o agente applicationInsights.
LoggerContractPropertiesCredentials (obrigatório)
descrição Descrição do agente. corda

Restrições:
Comprimento máximo =
isBuffered Se os registros são armazenados em buffer no agente antes da publicação. O padrão é considerado verdadeiro. Bool
loggerType Tipo de agente. 'applicationInsights'
'azureEventHub' (obrigatório)
amostragem Configurações de amostragem para um agente do ApplicationInsights. LoggerSamplingContract

LoggerContractPropertiesCredentials

Nome Descrição Valor

LoggerSamplingContract

Nome Descrição Valor
Propriedades Propriedades do contrato de entidade de configurações de amostragem. LoggerSamplingProperties

LoggerSamplingProperties

Nome Descrição Valor
evaluationInterval Intervalo de reavaliação de taxa no formato ISO8601. corda
initialPercentage Taxa de amostragem inicial. int
maxPercentage Taxa máxima permitida de amostragem. int
maxTelemetryItemsPerSecond Taxa de destino de itens de telemetria por segundo. int
minPercentage Taxa mínima permitida de amostragem. int
movingAverageRatio Ração média móvel atribuída ao valor mais recente. int
porcentagem Taxa de amostragem para amostragem de taxa fixa. int
percentageDecreaseTimeout Duração em ISO8601 formato após o qual é permitido reduzir a taxa de amostragem. corda
percentageIncreaseTimeout Duração em ISO8601 formato após o qual é permitido aumentar a taxa de amostragem. corda
samplingType Tipo de amostragem. 'adaptável'
'corrigido'

Microsoft.ApiManagement/service/loggers

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

Restrições:
Comprimento máximo =
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
Propriedades Propriedades do contrato de entidade do agente. LoggerContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/loggers'

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Gateway de Aplicativo com gerenciamento de API interno e de aplicativo Web

Implantar no Azure
Gateway de Aplicativo roteando o tráfego da Internet para uma instância de Gerenciamento de API de rede virtual (modo interno), que atende a uma API Web hospedada em um Aplicativo Web do Azure.
criar gerenciamento de API na VNet interna com o Gateway de Aplicativo

Implantar no Azure
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.
criar o Azure Front Door em frente ao Gerenciamento de API do Azure

Implantar no Azure
Este exemplo demonstra como usar o Azure Front Door como um balanceador de carga global na frente do Gerenciamento de API do Azure.
de Análise e Monetização da API moesif

Implantar no Azure
O modelo registrará chamadas de API do Gerenciamento de API do Azure para a plataforma de análise e monetização da API moesif

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

O tipo de recurso de serviço/agente pode ser implantado com operações de destino:

  • 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/loggers, adicione o Terraform a seguir ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/loggers@2017-03-01"
  name = "string"
  body = jsonencode({
    properties = {
      credentials = {
        {customized property} = "string"
      }
      description = "string"
      isBuffered = bool
      loggerType = "string"
      sampling = {
        properties = {
          evaluationInterval = "string"
          initialPercentage = int
          maxPercentage = int
          maxTelemetryItemsPerSecond = int
          minPercentage = int
          movingAverageRatio = int
          percentage = int
          percentageDecreaseTimeout = "string"
          percentageIncreaseTimeout = "string"
          samplingType = "string"
        }
      }
    }
  })
}

Valores de propriedade

LoggerContractProperties

Nome Descrição Valor
credenciais O nome e a cadeia de conexão SendRule do hub de eventos do agente do azureEventHub.
Chave de instrumentação para o agente applicationInsights.
LoggerContractPropertiesCredentials (obrigatório)
descrição Descrição do agente. corda

Restrições:
Comprimento máximo =
isBuffered Se os registros são armazenados em buffer no agente antes da publicação. O padrão é considerado verdadeiro. Bool
loggerType Tipo de agente. 'applicationInsights'
'azureEventHub' (obrigatório)
amostragem Configurações de amostragem para um agente do ApplicationInsights. LoggerSamplingContract

LoggerContractPropertiesCredentials

Nome Descrição Valor

LoggerSamplingContract

Nome Descrição Valor
Propriedades Propriedades do contrato de entidade de configurações de amostragem. LoggerSamplingProperties

LoggerSamplingProperties

Nome Descrição Valor
evaluationInterval Intervalo de reavaliação de taxa no formato ISO8601. corda
initialPercentage Taxa de amostragem inicial. int
maxPercentage Taxa máxima permitida de amostragem. int
maxTelemetryItemsPerSecond Taxa de destino de itens de telemetria por segundo. int
minPercentage Taxa mínima permitida de amostragem. int
movingAverageRatio Ração média móvel atribuída ao valor mais recente. int
porcentagem Taxa de amostragem para amostragem de taxa fixa. int
percentageDecreaseTimeout Duração em ISO8601 formato após o qual é permitido reduzir a taxa de amostragem. corda
percentageIncreaseTimeout Duração em ISO8601 formato após o qual é permitido aumentar a taxa de amostragem. corda
samplingType Tipo de amostragem. 'adaptável'
'corrigido'

Microsoft.ApiManagement/service/loggers

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

Restrições:
Comprimento máximo =
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
Propriedades Propriedades do contrato de entidade do agente. LoggerContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/loggers@2017-03-01"