Поделиться через

Workspaces - List

Служба:
Synapse
Версия API:
2021-06-01

Возвращает список рабочих областей в подписке

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Synapse/workspaces?api-version=2021-06-01

Параметры URI

Имя В Обязательно Тип Описание
subscriptionId
 path True

string

minLength: 1

Идентификатор целевой подписки.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.

Ответы

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

WorkspaceInfoListResult

Other Status Codes

ErrorResponse

Примеры

List workspaces in subscription

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

GET https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.Synapse/workspaces?api-version=2021-06-01

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

Код состояния:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1",
      "name": "workspace1",
      "type": "Microsoft.Synapse/workspaces",
      "location": "East US",
      "properties": {
        "defaultDataLakeStorage": {
          "accountUrl": "https://accountname.dfs.core.windows.net",
          "filesystem": "default"
        },
        "connectivityEndpoints": {
          "dev": "workspace1.dev.projectarcadia.net",
          "sql": "workspace1.sql.projectarcadia.net"
        },
        "sqlAdministratorLogin": "login",
        "managedResourceGroupName": "resourceGroup2",
        "provisioningState": "Succeeded",
        "workspaceUID": "00000000-1111-2222-3333-444444444444"
      },
      "tags": {
        "key": "value"
      }
    },
    {
      "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace2",
      "name": "workspace2",
      "type": "Microsoft.Synapse/workspaces",
      "location": "East US",
      "properties": {
        "defaultDataLakeStorage": {
          "accountUrl": "https://accountname.dfs.core.windows.net",
          "filesystem": "default"
        },
        "connectivityEndpoints": {
          "dev": "workspace2.dev.projectarcadia.net",
          "sql": "workspace2.sql.projectarcadia.net"
        },
        "sqlAdministratorLogin": "login",
        "managedResourceGroupName": "resourceGroup2",
        "provisioningState": "Succeeded",
        "workspaceUID": "00000000-1111-2222-3333-444444444444"
      },
      "tags": {
        "key": "value"
      }
    }
  ]
}

Определения

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

Свойства администратора AAD для начальной рабочей области для подписки CSP
CustomerManagedKeyDetails

Сведения об управляемом клиентом ключе, связанном с рабочей областью
DataLakeStorageAccountDetails

Сведения о учетной записи хранения озера данных, связанной с рабочей областью
EncryptionDetails

Сведения о шифровании, связанном с рабочей областью
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

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

Свойства ключа шифрования ключей
ManagedIdentity

Управляемое удостоверение рабочей области
ManagedVirtualNetworkSettings

Параметры управляемой виртуальной сети
PrivateEndpoint

Сведения о частной конечной точке
PrivateEndpointConnection

Подключение к частной конечной точке
PrivateLinkServiceConnectionState

Сведения о состоянии подключения частной конечной точки
PurviewConfiguration

Конфигурация Purview
ResourceIdentityType

Тип управляемого удостоверения для рабочей области
UserAssignedManagedIdentity

Управляемое удостоверение, назначаемое пользователем
VirtualNetworkProfile

Профиль виртуальной сети
Workspace

Рабочая область
WorkspaceInfoListResult

Список рабочих областей
WorkspaceKeyDetails

Сведения об управляемом клиентом ключе, связанном с рабочей областью
WorkspacePublicNetworkAccess

Включение или отключение доступа к рабочей области общедоступной сети
WorkspaceRepositoryConfiguration

Параметры интеграции Git

CspWorkspaceAdminProperties

Object

Свойства администратора AAD для начальной рабочей области для подписки CSP

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

string

Идентификатор объекта AAD для начального администратора рабочей области

CustomerManagedKeyDetails

Object

Сведения об управляемом клиентом ключе, связанном с рабочей областью

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

KekIdentityProperties

Ключ шифрования ключей
key

WorkspaceKeyDetails

Ключевой объект рабочей области
status

string

Состояние управляемого клиентом ключа в рабочей области

DataLakeStorageAccountDetails

Object

Сведения о учетной записи хранения озера данных, связанной с рабочей областью

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

string

URL-адрес учетной записи
createManagedPrivateEndpoint

boolean

Создание управляемой частной конечной точки для этой учетной записи хранения или нет
filesystem

string

Имя файловой системы
resourceId

string

Идентификатор ресурса ARM этой учетной записи хранения

EncryptionDetails

Object

Сведения о шифровании, связанном с рабочей областью

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

CustomerManagedKeyDetails

Сведения о ключе, управляемом клиентом
doubleEncryptionEnabled

boolean

Двойное шифрование включено

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

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

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

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

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

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

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

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

ErrorDetail

Объект ошибки.

KekIdentityProperties

Object

Свойства ключа шифрования ключей

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

Логическое определение того, следует ли использовать назначенное системой удостоверение или нет
userAssignedIdentity

string

Идентификатор ресурса назначаемого пользователем удостоверения

ManagedIdentity

Object

Управляемое удостоверение рабочей области

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

string

Основной идентификатор управляемого удостоверения рабочей области
tenantId

string (uuid)

Идентификатор клиента управляемого удостоверения рабочей области
type

ResourceIdentityType

Тип управляемого удостоверения для рабочей области
userAssignedIdentities

<string,  UserAssignedManagedIdentity>

Назначаемые пользователем управляемые удостоверения.

