Workspaces - List Networking Communication Policies

Служба:
Admin
Версия API:
v1

Возвращает параметры политики сетевого взаимодействия для списка рабочих областей, включенных с защитой входящего или исходящего доступа.
Этот API поддерживает разбиение на страницы с помощью маркера продолжения, предоставленного в ответе, можно получить следующий набор записей.

Permissions

Вызывающий объект должен быть администратором Fabric или пройти проверку подлинности с помощью субъекта-службы.

Обязательные делегированные области

Tenant.Read.All или Tenant.ReadWrite.All

Идентификаторы, поддерживаемые Microsoft Entra

Этот API поддерживает идентичности Microsoft, перечисленные в этом разделе.

Идентичность Support
User Да
Представитель службы и управляемые удостоверения Да

Интерфейс

GET https://api.fabric.microsoft.com/v1/admin/workspaces/networking/communicationpolicies
С использованием необязательных параметров: 
GET https://api.fabric.microsoft.com/v1/admin/workspaces/networking/communicationpolicies?continuationToken={continuationToken}

Параметры URI

Имя В Обязательно Тип Описание
continuationToken
 query

string

Маркер получения следующей страницы результатов.

Ответы

Имя Тип Описание
200 OK

NetworkCommunicationPolicies

Операция прошла успешно.
429 Too Many Requests

ErrorResponse

Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий Retry-After в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов.

Заголовки

Retry-After: integer
Other Status Codes

ErrorResponse

Распространенные коды ошибок:

  • НедостаточноPrivileges — вызывающий объект не имеет разрешений на вызов API.

Примеры

Get network communication policy settings for list of workspaces enabled with either Inbound or Outbound Access Protection for example

Образец запроса

GET https://api.fabric.microsoft.com/v1/admin/workspaces/networking/communicationpolicies

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "workspaceId": "fa9ad228-3e6b-44d4-b5f4-e275f337afa9",
      "inbound": {
        "publicAccessRules": {
          "defaultAction": "Deny"
        }
      },
      "outbound": {
        "publicAccessRules": {
          "defaultAction": "Deny"
        },
        "connections": {
          "defaultAction": "Deny",
          "rules": [
            {
              "connectionType": "SQL",
              "defaultAction": "Deny",
              "allowedEndpoints": [
                {
                  "hostnamePattern": "*.microsoft.com"
                }
              ]
            },
            {
              "connectionType": "lakehouse",
              "defaultAction": "Deny",
              "allowedWorkspaces": [
                {
                  "workspaceId": "91c5ae74-e82d-4dd3-bfeb-6b1814030123"
                }
              ]
            },
            {
              "connectionType": "Maria DB",
              "defaultAction": "Allow"
            }
          ]
        },
        "gateways": {
          "defaultAction": "Deny",
          "allowedGateways": [
            {
              "id": "17d8929d-ab32-46d1-858b-fdea74e93bf2"
            }
          ]
        },
        "git": {
          "defaultAction": "Deny"
        }
      }
    }
  ],
  "continuationUri": "https://api.fabric.microsoft.com/v1/admin/workspaces/networking/communicationpolicies?continuationToken=eyJMYXN0U2VlbkNvbm5lY3Rpb25JZCI6NX0=",
  "continuationToken": "eyJMYXN0U2VlbkNvbm5lY3Rpb25JZCI6NX0="
}

Определения

Имя Описание
ConnectionAccessActionType

Определяет поведение управления доступом для исходящих подключений. Эта перечисление используется для поля defaultAction, чтобы указать, следует ли разрешить исходящее взаимодействие или запретить по умолчанию. Этот тип обеспечивает как глобальный, так и определенный для подключения контроль над исходящим доступом, помогая применять безопасные и прогнозируемые политики сетевой связи. С течением времени могут добавляться дополнительные типы действий доступа к подключению.
ConnectionRuleEndpointMetadata

Представляет одно правило исключения на уровне конечной точки, позволяющее исходящее взаимодействие с определенным внешним доменом или узлом. Этот объект используется в массиве allowedEndpoints правила подключения, чтобы явно авторизовать исходящий доступ к доверенным конечным точкам для заданного типа подключения. Это применимо только к типам подключений, поддерживающим фильтрацию на основе конечных точек (например, SQL, MySQL, Web и т. д.).
ConnectionRuleWorkspaceMetadata

Представляет правило исключения на уровне рабочей области, позволяющее исходящее взаимодействие с определенной рабочей областью для заданного типа подключения. Этот объект используется в массиве allowedWorkspaces правила подключения, чтобы явно авторизовать доступ между рабочими областями. Это применимо только к типам подключений, поддерживающим фильтрацию на основе рабочей области, например Lakehouse, Warehouse, FabricSql и PowerPlatformDataflows.
ErrorRelatedResource

Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse

