Microsoft.ApiManagement service/apis/診断 2023-03-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

Bicep リソース定義

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

• リソース グループ - リソース グループのデプロイ コマンドを参照してください

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

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2023-03-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/apis/diagnostics

名前	説明	値
name	リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。	string (必須)
parent	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部の子リソース」を参照してください。	型のリソースのシンボル名: apis
properties	診断エンティティ コントラクトのプロパティ。	DiagnosticContractProperties

DiagnosticContractProperties

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

PipelineDiagnosticSettings

名前	説明	値
request	要求の診断設定。	HttpMessageDiagnostic
応答	応答の診断設定。	HttpMessageDiagnostic

HttpMessageDiagnostic

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

BodyDiagnosticSettings

名前	説明	値
バイト	ログに記録する要求本文のバイト数。	INT

DataMasking

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

DataMaskingEntity

名前	説明	値
mode	データ マスク モード。	'Hide' 'Mask'
value	マスクするエンティティの名前 (ヘッダーの名前やクエリ パラメーターなど)。	string

SamplingSettings

名前	説明	値
percentage	固定レート サンプリングのサンプリングレート。	INT
samplingType	サンプリングの種類。	'fixed'

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

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

• リソース グループ - リソース グループのデプロイ コマンドを参照してください

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

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2023-03-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/apis/diagnostics

名前	説明	値
type	リソースの種類	'Microsoft.ApiManagement/service/apis/診断'
apiVersion	リソース API のバージョン	'2023-03-01-preview'
name	リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。	string (必須)
properties	診断エンティティ コントラクトのプロパティ。	DiagnosticContractProperties

DiagnosticContractProperties

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

PipelineDiagnosticSettings

名前	説明	値
request	要求の診断設定。	HttpMessageDiagnostic
応答	応答の診断設定。	HttpMessageDiagnostic

HttpMessageDiagnostic

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

BodyDiagnosticSettings

名前	説明	値
バイト	ログに記録する要求本文のバイト数。	INT

DataMasking

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

DataMaskingEntity

名前	説明	値
mode	データ マスク モード。	'非表示' 'Mask'
value	マスクするエンティティの名前 (ヘッダーの名前やクエリ パラメーターなど)。	string

SamplingSettings

名前	説明	値
percentage	固定レート サンプリングのサンプリングレート。	INT
samplingType	サンプリングの種類。	'fixed'

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

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

• リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2023-03-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/apis/diagnostics

名前	説明	値
type	リソースの種類	"Microsoft.ApiManagement/service/apis/診断@2023-03-01-preview"
name	リソース名	string (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: apis
properties	診断エンティティ コントラクトのプロパティ。	DiagnosticContractProperties

DiagnosticContractProperties

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

PipelineDiagnosticSettings

名前	説明	値
request	要求の診断設定。	HttpMessageDiagnostic
応答	応答の診断設定。	HttpMessageDiagnostic

HttpMessageDiagnostic

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

BodyDiagnosticSettings

名前	説明	値
バイト	ログに記録する要求本文のバイト数。	INT

DataMasking

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

DataMaskingEntity

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

SamplingSettings

名前	説明	値
percentage	固定レート サンプリングのサンプリングレート。	INT
samplingType	サンプリングの種類。	"fixed"