Workspaces - Set Outbound Gateway Rules
OAP(아웃바운드 액세스 보호)로 사용하도록 설정된 작업 영역에 대한 게이트웨이 규칙을 설정합니다. 이 API를 사용하면 작업 영역 관리자가 현재 작업 영역에서 허용되는 온-프레미스/Vnet 데이터 게이트웨이를 제어하는 아웃바운드 네트워크 통신 정책 집합을 정의, 대체 또는 재정의할 수 있습니다. 이 기능은 현재 미리 보기로 제공됩니다.
비고
이 API는 미리 보기 릴리스의 일부이며 평가 및 개발 목적으로만 제공됩니다. 피드백에 따라 변경 될 수 있으며 프로덕션 사용에는 권장되지 않습니다.
비고
아웃바운드 액세스 보호 규칙은 작업 영역의 네트워크 통신 정책에 outbound.publicAccessRules.defaultAction이 거부로 설정된 경우에만 적용됩니다. 작업 영역에서 OAP를 사용하도록 설정하지 않으면 아웃바운드 연결이 제한되지 않으므로 API가 실패합니다.
비고
이 API는 PUT 메서드를 사용하며 작업 영역에 대한 모든 아웃바운드 액세스 게이트웨이를 덮어씁니다. 요청 본문에 부분 정책이 제공되면 나머지 정책이 기본값으로 설정됩니다. 항상 먼저 가져오기를 실행하고 요청 본문에 전체 정책을 제공합니다.
Permissions
호출자에게는 관리자 작업 영역 역할이 있어야 합니다.
필요한 위임된 범위
작업 공간. 읽기쓰기. 전체
Microsoft Entra 지원 식별자
이 API는 이 섹션에 나열된 Microsoft ID 지원합니다.
| 아이덴티티 | Support |
|---|---|
| 사용자 | Yes |
| 서비스 주체 및 관리 ID | Yes |
인터페이스
PUT https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/networking/communicationPolicy/outbound/gateways
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
workspace
|
path | True |
string (uuid) |
업데이트할 작업 영역의 고유 식별자입니다. |
요청 본문
| Name | 형식 | Description |
|---|---|---|
| allowedGateways |
게이트웨이에 대한 아웃바운드 액세스 동작을 정의하는 규칙 목록입니다. |
|
| defaultAction |
허용된 목록 배열에 명시적으로 나열되지 않은 모든 게이트웨이의 기본 동작을 정의합니다. "허용"으로 설정하면 지정되지 않은 모든 게이트웨이가 기본적으로 허용됩니다. "거부"로 설정하면 지정되지 않은 모든 게이트웨이가 차단됩니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
요청이 성공적으로 완료되었습니다. 헤더 ETag: string |
|
| Other Status Codes |
일반적인 오류 코드:
|
예제
Set workspace outbound access protection gateway rule for example
샘플 요청
PUT https://api.fabric.microsoft.com/v1/workspaces/47482db6-4583-4672-86dd-999d0f8f4d7a/networking/communicationPolicy/outbound/gateways
{
"defaultAction": "Deny",
"allowedGateways": [
{
"id": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
},
{
"id": "25bac802-080d-4f73-8a42-1b406eb1fceb"
}
]
}
샘플 응답
ETag: 0f8fad5b-d9cb-469f-a165-70867728950e
정의
| Name | Description |
|---|---|
|
Error |
오류 관련 리소스 세부 정보 개체입니다. |
|
Error |
오류 응답입니다. |
|
Error |
오류 응답 세부 정보입니다. |
|
Gateway |
아웃바운드 게이트웨이에 대한 액세스 제어 동작을 정의합니다. 이 열거형은 기본적으로 아웃바운드 통신을 허용하거나 거부할지 여부를 지정하기 위해 defaultAction 필드에 사용됩니다. 이 형식을 사용하면 아웃바운드 액세스를 전역 및 게이트웨이별로 제어할 수 있으므로 안전하고 예측 가능한 네트워크 통신 정책을 적용할 수 있습니다. 시간이 지남에 따라 추가 게이트웨이 액세스 작업 유형을 추가할 수 있습니다. |
|
Gateway |
아웃바운드 통신에 허용되는 게이트웨이를 나타냅니다. 이 개체는 허용된Gateway 내에서 아웃바운드 액세스 권한을 명시적으로 부여하는 데 사용됩니다. |
|
Workspace |
네트워킹 통신 정책의 일부로 작업 영역에 대해 구성된 게이트웨이 아웃바운드 액세스 보호 규칙의 전체 집합을 나타냅니다. 이 개체는 아웃바운드 통신을 제어하는 게이트웨이 규칙을 정의합니다. |
ErrorRelatedResource
오류 관련 리소스 세부 정보 개체입니다.
| Name | 형식 | Description |
|---|---|---|
| resourceId |
string |
오류와 관련된 리소스 ID입니다. |
| resourceType |
string |
오류와 관련된 리소스의 형식입니다. |
ErrorResponse
오류 응답입니다.
| Name | 형식 | Description |
|---|---|---|
| errorCode |
string |
오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다. |
| message |
string |
사용자가 읽을 수 있는 오류 표현입니다. |
| moreDetails |
추가 오류 세부 정보 목록입니다. |
|
| relatedResource |
오류 관련 리소스 세부 정보입니다. |
|
| requestId |
string |
오류와 연결된 요청의 ID입니다. |
ErrorResponseDetails
오류 응답 세부 정보입니다.
| Name | 형식 | Description |
|---|---|---|
| errorCode |
string |
오류 조건에 대한 정보를 제공하여 서비스와 사용자 간의 표준화된 통신을 허용하는 특정 식별자입니다. |
| message |
string |
사용자가 읽을 수 있는 오류 표현입니다. |
| relatedResource |
오류 관련 리소스 세부 정보입니다. |
GatewayAccessActionType
아웃바운드 게이트웨이에 대한 액세스 제어 동작을 정의합니다. 이 열거형은 기본적으로 아웃바운드 통신을 허용하거나 거부할지 여부를 지정하기 위해 defaultAction 필드에 사용됩니다. 이 형식을 사용하면 아웃바운드 액세스를 전역 및 게이트웨이별로 제어할 수 있으므로 안전하고 예측 가능한 네트워크 통신 정책을 적용할 수 있습니다. 시간이 지남에 따라 추가 게이트웨이 액세스 작업 유형을 추가할 수 있습니다.
| 값 | Description |
|---|---|
| Allow |
아웃바운드 게이트웨이를 허용합니다. 기본 작업으로 사용되는 경우 모든 게이트웨이가 허용됩니다. |
| Deny |
아웃바운드 게이트웨이를 차단합니다. 기본 작업으로 사용되는 경우 명시적으로 허용되지 않는 한 모든 게이트웨이가 거부됩니다. |
GatewayAccessRuleMetadata
아웃바운드 통신에 허용되는 게이트웨이를 나타냅니다. 이 개체는 허용된Gateway 내에서 아웃바운드 액세스 권한을 명시적으로 부여하는 데 사용됩니다.
| Name | 형식 | Description |
|---|---|---|
| id |
string (uuid) |
허용되는 게이트웨이 ID입니다. |
WorkspaceOutboundGateways
네트워킹 통신 정책의 일부로 작업 영역에 대해 구성된 게이트웨이 아웃바운드 액세스 보호 규칙의 전체 집합을 나타냅니다. 이 개체는 아웃바운드 통신을 제어하는 게이트웨이 규칙을 정의합니다.
| Name | 형식 | Description |
|---|---|---|
| allowedGateways |
게이트웨이에 대한 아웃바운드 액세스 동작을 정의하는 규칙 목록입니다. |
|
| defaultAction |
허용된 목록 배열에 명시적으로 나열되지 않은 모든 게이트웨이의 기본 동작을 정의합니다. "허용"으로 설정하면 지정되지 않은 모든 게이트웨이가 기본적으로 허용됩니다. "거부"로 설정하면 지정되지 않은 모든 게이트웨이가 차단됩니다. |