Workspaces - Create Workspace

Служба:: Core

Версия API:: v1

Создает новую рабочую область.

Разрешения

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

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

Workspace.ReadWrite.All

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

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

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

Интерфейс

POST https://api.fabric.microsoft.com/v1/workspaces

Текст запроса

Имя	Обязательно	Тип	Описание
displayName	True	string	Отображаемое имя рабочей области. Отображаемое имя не может содержать более 256 символов. Разрешены только неиспользуемые имена рабочих областей. "Мониторинг администратора" — это зарезервированное имя рабочей области.
capacityId		string (uuid)	Идентификатор емкости для назначения рабочей области.
description		string	Описание рабочей области. Описание не может содержать более 4000 символов.
domainId		string (uuid)	Идентификатор домена для назначения рабочей области.

Ответы

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

201 Created

Имя	Тип	Описание
201 Created	Workspace	Успешно создано. Заголовки Location: string
429 Too Many Requests	ErrorResponse	Превышено ограничение скорости обслуживания. Сервер возвращает заголовок, указывающий `Retry-After` в секундах, сколько времени клиент должен ждать перед отправкой дополнительных запросов. Заголовки Retry-After: integer
Other Status Codes	ErrorResponse	Распространенные коды ошибок: DomainNotFound — предоставленный домен не найден Недостаточно разрешений пользователя на домен. Для выполнения операции недостаточно разрешения пользователя на домен. UnknownError — произошла ошибка.

Workspace

Успешно создано.

Заголовки

Location: string

429 Too Many Requests

ErrorResponse

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

Заголовки

Retry-After: integer

Other Status Codes

ErrorResponse

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

DomainNotFound — предоставленный домен не найден
Недостаточно разрешений пользователя на домен. Для выполнения операции недостаточно разрешения пользователя на домен.
UnknownError — произошла ошибка.

Примеры

Create a workspace example

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

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces

{
  "displayName": "New workspace"
}

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

Код состояния:: 201

Location: https://api.fabric.microsoft.com/v1/workspaces/cfafbeb1-8037-4d0c-896e-a46fb22287ff

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb22287ff",
  "displayName": "New workspace",
  "description": "",
  "type": "Workspace"
}

Определения

Имя	Описание
CreateWorkspaceRequest	Создание полезных данных запроса рабочей области.
ErrorRelatedResource	Объект сведений об ошибках, связанных с ресурсом.
ErrorResponse	Ответ на ошибку.
ErrorResponseDetails	Сведения об ответе на ошибку.
Workspace	Объект рабочей области.
WorkspaceAppliedTag	Представляет примененный тег.
WorkspaceType	Тип рабочей области. С течением времени могут добавляться дополнительные типы рабочих областей.

CreateWorkspaceRequest

Объект

Создание полезных данных запроса рабочей области.

Имя	Тип	Описание
capacityId	string (uuid)	Идентификатор емкости для назначения рабочей области.
description	string	Описание рабочей области. Описание не может содержать более 4000 символов.
displayName	string	Отображаемое имя рабочей области. Отображаемое имя не может содержать более 256 символов. Разрешены только неиспользуемые имена рабочих областей. "Мониторинг администратора" — это зарезервированное имя рабочей области.
domainId	string (uuid)	Идентификатор домена для назначения рабочей области.

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	Сведения об ошибках, связанных с ресурсом.

Workspace

Объект

Объект рабочей области.

Имя	Тип	Описание
apiEndpoint	string (uri)	URL-адрес HTTP, представляющий конечную точку API, относящуюся к рабочей области. Это значение конечной точки возвращается, когда пользователь включает preferWorkspaceSpecificEndpoints. Он позволяет получить доступ к API через частные каналы.
capacityId	string (uuid)	Идентификатор емкости рабочей области назначается.
description	string	Описание рабочей области.
displayName	string	Отображаемое имя рабочей области.
domainId	string (uuid)	Идентификатор домена, которому назначена рабочая область.
id	string (uuid)	Идентификатор рабочей области.
tags	WorkspaceAppliedTag[]	Список примененных тегов.
type	WorkspaceType	Тип рабочей области.

WorkspaceAppliedTag

Объект

Представляет примененный тег.

Имя	Тип	Описание
displayName	string	Имя тега.
id	string (uuid)	Идентификатор тега.

WorkspaceType

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

Тип рабочей области. С течением времени могут добавляться дополнительные типы рабочих областей.

Значение	Описание
Personal	Моя папка или моя рабочая область, используемая для управления элементами пользователя.
Workspace	Рабочая область, используемая для управления элементами Fabric.
AdminWorkspace	Рабочая область мониторинга администратора. Содержит отчеты администратора, такие как отчет аудита и отчет об использовании и внедрении.