Ответ на ошибку.
ErrorResponseDetails

Сведения об ответе на ошибку.
GatewayAccessActionType

Определяет поведение управления доступом для исходящих шлюзов. Эта перечисление используется для поля defaultAction, чтобы указать, следует ли разрешить исходящее взаимодействие или запретить по умолчанию. Этот тип обеспечивает как глобальный, так и определенный шлюз контроль над исходящим доступом, что помогает применять безопасные и прогнозируемые политики сетевого взаимодействия. С течением времени могут добавляться дополнительные типы действий доступа к шлюзу.
GatewayAccessRuleMetadata

Представляет шлюз, разрешенный для исходящего взаимодействия. Этот объект используется в разрешенныхGateways для явной авторизации исходящего доступа.
NetworkAccessRule

Политика по умолчанию для доступа к рабочей области из общедоступных сетей. Если опущено из текста запроса PUT, это поле по умолчанию имеет Allowзначение , которое может непреднамеренно открыть сетевой доступ. Всегда явно укажите это поле в каждом тексте запроса PUT.
NetworkCommunicationPolicies

Параметры политики сетевого обмена данными для списка рабочих областей, включенных с защитой входящего или исходящего доступа.
NetworkCommunicationPolicyDetails

Представляет сведения о параметрах политики сетевого взаимодействия для каждой рабочей области.
NetworkCommunicationPolicyInboundDetails

Представляет сведения о параметрах политики сетевого взаимодействия для каждой рабочей области.
NetworkCommunicationPolicyOutboundDetails

Представляет сведения о параметрах политики сетевого взаимодействия для каждой рабочей области.
NetworkRules

Политика, определяющая доступ к рабочей области или из общедоступных сетей.
OutboundConnectionRule

Определяет правило исходящего доступа для конкретного облачного подключения.
WorkspaceOutboundConnections

Представляет полный набор правил подключения к облачному подключению для исходящего доступа, настроенных для рабочей области в рамках политики сетевого взаимодействия. Этот объект определяет правила подключения, определяющие, какие внешние конечные точки и рабочие области разрешены или запрещены для исходящего взаимодействия.
WorkspaceOutboundGateways

Представляет полный набор правил защиты исходящего доступа шлюза, настроенных для рабочей области в рамках политики сетевой связи. Этот объект определяет правила шлюза, которые управляют исходящим обменом данными

ConnectionAccessActionType

Перечисление

Определяет поведение управления доступом для исходящих подключений. Эта перечисление используется для поля defaultAction, чтобы указать, следует ли разрешить исходящее взаимодействие или запретить по умолчанию. Этот тип обеспечивает как глобальный, так и определенный для подключения контроль над исходящим доступом, помогая применять безопасные и прогнозируемые политики сетевой связи. С течением времени могут добавляться дополнительные типы действий доступа к подключению.

Значение Описание
Allow

Разрешает исходящие подключения. При использовании в качестве действия по умолчанию разрешены все облачные подключения.
Deny

Блокирует исходящие подключения. При использовании в качестве действия по умолчанию все облачные подключения запрещены, если явно не разрешено.

ConnectionRuleEndpointMetadata

Объект

Представляет одно правило исключения на уровне конечной точки, позволяющее исходящее взаимодействие с определенным внешним доменом или узлом. Этот объект используется в массиве allowedEndpoints правила подключения, чтобы явно авторизовать исходящий доступ к доверенным конечным точкам для заданного типа подключения. Это применимо только к типам подключений, поддерживающим фильтрацию на основе конечных точек (например, SQL, MySQL, Web и т. д.).

Имя Тип Описание
hostnamePattern

string

Шаблон, поддерживаемый подстановочным знаком, определяющий разрешенную внешнюю конечную точку. Примеры включают *.microsoft.com, api.contoso.com или data.partner.org.

ConnectionRuleWorkspaceMetadata

Объект

Представляет правило исключения на уровне рабочей области, позволяющее исходящее взаимодействие с определенной рабочей областью для заданного типа подключения. Этот объект используется в массиве allowedWorkspaces правила подключения, чтобы явно авторизовать доступ между рабочими областями. Это применимо только к типам подключений, поддерживающим фильтрацию на основе рабочей области, например Lakehouse, Warehouse, FabricSql и PowerPlatformDataflows.

Имя Тип Описание
workspaceId

string (uuid)

Уникальный идентификатор (GUID) целевой рабочей области, которая может быть подключена из текущей рабочей области.

ErrorRelatedResource

Объект

Объект сведений об ошибках, связанных с ресурсом.

