Partilhar via


Serviço Microsoft.ApiManagement/loggers 2017-03-01

Definição de recursos do bíceps

O tipo de recurso service/loggers 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/loggers, adicione o seguinte Bicep 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

Designação Descrição Valor
Credenciais O nome e a cadeia de conexão SendRule do hub de eventos para o registrador azureEventHub.
Chave de instrumentação para o registrador applicationInsights.
LoggerContractPropertiesCredentials (obrigatório)
Descrição Descrição do logger. string

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

LoggerContractPropertiesCredentials

Designação Descrição Valor

LoggerAmostragemContrato

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

LoggerAmostragemPropriedades

Designação Descrição Valor
avaliaçãoIntervalo Intervalo de reavaliação da taxa em formato ISO8601. string
inicialPercentagem Taxa de amostragem inicial. Int
maxPercentagem Taxa máxima de amostragem permitida. Int
maxTelemetryItemsPerSecond Taxa alvo de itens de telemetria por segundo. Int
minPercentagem Taxa mínima de amostragem permitida. Int
movingAverageRatio Ração de média móvel atribuída ao valor mais recente. Int
percentagem Taxa de amostragem para amostragem de taxa fixa. Int
percentagemDiminuirTempo limite Duração em ISO8601 formato após o qual é permitido reduzir a taxa de amostragem. string
percentageIncreaseTimeout Duração em ISO8601 formato após o qual é permitido aumentar a taxa de amostragem. string
samplingType Tipo de amostragem. 'Adaptativo'
'Fixo'

Microsoft.ApiManagement/service/loggers

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento máximo = 256
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 do registrador. 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
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.
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 ARM

O tipo de recurso service/loggers 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/loggers, adicione o seguinte JSON ao seu 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

Designação Descrição Valor
Credenciais O nome e a cadeia de conexão SendRule do hub de eventos para o registrador azureEventHub.
Chave de instrumentação para o registrador applicationInsights.
LoggerContractPropertiesCredentials (obrigatório)
Descrição Descrição do logger. string

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

LoggerContractPropertiesCredentials

Designação Descrição Valor

LoggerAmostragemContrato

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

LoggerAmostragemPropriedades

Designação Descrição Valor
avaliaçãoIntervalo Intervalo de reavaliação da taxa em formato ISO8601. string
inicialPercentagem Taxa de amostragem inicial. Int
maxPercentagem Taxa máxima de amostragem permitida. Int
maxTelemetryItemsPerSecond Taxa alvo de itens de telemetria por segundo. Int
minPercentagem Taxa mínima de amostragem permitida. Int
movingAverageRatio Ração de média móvel atribuída ao valor mais recente. Int
percentagem Taxa de amostragem para amostragem de taxa fixa. Int
percentagemDiminuirTempo limite Duração em ISO8601 formato após o qual é permitido reduzir a taxa de amostragem. string
percentageIncreaseTimeout Duração em ISO8601 formato após o qual é permitido aumentar a taxa de amostragem. string
samplingType Tipo de amostragem. 'Adaptativo'
'Fixo'

Microsoft.ApiManagement/service/loggers

Designação Descrição Valor
apiVersion A versão api '2017-03-01'
Designação O nome do recurso string

Restrições:
Comprimento máximo = 256
Padrão = ^[^*#&+:<>?]+$ (obrigatório)
propriedades Propriedades do contrato da entidade do registrador. 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
Application Gateway com gerenciamento interno de API e de aplicativos Web

Implantar no Azure
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

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 a Porta da Frente do Azure em frente ao de 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 recursos Terraform (provedor AzAPI)

O tipo de recurso service/loggers 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/loggers, adicione o seguinte Terraform 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

Designação Descrição Valor
Credenciais O nome e a cadeia de conexão SendRule do hub de eventos para o registrador azureEventHub.
Chave de instrumentação para o registrador applicationInsights.
LoggerContractPropertiesCredentials (obrigatório)
Descrição Descrição do logger. string

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

LoggerContractPropertiesCredentials

Designação Descrição Valor

LoggerAmostragemContrato

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

LoggerAmostragemPropriedades

Designação Descrição Valor
avaliaçãoIntervalo Intervalo de reavaliação da taxa em formato ISO8601. string
inicialPercentagem Taxa de amostragem inicial. Int
maxPercentagem Taxa máxima de amostragem permitida. Int
maxTelemetryItemsPerSecond Taxa alvo de itens de telemetria por segundo. Int
minPercentagem Taxa mínima de amostragem permitida. Int
movingAverageRatio Ração de média móvel atribuída ao valor mais recente. Int
percentagem Taxa de amostragem para amostragem de taxa fixa. Int
percentagemDiminuirTempo limite Duração em ISO8601 formato após o qual é permitido reduzir a taxa de amostragem. string
percentageIncreaseTimeout Duração em ISO8601 formato após o qual é permitido aumentar a taxa de amostragem. string
samplingType Tipo de amostragem. 'Adaptativo'
'Fixo'

Microsoft.ApiManagement/service/loggers

Designação Descrição Valor
Designação O nome do recurso string

Restrições:
Comprimento máximo = 256
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 do registrador. LoggerContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/loggers@2017-03-01"