다음을 통해 공유

Domains - Update Domain

  • 참조
서비스:
Admin
API 버전:
v1

메모

이 API는 미리 보기로 제공됩니다.

지정된 도메인 정보를 업데이트합니다.

권한을

호출자는 패브릭 관리자여야 합니다.

필요한 위임된 범위

Tenant.ReadWrite.All.

제한

보안 주체당 1분당 최대 25개 요청

Microsoft Entra 지원 ID

이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.

신원 지원
사용자 예
서비스 주체 및 관리 ID 예

인터페이스

PATCH https://api.fabric.microsoft.com/v1/admin/domains/{domainId}

URI 매개 변수

Name In(다음 안에) 필수 형식 Description
domainId
 path True

string

uuid

도메인 ID입니다.

요청 본문

Name 형식 Description
contributorsScope

ContributorsScopeType

도메인 기여자 범위입니다.
description

string

도메인 설명입니다. 설명에는 256자를 초과할 수 없습니다.
displayName

string

도메인 표시 이름입니다. 표시 이름에는 40자를 초과할 수 없습니다.

응답

Name 형식 Description
200 OK

Domain

요청이 성공적으로 완료되었습니다.
Other Status Codes

ErrorResponse

일반적인 오류 코드:

  • UnknownError - 오류가 발생했습니다.

  • EntityConflict - 도메인 표시 이름이 이미 있으므로 도메인을 업데이트하지 못했습니다.

예제

Update a domain example

샘플 요청

PATCH https://api.fabric.microsoft.com/v1/admin/domains/97dd1d38-a4c6-41ed-bc4f-1e383f8ddd0f

{
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "contributorsScope": "SpecificUsersAndGroups"
}

샘플 응답

상태 코드:
200 
{
  "id": "f2f6a374-789e-4d1d-9cc7-6e0b934fc529",
  "displayName": "Domain's new name",
  "description": "Domain's new description",
  "parentDomainId": null,
  "contributorsScope": "SpecificUsersAndGroups"
}

정의

Name Description
ContributorsScopeType

기여자 범위입니다. 추가 기여자 범위는 시간이 지남에 따라 추가될 수 있습니다.
Domain

도메인 또는 하위 도메인을 나타냅니다.
ErrorRelatedResource

오류 관련 리소스 세부 정보 개체입니다.
ErrorResponse

오류 응답입니다.
ErrorResponseDetails

오류 응답 세부 정보입니다.
UpdateDomainRequest

도메인을 업데이트하기 위한 요청 페이로드입니다.

ContributorsScopeType

Enumeration

기여자 범위입니다. 추가 기여자 범위는 시간이 지남에 따라 추가될 수 있습니다.

값 Description
AdminsOnly

테넌트 및 도메인 관리자만 해당합니다.
AllTenant

모든 테넌트의 사용자입니다.
SpecificUsersAndGroups

특정 사용자 및 그룹.

Domain

Object

도메인 또는 하위 도메인을 나타냅니다.

Name 형식 Description
contributorsScope

ContributorsScopeType

도메인 기여자 범위입니다.
description

string

도메인에 대한 설명입니다.
displayName

string

도메인의 이름입니다.
id

string

uuid

도메인 개체 ID입니다.
parentDomainId

string

uuid

도메인 부모 개체 ID입니다.

ErrorRelatedResource

Object

오류 관련 리소스 세부 정보 개체입니다.

Name 형식 Description
resourceId

string

오류와 관련된 리소스 ID입니다.
resourceType

string

오류와 관련된 리소스의 형식입니다.

ErrorResponse

Object

오류 응답입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
moreDetails

ErrorResponseDetails[]

추가 오류 세부 정보 목록입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.
requestId

string

오류와 연결된 요청의 ID입니다.

ErrorResponseDetails

Object

오류 응답 세부 정보입니다.

Name 형식 Description
errorCode

string

오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다.
message

string

사용자가 읽을 수 있는 오류 표현입니다.
relatedResource

ErrorRelatedResource

오류 관련 리소스 세부 정보입니다.

UpdateDomainRequest

Object

도메인을 업데이트하기 위한 요청 페이로드입니다.

Name 형식 Description
contributorsScope

ContributorsScopeType

도메인 기여자 범위입니다.
description

string

도메인 설명입니다. 설명에는 256자를 초과할 수 없습니다.
displayName

string

도메인 표시 이름입니다. 표시 이름에는 40자를 초과할 수 없습니다.