Microsoft.ApiManagement サービス/workspaces/diagnostics 2023-09-01-preview

  • [アーティクル]

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/diagnostics@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    alwaysLog: 'allErrors'
    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: 'fixed'
    }
    verbosity: 'string'
  }
}

プロパティ値

service/workspaces/diagnostics

名前 形容 価値
名前 リソース名

Bicepで子リソースの名前と種類 設定する方法を参照してください。		 string (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: ワークスペース
プロパティ 診断エンティティ コントラクトのプロパティ。 DiagnosticContractProperties

DiagnosticContractProperties

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

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

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

BodyDiagnosticSettings

名前 形容 価値
バイト ログに記録する要求本文のバイト数。 int

制約：
最大値 = 8192

DataMasking

名前 形容 価値
ヘッダー ヘッダーのマスク設定 DataMaskingEntity[]
queryParams URL クエリ パラメーターのマスク設定 DataMaskingEntity[]

DataMaskingEntity

名前 形容 価値
モード データ マスク モード。 'Hide'
'Mask'
価値 マスクするエンティティの名前 (ヘッダーやクエリ パラメーターの名前など)。 糸

SamplingSettings

名前 形容 価値
百分率 固定レート サンプリングのサンプリングレート。 int

制約：
最小値 = 0
最大値 = 100
samplingType サンプリングの種類。 'fixed'

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.ApiManagement/service/workspaces/diagnostics",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "alwaysLog": "allErrors",
    "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": "fixed"
    },
    "verbosity": "string"
  }
}

プロパティ値

service/workspaces/diagnostics

名前 形容 価値
種類 リソースの種類 'Microsoft.ApiManagement/service/workspaces/diagnostics'
apiVersion リソース API のバージョン '2023-09-01-preview'
名前 リソース名

JSON ARM テンプレートで子リソースの名前と型 設定する方法を参照してください。		 string (必須)
プロパティ 診断エンティティ コントラクトのプロパティ。 DiagnosticContractProperties

DiagnosticContractProperties

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

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

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

BodyDiagnosticSettings

名前 形容 価値
バイト ログに記録する要求本文のバイト数。 int

制約：
最大値 = 8192

DataMasking

名前 形容 価値
ヘッダー ヘッダーのマスク設定 DataMaskingEntity[]
queryParams URL クエリ パラメーターのマスク設定 DataMaskingEntity[]

DataMaskingEntity

名前 形容 価値
モード データ マスク モード。 'Hide'
'Mask'
価値 マスクするエンティティの名前 (ヘッダーやクエリ パラメーターの名前など)。 糸

SamplingSettings

名前 形容 価値
百分率 固定レート サンプリングのサンプリングレート。 int

制約：
最小値 = 0
最大値 = 100
samplingType サンプリングの種類。 'fixed'

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

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

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/diagnostics@2023-09-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "allErrors"
      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 = "fixed"
      }
      verbosity = "string"
    }
  })
}

プロパティ値

service/workspaces/diagnostics

名前 形容 価値
種類 リソースの種類 "Microsoft.ApiManagement/service/workspaces/diagnostics@2023-09-01-preview"
名前 リソース名 string (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: ワークスペース
プロパティ 診断エンティティ コントラクトのプロパティ。 DiagnosticContractProperties

DiagnosticContractProperties

名前 形容 価値
alwaysLog 適用しないメッセージ サンプリング設定の種類を指定します。 "allErrors"
バックエンド バックエンドへの受信/送信 HTTP メッセージの診断設定 PipelineDiagnosticSettings
フロントエンド ゲートウェイへの受信/送信 HTTP メッセージの診断設定。 PipelineDiagnosticSettings
httpCorrelationProtocol Application Insights 診断に使用する関連付けプロトコルを設定します。 "レガシ"
"なし"
"W3C"
logClientIp ClientIP をログに記録します。 既定値は false です。 bool
loggerId ターゲット ロガーのリソース ID。 string (必須)
メトリック 出力メトリック ポリシーを使用してカスタム メトリックを出力します。 Application Insights 診断設定にのみ適用されます。 bool
operationNameFormat Application Insights テレメトリの操作名の形式。 既定値は Name です。 "Name"
"Url"
サンプリング 診断のサンプリング設定。 SamplingSettings
冗漫 トレース ポリシーによって出力されるトレースに適用される詳細レベル。 "error"
"information"
"verbose"

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

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

BodyDiagnosticSettings

名前 形容 価値
バイト ログに記録する要求本文のバイト数。 int

制約：
最大値 = 8192

DataMasking

名前 形容 価値
ヘッダー ヘッダーのマスク設定 DataMaskingEntity[]
queryParams URL クエリ パラメーターのマスク設定 DataMaskingEntity[]

DataMaskingEntity

名前 形容 価値
モード データ マスク モード。 "非表示"
"Mask"
価値 マスクするエンティティの名前 (ヘッダーやクエリ パラメーターの名前など)。 糸

SamplingSettings

名前 形容 価値
百分率 固定レート サンプリングのサンプリングレート。 int

制約：
最小値 = 0
最大値 = 100
samplingType サンプリングの種類。 "fixed"