Microsoft.ApiManagement サービス/diagnostics 2019-01-01

• 最新の を する
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01

Bicep リソース定義

サービス/診断リソースの種類は、次を対象とする操作と共にデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/diagnostics リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2019-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysLog: 'string'
    backend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    enableHttpCorrelationHeaders: bool
    frontend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: 'string'
  }
}

プロパティ値

BodyDiagnosticSettings

名前	形容	価値
バイト	ログに記録する要求本文のバイト数。	int 制約： 最大値 = 8192

DiagnosticContractProperties

名前	形容	価値
alwaysLog	適用しないメッセージ サンプリング設定の種類を指定します。	'allErrors'
バックエンド	バックエンドへの受信/送信 HTTP メッセージの診断設定	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	Api Management サービスに送信される関連付けヘッダーを処理するかどうか。 Application Insights 診断にのみ適用されます。 既定値は true です。	bool
フロントエンド	ゲートウェイへの受信/送信 HTTP メッセージの診断設定。	PipelineDiagnosticSettings
httpCorrelationProtocol	Application Insights 診断に使用する関連付けプロトコルを設定します。	'Legacy' 'None' 'W3C'
loggerId	ターゲット ロガーのリソース ID。	string (必須)
サンプリング	診断のサンプリング設定。	SamplingSettings
冗漫	トレース ポリシーによって出力されるトレースに適用される詳細レベル。	'error' 'information' 'verbose'

HttpMessageDiagnostic

名前	形容	価値
体	本文ログの設定。	BodyDiagnosticSettings
ヘッダー	ログに記録する HTTP ヘッダーの配列。	string[]

Microsoft.ApiManagement/service/diagnostics

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 80 パターン = ^[^*#&+:<>?]+$ (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: サービス
プロパティ	診断エンティティ コントラクトのプロパティ。	DiagnosticContractProperties

PipelineDiagnosticSettings

名前	形容	価値
依頼	要求の診断設定。	HttpMessageDiagnostic の
応答	応答の診断設定。	HttpMessageDiagnostic の

SamplingSettings

名前	形容	価値
百分率	固定レート サンプリングのサンプリングレート。	int 制約： 最小値 = 0 最大値 = 100
samplingType	サンプリングの種類。	'fixed'

クイック スタートのサンプル

次のクイック スタート サンプルでは、このリソースの種類をデプロイします。

Bicep ファイル	形容
内部 API Management と Web App を使用した Application Gateway の	Azure Web アプリでホストされている Web API にサービスを提供する仮想ネットワーク (内部モード) API Management インスタンスにインターネット トラフィックをルーティングする Application Gateway。
App Gateway を使用して内部 VNet に API Management を作成する	このテンプレートでは、Azure Application Gateway によって保護されたプライベート ネットワーク上に Azure API Management のインスタンスを作成する方法を示します。

ARM テンプレート リソース定義

サービス/診断リソースの種類は、次を対象とする操作と共にデプロイできます。

• リソース グループの - リソース グループのデプロイ コマンド 参照

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/diagnostics リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2019-01-01",
  "name": "string",
  "properties": {
    "alwaysLog": "string",
    "backend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "enableHttpCorrelationHeaders": "bool",
    "frontend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "string"
  }
}

プロパティ値

BodyDiagnosticSettings

名前	形容	価値
バイト	ログに記録する要求本文のバイト数。	int 制約： 最大値 = 8192

DiagnosticContractProperties

名前	形容	価値
alwaysLog	適用しないメッセージ サンプリング設定の種類を指定します。	'allErrors'
バックエンド	バックエンドへの受信/送信 HTTP メッセージの診断設定	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	Api Management サービスに送信される関連付けヘッダーを処理するかどうか。 Application Insights 診断にのみ適用されます。 既定値は true です。	bool
フロントエンド	ゲートウェイへの受信/送信 HTTP メッセージの診断設定。	PipelineDiagnosticSettings
httpCorrelationProtocol	Application Insights 診断に使用する関連付けプロトコルを設定します。	'Legacy' 'None' 'W3C'
loggerId	ターゲット ロガーのリソース ID。	string (必須)
サンプリング	診断のサンプリング設定。	SamplingSettings
冗漫	トレース ポリシーによって出力されるトレースに適用される詳細レベル。	'error' 'information' 'verbose'