Имя Тип Описание
resourceId

string

Идентификатор ресурса, участвующий в ошибке.
resourceType

string

Тип ресурса, который участвует в ошибке.

ErrorResponse

Объект

Ответ на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
isRetriable

boolean

Если задано значение true, запрос можно получить. Retry-After Используйте заголовок ответа, чтобы определить задержку, если она доступна.
message

string

Удобочитаемое представление ошибки.
moreDetails

ErrorResponseDetails[]

Список дополнительных сведений об ошибке.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.
requestId

string (uuid)

Идентификатор запроса, связанного с ошибкой.

ErrorResponseDetails

Объект

Сведения об ответе на ошибку.

Имя Тип Описание
errorCode

string

Определенный идентификатор, предоставляющий сведения об условии ошибки, что позволяет стандартизировать обмен данными между службой и ее пользователями.
message

string

Удобочитаемое представление ошибки.
relatedResource

ErrorRelatedResource

Сведения об ошибках, связанных с ресурсом.

GatewayAccessActionType

Перечисление

Определяет поведение управления доступом для исходящих шлюзов. Эта перечисление используется для поля defaultAction, чтобы указать, следует ли разрешить исходящее взаимодействие или запретить по умолчанию. Этот тип обеспечивает как глобальный, так и определенный шлюз контроль над исходящим доступом, что помогает применять безопасные и прогнозируемые политики сетевого взаимодействия. С течением времени могут добавляться дополнительные типы действий доступа к шлюзу.

Значение Описание
Allow

Разрешает исходящие шлюзы. При использовании в качестве действия по умолчанию разрешены все шлюзы.
Deny

Блокирует исходящие шлюзы. При использовании в качестве действия по умолчанию все шлюзы запрещены, если явно не разрешено.

GatewayAccessRuleMetadata

Объект

Представляет шлюз, разрешенный для исходящего взаимодействия. Этот объект используется в разрешенныхGateways для явной авторизации исходящего доступа.

Имя Тип Описание
id

string (uuid)

Допустимый идентификатор шлюза.

NetworkAccessRule

Перечисление

Политика по умолчанию для доступа к рабочей области из общедоступных сетей. Если опущено из текста запроса PUT, это поле по умолчанию имеет Allowзначение , которое может непреднамеренно открыть сетевой доступ. Всегда явно укажите это поле в каждом тексте запроса PUT.

Значение Описание
Allow

Разрешить все подключения.
Deny

Запретить все подключения.

NetworkCommunicationPolicies

Объект

Параметры политики сетевого обмена данными для списка рабочих областей, включенных с защитой входящего или исходящего доступа.

Имя Тип Описание
continuationToken

string

Маркер для следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
continuationUri

string

Универсальный код ресурса (URI) следующего пакета результирующих наборов. Если больше записей нет, он удаляется из ответа.
value

NetworkCommunicationPolicyDetails[]

Параметры политики сетевого обмена данными для списка рабочих областей, включенных с защитой входящего или исходящего доступа.

NetworkCommunicationPolicyDetails

Объект

Представляет сведения о параметрах политики сетевого взаимодействия для каждой рабочей области.

Имя Тип Описание
inbound

NetworkCommunicationPolicyInboundDetails

Определяет параметры защиты входящего доступа.
outbound

NetworkCommunicationPolicyOutboundDetails

Определяет параметры защиты исходящего доступа.
workspaceId

string (uuid)

Идентификатор рабочей области.

NetworkCommunicationPolicyInboundDetails

Объект

Представляет сведения о параметрах политики сетевого взаимодействия для каждой рабочей области.

Имя Тип Описание
publicAccessRules

NetworkRules

Политика для всех входящих подключений к рабочей области

NetworkCommunicationPolicyOutboundDetails

Объект

Представляет сведения о параметрах политики сетевого взаимодействия для каждой рабочей области.

Имя Тип Описание
connections

WorkspaceOutboundConnections

Представляет полный набор правил подключения к облачному подключению для исходящего доступа, настроенных для рабочей области в рамках политики сетевого взаимодействия. Этот объект определяет правила подключения, определяющие, какие внешние конечные точки и рабочие области разрешены или запрещены для исходящего взаимодействия.
gateways

WorkspaceOutboundGateways

Представляет полный набор правил защиты исходящего доступа шлюза, настроенных для рабочей области в рамках политики сетевой связи. Этот объект определяет правила шлюза, которые управляют исходящим обменом данными
git

NetworkRules

Представляет политику исходящего трафика Git для указанной в рамках политики сетевого взаимодействия.
publicAccessRules

NetworkRules

Политика для всех исходящих подключений к рабочей области

NetworkRules

Объект

Политика, определяющая доступ к рабочей области или из общедоступных сетей.

Имя Тип Описание
defaultAction

NetworkAccessRule

Политика по умолчанию для доступа к рабочей области из общедоступных сетей. Если опущено из текста запроса PUT, это поле по умолчанию имеет Allowзначение , которое может непреднамеренно открыть сетевой доступ. Всегда явно укажите это поле в каждом тексте запроса PUT.

OutboundConnectionRule

Объект

Определяет правило исходящего доступа для конкретного облачного подключения.

Имя Тип Описание
allowedEndpoints

ConnectionRuleEndpointMetadata[]

Определяет список явно разрешенных внешних конечных точек для connectionType. Каждая запись в массиве представляет шаблон имени узла, разрешенный для исходящего взаимодействия из рабочей области. Это поле применимо только к типам подключений, поддерживающим фильтрацию на основе конечных точек (например, SQL, MySQL, Web и т. д.). Если параметр defaultAction имеет значение "Запретить" для типа подключения, будут разрешены только указанные здесь конечные точки; все остальные будут заблокированы.
allowedWorkspaces

ConnectionRuleWorkspaceMetadata[]

Указывает список идентификаторов рабочих областей, которые явно разрешены для исходящего взаимодействия для заданного типа подключения структуры. Это поле применимо только к типам подключений структуры, которые поддерживают фильтрацию на основе рабочей области, ограничена Lakehouse, Warehouse, FabricSql и PowerPlatformDataflows. Если для типа подключения задано значение defaultAction, только рабочие области, перечисленные в разрешенных Рабочих пространствах, будут разрешены для исходящего доступа; все остальные будут заблокированы.
connectionType

string

Указывает тип облачного подключения, к которому применяется правило. Поведение и применимость других свойств правила (например, allowedEndpoints или allowedWorkspaces) может отличаться в зависимости от возможностей типа подключения.
defaultAction

ConnectionAccessActionType

Определяет поведение исходящего доступа по умолчанию для connectionType. Это поле определяет, разрешены ли подключения этого типа или блокируются по умолчанию, если только не будет уточнено разрешенными Точками или разрешенными пространствамиWorkspace. Если задано значение Allow: все подключения этого типа разрешены, если явно не запрещено более конкретным правилом. Это поле обеспечивает точный контроль над каждым типом подключения и дополняет глобальное резервное поведение, определенное по умолчанию.

WorkspaceOutboundConnections

Объект

Представляет полный набор правил подключения к облачному подключению для исходящего доступа, настроенных для рабочей области в рамках политики сетевого взаимодействия. Этот объект определяет правила подключения, определяющие, какие внешние конечные точки и рабочие области разрешены или запрещены для исходящего взаимодействия.

Имя Тип Описание
defaultAction

ConnectionAccessActionType

Определяет поведение по умолчанию для всех типов облачных подключений, которые не указаны явным образом в массиве правил. Если задано значение "Разрешить", все неопределенные типы подключений разрешены по умолчанию. Если задано значение "Запретить", все неопределенные типы подключений блокируются по умолчанию, если явно не разрешено. Этот параметр выступает в качестве глобальной резервной политики и имеет решающее значение для обеспечения безопасного положения по умолчанию в средах, где должны быть разрешены только известные и надежные подключения. Если опущено из текста запроса PUT, это поле по умолчанию имеет Allowзначение , которое может непреднамеренно разрешать все исходящие подключения. Всегда явно укажите это поле в каждом тексте запроса PUT.
rules

OutboundConnectionRule[]

Список правил, определяющих поведение исходящего доступа для определенных типов облачных подключений. Каждое правило может включать ограничения на основе конечных точек или рабочих областей в зависимости от поддерживаемых типов подключений.

WorkspaceOutboundGateways

Объект

Представляет полный набор правил защиты исходящего доступа шлюза, настроенных для рабочей области в рамках политики сетевой связи. Этот объект определяет правила шлюза, которые управляют исходящим обменом данными

Имя Тип Описание
allowedGateways

GatewayAccessRuleMetadata[]

Список правил, определяющих поведение исходящего доступа для шлюзов.
defaultAction

GatewayAccessActionType

Определяет поведение по умолчанию для всех шлюзов, которые не указаны явным образом в массиве разрешенных списков. Если задано значение Allow, все неопределенные шлюзы разрешены по умолчанию. Если задано значение "Запретить", все неопределенные шлюзы блокируются. Если не указано в тексте запроса PUT, это поле по умолчанию Allowимеет значение , которое может непреднамеренно разрешать все исходящие подключения шлюза. Всегда явно укажите это поле в каждом тексте запроса PUT.