Microsoft.ApiManagement 서비스/작업 영역/api/diagnostics 2023-09-01-preview

• 최신
• 2023-09-01-preview

Bicep 리소스 정의

다음을 대상으로 하는 작업으로 서비스/작업 영역/api/진단 리소스 유형을 배포할 수 있습니다.

• 리소스 그룹 - 리소스 그룹 배포 명령 참조

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/workspaces/api/diagnostics 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/apis/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/api/diagnostics

이름	묘사	값
이름	리소스 이름 Bicep자식 리소스의 이름과 형식을 설정하는 방법을 알아보세요.	string(필수)
부모	Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다. 자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.	형식의 리소스에 대한 기호 이름: api
속성	진단 엔터티 계약 속성입니다.	DiagnosticContractProperties

DiagnosticContractProperties

이름	묘사	값
alwaysLog	적용할 메시지 샘플링 설정 유형을 지정합니다.	'allErrors'
백 엔드	백 엔드로 들어오는/나가는 HTTP 메시지에 대한 진단 설정	PipelineDiagnosticSettings
프런트 엔드	게이트웨이로 들어오는/나가는 HTTP 메시지에 대한 진단 설정입니다.	PipelineDiagnosticSettings
httpCorrelationProtocol	Application Insights 진단에 사용할 상관 관계 프로토콜을 설정합니다.	'레거시' 'None' 'W3C'
logClientIp	ClientIP를 기록합니다. 기본값은 false입니다.	bool
loggerId	대상 로거의 리소스 ID입니다.	string(필수)
운율학	메트릭 내보내기 정책을 통해 사용자 지정 메트릭을 내보낸다. Application Insights 진단 설정에만 적용됩니다.	bool
operationNameFormat	Application Insights 원격 분석에 대한 작업 이름의 형식입니다. 기본값은 Name입니다.	'Name' 'Url'
견본 추출	진단에 대한 샘플링 설정입니다.	SamplingSettings
자세한 정보 표시	추적 정책에서 내보낸 추적에 적용되는 세부 정보 수준입니다.	'error' 'information' '자세한 정보 표시'

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'

ARM 템플릿 리소스 정의

다음을 대상으로 하는 작업으로 서비스/작업 영역/api/진단 리소스 유형을 배포할 수 있습니다.

• 리소스 그룹 - 리소스 그룹 배포 명령 참조

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/workspaces/api/diagnostics 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.

{
  "type": "Microsoft.ApiManagement/service/workspaces/apis/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/api/diagnostics

이름	묘사	값
형	리소스 종류	'Microsoft.ApiManagement/service/workspaces/api/diagnostics'
apiVersion	리소스 api 버전	'2023-09-01-preview'
이름	리소스 이름 JSON ARM 템플릿자식 리소스의 이름과 형식을 설정하는 방법을 참조하세요.	string(필수)
속성	진단 엔터티 계약 속성입니다.	DiagnosticContractProperties

DiagnosticContractProperties

이름	묘사	값
alwaysLog	적용할 메시지 샘플링 설정 유형을 지정합니다.	'allErrors'
백 엔드	백 엔드로 들어오는/나가는 HTTP 메시지에 대한 진단 설정	PipelineDiagnosticSettings
프런트 엔드	게이트웨이로 들어오는/나가는 HTTP 메시지에 대한 진단 설정입니다.	PipelineDiagnosticSettings
httpCorrelationProtocol	Application Insights 진단에 사용할 상관 관계 프로토콜을 설정합니다.	'레거시' 'None' 'W3C'
logClientIp	ClientIP를 기록합니다. 기본값은 false입니다.	bool
loggerId	대상 로거의 리소스 ID입니다.	string(필수)
운율학	메트릭 내보내기 정책을 통해 사용자 지정 메트릭을 내보낸다. Application Insights 진단 설정에만 적용됩니다.	bool
operationNameFormat	Application Insights 원격 분석에 대한 작업 이름의 형식입니다. 기본값은 Name입니다.	'Name' 'Url'
견본 추출	진단에 대한 샘플링 설정입니다.	SamplingSettings
자세한 정보 표시	추적 정책에서 내보낸 추적에 적용되는 세부 정보 수준입니다.	'error' 'information' '자세한 정보 표시'

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'

Terraform(AzAPI 공급자) 리소스 정의

다음을 대상으로 하는 작업으로 서비스/작업 영역/api/진단 리소스 유형을 배포할 수 있습니다.

• 리소스 그룹

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/workspaces/api/diagnostics 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.

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

이름	묘사	값
형	리소스 종류	"Microsoft.ApiManagement/service/workspaces/api/diagnostics@2023-09-01-preview"
이름	리소스 이름	string(필수)
parent_id	이 리소스의 부모인 리소스의 ID입니다.	형식의 리소스 ID: api
속성	진단 엔터티 계약 속성입니다.	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" "자세한 정보 표시"

PipelineDiagnosticSettings

이름	묘사	값
요청	요청에 대한 진단 설정입니다.	HttpMessageDiagnostic
응답	응답에 대한 진단 설정입니다.	HttpMessageDiagnostic

HttpMessageDiagnostic

이름	묘사	값
몸	본문 로깅 설정입니다.	BodyDiagnosticSettings
dataMasking	데이터 마스킹 설정입니다.	DataMasking
헤더	기록할 HTTP 헤더의 배열입니다.	string[]

BodyDiagnosticSettings

이름	묘사	값
바이트	기록할 요청 본문 바이트 수입니다.	int 제약 조건: 최대값 = 8192

DataMasking

이름	묘사	값
헤더	헤더에 대한 마스킹 설정	dataMaskingEntity[]
queryParams	Url 쿼리 매개 변수에 대한 마스킹 설정	dataMaskingEntity[]

DataMaskingEntity

이름	묘사	값
모드	데이터 마스킹 모드입니다.	"숨기기" "마스크"
값	마스킹할 엔터티의 이름(예: 헤더 또는 쿼리 매개 변수의 이름)입니다.	문자열

SamplingSettings

이름	묘사	값
백분율	고정 비율 샘플링에 대한 샘플링 비율입니다.	int 제약 조건: 최소값 = 0 최대값 = 100
samplingType	샘플링 유형입니다.	"fixed"