다음을 통해 공유

Microsoft.ApiManagement 서비스/portalconfigs 2022-08-01

  • 아티클

Bicep 리소스 정의

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

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

리소스 형식

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

resource symbolicname 'Microsoft.ApiManagement/service/portalconfigs@2022-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    cors: {
      allowedOrigins: [
        'string'
      ]
    }
    csp: {
      allowedSources: [
        'string'
      ]
      mode: 'string'
      reportUri: [
        'string'
      ]
    }
    delegation: {
      delegateRegistration: bool
      delegateSubscription: bool
      delegationUrl: 'string'
      validationKey: 'string'
    }
    enableBasicAuth: bool
    signin: {
      require: bool
    }
    signup: {
      termsOfService: {
        requireConsent: bool
        text: 'string'
      }
    }
  }
}

속성 값

service/portalconfigs

이름 묘사 값
이름 리소스 이름

Bicep자식 리소스의 이름과 형식을 설정하는 방법을 알아보세요.		 string(필수)
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.		 형식의 리소스에 대한 기호 이름: 서비스
속성 개발자 포털 구성 계약 속성입니다. PortalConfigProperties

PortalConfigProperties

이름 묘사 값
cors 개발자 포털 CORS(원본 간 리소스 공유) 설정입니다. PortalConfigCorsProperties
csp 개발자 포털 CSP(콘텐츠 보안 정책) 설정입니다. PortalConfigCspProperties
대표단 개발자 포털 위임 설정입니다. PortalConfigDelegationProperties
enableBasicAuth 기본 인증 방법을 사용하거나 사용하지 않도록 설정합니다. bool
로그인 PortalConfigPropertiesSignin
등록 PortalConfigPropertiesSignup

PortalConfigCorsProperties

이름 묘사 값
allowedOrigins 허용된 원본(예: https://trusted.com) string[]

PortalConfigCspProperties

이름 묘사 값
allowedSources 허용되는 원본(예: *.trusted.com, trusted.com, https://. string[]
모드 개발자 포털 CSP(콘텐츠 보안 정책)의 모드입니다. 'disabled'
'enabled'
'reportOnly'
reportUri 브라우저에서 CSP 위반을 보고하는 데 사용하는 URL입니다. string[]

PortalConfigDelegationProperties

이름 묘사 값
delegateRegistration 사용자 등록에 대한 위임을 사용하거나 사용하지 않도록 설정합니다. bool
delegateSubscription 제품 구독에 대한 위임을 사용하거나 사용하지 않도록 설정합니다. bool
delegationUrl 위임 엔드포인트 URL입니다. 문자열
validationKey 요청이 Azure API Management 서비스에서 시작되도록 하는 base64로 인코딩된 유효성 검사 키입니다. 문자열

제약 조건:
중요한 값입니다. 보안 매개 변수로 전달합니다.

PortalConfigPropertiesSignin

이름 묘사 값
요구하다 익명 사용자를 로그인 페이지로 리디렉션합니다. bool

PortalConfigPropertiesSignup

이름 묘사 값
termsOfService 서비스 약관 설정입니다. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

이름 묘사 값
requireConsent 사용자에게 서비스 약관에 동의하도록 요청합니다. bool
문자 메시지 서비스 약관 텍스트입니다. 문자열

ARM 템플릿 리소스 정의

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

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

리소스 형식

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

{
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "apiVersion": "2022-08-01",
  "name": "string",
  "properties": {
    "cors": {
      "allowedOrigins": [ "string" ]
    },
    "csp": {
      "allowedSources": [ "string" ],
      "mode": "string",
      "reportUri": [ "string" ]
    },
    "delegation": {
      "delegateRegistration": "bool",
      "delegateSubscription": "bool",
      "delegationUrl": "string",
      "validationKey": "string"
    },
    "enableBasicAuth": "bool",
    "signin": {
      "require": "bool"
    },
    "signup": {
      "termsOfService": {
        "requireConsent": "bool",
        "text": "string"
      }
    }
  }
}

속성 값

service/portalconfigs

이름 묘사 값
형 리소스 종류 'Microsoft.ApiManagement/service/portalconfigs'
apiVersion 리소스 api 버전 '2022-08-01'
이름 리소스 이름

JSON ARM 템플릿자식 리소스의 이름과 형식을 설정하는 방법을 참조하세요.		 string(필수)
속성 개발자 포털 구성 계약 속성입니다. PortalConfigProperties

PortalConfigProperties

이름 묘사 값
cors 개발자 포털 CORS(원본 간 리소스 공유) 설정입니다. PortalConfigCorsProperties
csp 개발자 포털 CSP(콘텐츠 보안 정책) 설정입니다. PortalConfigCspProperties
대표단 개발자 포털 위임 설정입니다. PortalConfigDelegationProperties
enableBasicAuth 기본 인증 방법을 사용하거나 사용하지 않도록 설정합니다. bool
로그인 PortalConfigPropertiesSignin
등록 PortalConfigPropertiesSignup

PortalConfigCorsProperties

이름 묘사 값
allowedOrigins 허용된 원본(예: https://trusted.com) string[]

PortalConfigCspProperties

이름 묘사 값
allowedSources 허용되는 원본(예: *.trusted.com, trusted.com, https://. string[]
모드 개발자 포털 CSP(콘텐츠 보안 정책)의 모드입니다. 'disabled'
'enabled'
'reportOnly'
reportUri 브라우저에서 CSP 위반을 보고하는 데 사용하는 URL입니다. string[]

PortalConfigDelegationProperties

이름 묘사 값
delegateRegistration 사용자 등록에 대한 위임을 사용하거나 사용하지 않도록 설정합니다. bool
delegateSubscription 제품 구독에 대한 위임을 사용하거나 사용하지 않도록 설정합니다. bool
delegationUrl 위임 엔드포인트 URL입니다. 문자열
validationKey 요청이 Azure API Management 서비스에서 시작되도록 하는 base64로 인코딩된 유효성 검사 키입니다. 문자열

제약 조건:
중요한 값입니다. 보안 매개 변수로 전달합니다.

PortalConfigPropertiesSignin

이름 묘사 값
요구하다 익명 사용자를 로그인 페이지로 리디렉션합니다. bool

PortalConfigPropertiesSignup

이름 묘사 값
termsOfService 서비스 약관 설정입니다. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

이름 묘사 값
requireConsent 사용자에게 서비스 약관에 동의하도록 요청합니다. bool
문자 메시지 서비스 약관 텍스트입니다. 문자열

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

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

  • 리소스 그룹

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

리소스 형식

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/portalconfigs@2022-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      cors = {
        allowedOrigins = [
          "string"
        ]
      }
      csp = {
        allowedSources = [
          "string"
        ]
        mode = "string"
        reportUri = [
          "string"
        ]
      }
      delegation = {
        delegateRegistration = bool
        delegateSubscription = bool
        delegationUrl = "string"
        validationKey = "string"
      }
      enableBasicAuth = bool
      signin = {
        require = bool
      }
      signup = {
        termsOfService = {
          requireConsent = bool
          text = "string"
        }
      }
    }
  })
}