ManagedVirtualNetworkSettings

Object

Параметры управляемой виртуальной сети

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

string[]

Разрешены идентификаторы клиента Aad для связывания
linkedAccessCheckOnTargetResource

boolean

Проверка связанного доступа на целевой ресурс
preventDataExfiltration

boolean

Предотвращение кражи данных

PrivateEndpoint

Object

Сведения о частной конечной точке

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

string

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

PrivateEndpointConnection

Object

Подключение к частной конечной точке

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

string

Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.privateEndpoint

PrivateEndpoint

Частная конечная точка, к которой принадлежит подключение.
properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Состояние подключения частной конечной точки.
properties.provisioningState

string

Состояние подготовки подключения к частной конечной точке.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Object

Сведения о состоянии подключения частной конечной точки

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

string

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

string

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

string

Состояние подключения службы приватного канала.

PurviewConfiguration

Object

Конфигурация Purview

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

string

Идентификатор ресурса Purview

ResourceIdentityType

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

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

Значение Описание
None
SystemAssigned
SystemAssigned,UserAssigned

UserAssignedManagedIdentity

Object

Управляемое удостоверение, назначаемое пользователем

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

string (uuid)

Идентификатор клиента.
principalId

string (uuid)

Идентификатор субъекта.

VirtualNetworkProfile

Object

Профиль виртуальной сети

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

string

Идентификатор подсети, используемый для вычислений в рабочей области

Workspace

Object

Рабочая область

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

string

Полный идентификатор ресурса для ресурса. Пример - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity

ManagedIdentity

Удостоверение рабочей области
location

string

Географическое расположение, в котором находится ресурс
name

string

Имя ресурса
properties.adlaResourceId

string

Идентификатор ресурса ADLA.
properties.azureADOnlyAuthentication

boolean

Включение или отключение AzureADOnlyAuthentication в подресурсе всех рабочих областей
properties.connectivityEndpoints

object

Конечные точки подключения
properties.cspWorkspaceAdminProperties

CspWorkspaceAdminProperties

Свойства администратора AAD для начальной рабочей области для подписки CSP
properties.defaultDataLakeStorage

DataLakeStorageAccountDetails

Сведения о учетной записи хранения озера данных по умолчанию рабочей области
properties.encryption

EncryptionDetails

Сведения о шифровании рабочей области
properties.extraProperties

object

Конфигурации уровня рабочей области и флаги компонентов
properties.managedResourceGroupName

string

Управляемая рабочая область группы ресурсов. Имя группы ресурсов однозначно идентифицирует группу ресурсов в идентификаторе подписки пользователя. Имя группы ресурсов должно быть не более 90 символов, и должно быть буквенно-цифровыми символами (Char.IsLetterOrDigit()) и "-", "_", "(", ")" и". Обратите внимание, что имя не может заканчиваться "".
properties.managedVirtualNetwork

string

Если для этой рабочей области задано значение default, все вычислительные ресурсы этой рабочей области будут находиться в виртуальной сети, управляемой от имени пользователя.
properties.managedVirtualNetworkSettings

ManagedVirtualNetworkSettings

Параметры управляемой виртуальной сети
properties.privateEndpointConnections

PrivateEndpointConnection[]

Подключения частной конечной точки к рабочей области
properties.provisioningState

string

Состояние подготовки ресурсов
properties.publicNetworkAccess

WorkspacePublicNetworkAccess

Enabled

Включение или отключение доступа к рабочей области общедоступной сети
properties.purviewConfiguration

PurviewConfiguration

Конфигурация Purview
properties.settings

object

Параметры рабочей области
properties.sqlAdministratorLogin

string

Вход для администратора Active Directory рабочей области SQL
properties.sqlAdministratorLoginPassword

string

Пароль для входа администратора SQL
properties.trustedServiceBypassEnabled

boolean

False

Является довереннымServiceBypassEnabled для рабочей области
properties.virtualNetworkProfile

VirtualNetworkProfile

Профиль виртуальной сети
properties.workspaceRepositoryConfiguration

WorkspaceRepositoryConfiguration

Параметры интеграции Git
properties.workspaceUID

string (uuid)

Уникальный идентификатор рабочей области
tags

object

Теги ресурсов.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

WorkspaceInfoListResult

Object

Список рабочих областей

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

string

Ссылка на следующую страницу результатов
value

Workspace[]

Список рабочих областей

WorkspaceKeyDetails

Object

Сведения об управляемом клиентом ключе, связанном с рабочей областью

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

string

URL-адрес хранилища ключей ключа рабочей области
name

string

Имя подресурсов ключа рабочей области

WorkspacePublicNetworkAccess

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

Включение или отключение доступа к рабочей области общедоступной сети

Значение Описание
Enabled
Disabled

WorkspaceRepositoryConfiguration

Object

Параметры интеграции Git

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

string

Имя учетной записи
collaborationBranch

string

Ветвь совместной работы
hostName

string

Имя узла GitHub Enterprise. Например: https://github.mydomain.com
lastCommitId

string

Последний идентификатор фиксации
projectName

string

Имя проекта VSTS
repositoryName

string

Имя репозитория
rootFolder

string

Корневая папка для использования в репозитории
tenantId

string (uuid)

Идентификатор клиента VSTS
type

string

Тип конфигурации репозитория рабочей области. Пример WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration