Microsoft.ApiManagement 서비스/api/diagnostics 2018-06-01-preview

• 최신
• 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/진단 리소스 유형을 배포할 수 있습니다.

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

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

리소스 형식

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

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview' = {
  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'
        ]
      }
    }
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
  }
}

속성 값

BodyDiagnosticSettings

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

DiagnosticContractProperties

이름	묘사	값
alwaysLog	적용할 메시지 샘플링 설정 유형을 지정합니다.	'allErrors'
백 엔드	백 엔드로 들어오는/나가는 HTTP 메시지에 대한 진단 설정	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	Api Management Service에 오는 상관 관계 헤더를 처리할지 여부입니다. Application Insights 진단에만 적용됩니다. 기본값은 true입니다.	bool
프런트 엔드	게이트웨이로 들어오는/나가는 HTTP 메시지에 대한 진단 설정입니다.	PipelineDiagnosticSettings
loggerId	대상 로거의 리소스 ID입니다.	string(필수)
견본 추출	진단에 대한 샘플링 설정입니다.	SamplingSettings

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/api/diagnostics

이름	묘사	값
이름	리소스 이름	문자열 제약 조건: 최소 길이 = 1 최대 길이 = 80 패턴 = ^[^*#&+:<>?]+$(필수)
부모	Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다. 자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.	형식 리소스의 기호 이름: 서비스/api
속성	진단 엔터티 계약 속성입니다.	DiagnosticContractProperties

PipelineDiagnosticSettings

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

SamplingSettings

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

ARM 템플릿 리소스 정의

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

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

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

리소스 형식

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

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2018-06-01-preview",
  "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" ]
      }
    },
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    }
  }
}

속성 값

BodyDiagnosticSettings

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

DiagnosticContractProperties

이름	묘사	값
alwaysLog	적용할 메시지 샘플링 설정 유형을 지정합니다.	'allErrors'
백 엔드	백 엔드로 들어오는/나가는 HTTP 메시지에 대한 진단 설정	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	Api Management Service에 오는 상관 관계 헤더를 처리할지 여부입니다. Application Insights 진단에만 적용됩니다. 기본값은 true입니다.	bool
프런트 엔드	게이트웨이로 들어오는/나가는 HTTP 메시지에 대한 진단 설정입니다.	PipelineDiagnosticSettings
loggerId	대상 로거의 리소스 ID입니다.	string(필수)
견본 추출	진단에 대한 샘플링 설정입니다.	SamplingSettings

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/api/diagnostics

이름	묘사	값
apiVersion	api 버전	'2018-06-01-preview'
이름	리소스 이름	문자열 제약 조건: 최소 길이 = 1 최대 길이 = 80 패턴 = ^[^*#&+:<>?]+$(필수)
속성	진단 엔터티 계약 속성입니다.	DiagnosticContractProperties
형	리소스 종류	'Microsoft.ApiManagement/service/api/diagnostics'

PipelineDiagnosticSettings

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

SamplingSettings

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

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

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

• 리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview"
  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"
          ]
        }
      }
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
    }
  })
}

속성 값

BodyDiagnosticSettings

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

DiagnosticContractProperties

이름	묘사	값
alwaysLog	적용할 메시지 샘플링 설정 유형을 지정합니다.	'allErrors'
백 엔드	백 엔드로 들어오는/나가는 HTTP 메시지에 대한 진단 설정	PipelineDiagnosticSettings
enableHttpCorrelationHeaders	Api Management Service에 오는 상관 관계 헤더를 처리할지 여부입니다. Application Insights 진단에만 적용됩니다. 기본값은 true입니다.	bool
프런트 엔드	게이트웨이로 들어오는/나가는 HTTP 메시지에 대한 진단 설정입니다.	PipelineDiagnosticSettings
loggerId	대상 로거의 리소스 ID입니다.	string(필수)
견본 추출	진단에 대한 샘플링 설정입니다.	SamplingSettings

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/api/diagnostics

이름	묘사	값
이름	리소스 이름	문자열 제약 조건: 최소 길이 = 1 최대 길이 = 80 패턴 = ^[^*#&+:<>?]+$(필수)
parent_id	이 리소스의 부모인 리소스의 ID입니다.	유형의 리소스에 대한 ID: 서비스/api
속성	진단 엔터티 계약 속성입니다.	DiagnosticContractProperties
형	리소스 종류	"Microsoft.ApiManagement/service/api/diagnostics@2018-06-01-preview"

PipelineDiagnosticSettings

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

SamplingSettings

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