HttpMessageDiagnostic

名前	形容	価値
体	本文ログの設定。	BodyDiagnosticSettings
ヘッダー	ログに記録する HTTP ヘッダーの配列。	string[]

Microsoft.ApiManagement/service/diagnostics

名前	形容	価値
apiVersion	API のバージョン	'2019-01-01'
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 80 パターン = ^[^*#&+:<>?]+$ (必須)
プロパティ	診断エンティティ コントラクトのプロパティ。	DiagnosticContractProperties
種類	リソースの種類	'Microsoft.ApiManagement/service/diagnostics'

PipelineDiagnosticSettings

名前	形容	価値
依頼	要求の診断設定。	HttpMessageDiagnostic の
応答	応答の診断設定。	HttpMessageDiagnostic の

SamplingSettings

名前	形容	価値
百分率	固定レート サンプリングのサンプリングレート。	int 制約： 最小値 = 0 最大値 = 100
samplingType	サンプリングの種類。	'fixed'

クイック スタート テンプレート

次のクイック スタート テンプレートでは、このリソースの種類をデプロイします。

テンプレート	形容
内部 API Management と Web App を使用した Application Gateway の Azure にデプロイする	Azure Web アプリでホストされている Web API にサービスを提供する仮想ネットワーク (内部モード) API Management インスタンスにインターネット トラフィックをルーティングする Application Gateway。
App Gateway を使用して内部 VNet に API Management を作成する Azure にデプロイする	このテンプレートでは、Azure Application Gateway によって保護されたプライベート ネットワーク上に Azure API Management のインスタンスを作成する方法を示します。

Terraform (AzAPI プロバイダー) リソース定義

サービス/診断リソースの種類は、次を対象とする操作と共にデプロイできます。

• リソース グループの

各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。

リソースの形式

Microsoft.ApiManagement/service/diagnostics リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/diagnostics@2019-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "string"
      backend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      enableHttpCorrelationHeaders = bool
      frontend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "string"
    }
  })
}

プロパティ値

BodyDiagnosticSettings

名前	形容	価値
バイト	ログに記録する要求本文のバイト数。	int 制約： 最大値 = 8192

DiagnosticContractProperties

名前	形容	価値
alwaysLog	適用しないメッセージ サンプリング設定の種類を指定します。	'allErrors'
バックエンド	バックエンドへの受信/送信 HTTP メッセージの診断設定	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	Api Management サービスに送信される関連付けヘッダーを処理するかどうか。 Application Insights 診断にのみ適用されます。 既定値は true です。	bool
フロントエンド	ゲートウェイへの受信/送信 HTTP メッセージの診断設定。	PipelineDiagnosticSettings
httpCorrelationProtocol	Application Insights 診断に使用する関連付けプロトコルを設定します。	'Legacy' 'None' 'W3C'
loggerId	ターゲット ロガーのリソース ID。	string (必須)
サンプリング	診断のサンプリング設定。	SamplingSettings
冗漫	トレース ポリシーによって出力されるトレースに適用される詳細レベル。	'error' 'information' 'verbose'

HttpMessageDiagnostic

名前	形容	価値
体	本文ログの設定。	BodyDiagnosticSettings
ヘッダー	ログに記録する HTTP ヘッダーの配列。	string[]

Microsoft.ApiManagement/service/diagnostics

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 80 パターン = ^[^*#&+:<>?]+$ (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
プロパティ	診断エンティティ コントラクトのプロパティ。	DiagnosticContractProperties
種類	リソースの種類	"Microsoft.ApiManagement/service/diagnostics@2019-01-01"

PipelineDiagnosticSettings

名前	形容	価値
依頼	要求の診断設定。	HttpMessageDiagnostic の
応答	応答の診断設定。	HttpMessageDiagnostic の

SamplingSettings

名前	形容	価値
百分率	固定レート サンプリングのサンプリングレート。	int 制約： 最小値 = 0 最大値 = 100
samplingType	サンプリングの種類。	'fixed'