속성 값

service/portalconfigs

이름 묘사 값
형 리소스 종류 "Microsoft.ApiManagement/service/portalconfigs@2022-08-01"
이름 리소스 이름 string(필수)
parent_id 이 리소스의 부모인 리소스의 ID입니다. 유형의 리소스에 대한 ID: 서비스
속성 개발자 포털 구성 계약 속성입니다. PortalConfigProperties

PortalConfigProperties

이름 묘사 값
cors 개발자 포털 CORS(원본 간 리소스 공유) 설정입니다. PortalConfigCorsProperties
csp 개발자 포털 CSP(콘텐츠 보안 정책) 설정입니다. PortalConfigCspProperties
대표단 개발자 포털 위임 설정입니다. PortalConfigDelegationProperties
enableBasicAuth 기본 인증 방법을 사용하거나 사용하지 않도록 설정합니다. bool
로그인 PortalConfigPropertiesSignin
등록 PortalConfigPropertiesSignup

PortalConfigCorsProperties

이름 묘사 값
allowedOrigins 허용된 원본(예: https://trusted.com) string[]

PortalConfigCspProperties

이름 묘사 값
allowedSources 허용되는 원본(예: *.trusted.com, trusted.com, https://. string[]
모드 개발자 포털 CSP(콘텐츠 보안 정책)의 모드입니다. "disabled"
"enabled"
"reportOnly"
reportUri 브라우저에서 CSP 위반을 보고하는 데 사용하는 URL입니다. string[]

PortalConfigDelegationProperties

이름 묘사 값
delegateRegistration 사용자 등록에 대한 위임을 사용하거나 사용하지 않도록 설정합니다. bool
delegateSubscription 제품 구독에 대한 위임을 사용하거나 사용하지 않도록 설정합니다. bool
delegationUrl 위임 엔드포인트 URL입니다. 문자열
validationKey 요청이 Azure API Management 서비스에서 시작되도록 하는 base64로 인코딩된 유효성 검사 키입니다. 문자열

제약 조건:
중요한 값입니다. 보안 매개 변수로 전달합니다.

PortalConfigPropertiesSignin

이름 묘사 값
요구하다 익명 사용자를 로그인 페이지로 리디렉션합니다. bool

PortalConfigPropertiesSignup

이름 묘사 값
termsOfService 서비스 약관 설정입니다. PortalConfigTermsOfServiceProperties

PortalConfigTermsOfServiceProperties

이름 묘사 값
requireConsent 사용자에게 서비스 약관에 동의하도록 요청합니다. bool
문자 메시지 서비스 약관 텍스트입니다. 문자열