Portal Config - Create Or Update

서비스:: API Management

API 버전:: 2024-05-01

개발자 포털 구성을 만들거나 업데이트합니다.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalconfigs/{portalConfigId}?api-version=2024-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
portalConfigId	path	True	string minLength: 1 maxLength: 80	포털 구성 식별자입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management 서비스의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
If-Match	True	string	엔터티의 ETag입니다. ETag는 GET 요청의 헤더 응답에서 현재 엔터티 상태와 일치해야 합니다. 그렇지 않으면 무조건 업데이트의 경우 *여야 합니다.

요청 본문

Name	형식	Description
properties.cors	PortalConfigCorsProperties	개발자 포털 CORS(원본 간 리소스 공유) 설정입니다.
properties.csp	PortalConfigCspProperties	개발자 포털 CSP(콘텐츠 보안 정책) 설정입니다.
properties.delegation	PortalConfigDelegationProperties	개발자 포털 위임 설정입니다.
properties.enableBasicAuth	boolean	기본 인증 방법을 사용하거나 사용하지 않도록 설정합니다.
properties.signin	Signin
properties.signup	Signup

응답

Name	형식	Description
200 OK	PortalConfigContract	작업이 성공적으로 완료되었습니다.
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 흐름.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementCreatePortalConfig

샘플 요청

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default?api-version=2024-05-01


{
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

샘플 응답

상태 코드:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalconfigs/default",
  "type": "Microsoft.ApiManagement/service/portalconfigs",
  "name": "default",
  "properties": {
    "enableBasicAuth": true,
    "signin": {
      "require": false
    },
    "signup": {
      "termsOfService": {
        "text": "I agree to the service terms and conditions.",
        "requireConsent": false
      }
    },
    "delegation": {
      "delegateRegistration": false,
      "delegateSubscription": false,
      "delegationUrl": null,
      "validationKey": null
    },
    "csp": {
      "mode": "reportOnly",
      "reportUri": [
        "https://report.contoso.com"
      ],
      "allowedSources": [
        "*.contoso.com"
      ]
    },
    "cors": {
      "allowedOrigins": [
        "https://contoso.com"
      ]
    }
  }
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
PortalConfigContract	개발자 포털 구성 계약입니다.
PortalConfigCorsProperties	개발자 포털 CORS(원본 간 리소스 공유) 설정입니다.
PortalConfigCspProperties	개발자 포털 CSP(콘텐츠 보안 정책) 설정입니다.
PortalConfigDelegationProperties
PortalConfigTermsOfServiceProperties	서비스 계약 속성의 조건입니다.
PortalSettingsCspMode	개발자 포털 CSP(콘텐츠 보안 정책)의 모드입니다.
Signin
Signup

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

PortalConfigContract

Object

개발자 포털 구성 계약입니다.

Name	형식	Default value	Description
id	string		리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		리소스의 이름
properties.cors	PortalConfigCorsProperties		개발자 포털 CORS(원본 간 리소스 공유) 설정입니다.
properties.csp	PortalConfigCspProperties		개발자 포털 CSP(콘텐츠 보안 정책) 설정입니다.
properties.delegation	PortalConfigDelegationProperties		개발자 포털 위임 설정입니다.
properties.enableBasicAuth	boolean	True	기본 인증 방법을 사용하거나 사용하지 않도록 설정합니다.
properties.signin	Signin
properties.signup	Signup
type	string		리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

PortalConfigCorsProperties

Object

개발자 포털 CORS(원본 간 리소스 공유) 설정입니다.

Name	형식	Description
allowedOrigins	string[]	허용된 원본(예: `https://trusted.com`)

PortalConfigCspProperties

Object

개발자 포털 CSP(콘텐츠 보안 정책) 설정입니다.

Name	형식	Default value	Description
allowedSources	string[]		허용되는 원본(예: `*.trusted.com`, `trusted.com`, `https://`.
mode	PortalSettingsCspMode	disabled	개발자 포털 CSP(콘텐츠 보안 정책)의 모드입니다.
reportUri	string[]		브라우저에서 CSP 위반을 보고하는 데 사용하는 URL입니다.

PortalConfigDelegationProperties

Object

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

PortalConfigTermsOfServiceProperties

Object

서비스 계약 속성의 조건입니다.

Name	형식	Default value	Description
requireConsent	boolean	False	사용자에게 서비스 약관에 동의하도록 요청합니다.
text	string		서비스 약관 텍스트입니다.

PortalSettingsCspMode

열거형

개발자 포털 CSP(콘텐츠 보안 정책)의 모드입니다.

값	Description
enabled	브라우저는 허용된 원본과 일치하지 않는 요청을 차단합니다.
disabled	브라우저에서 원본 제한을 적용하지 않습니다.
reportOnly	브라우저는 허용된 원본과 일치하지 않는 요청을 차단하지 않고 보고합니다.

Object

Name	형식	Default value	Description
require	boolean	False	익명 사용자를 로그인 페이지로 리디렉션합니다.

Object

Name	형식	Description
termsOfService	PortalConfigTermsOfServiceProperties	서비스 약관 설정입니다.

다음을 통해 공유

Portal Config - Create Or Update

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

범위

예제

ApiManagementCreatePortalConfig

샘플 요청

샘플 응답

정의

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PortalConfigContract

PortalConfigCorsProperties

PortalConfigCspProperties

PortalConfigDelegationProperties

PortalConfigTermsOfServiceProperties

PortalSettingsCspMode

Signin

Signup