Compartir a través de


Workspaces - Get

Obtiene un área de trabajo.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

Identificador de la suscripción de destino.

workspaceName
path True

string

Nombre del área de trabajo.

api-version
query True

string

minLength: 1

Versión de la API que se va a usar para esta operación.

Respuestas

Nombre Tipo Description
200 OK

Workspace

Other Status Codes

ErrorResponse

Ejemplos

Get a workspace

Solicitud de ejemplo

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

Respuesta de muestra

{
  "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",
      "web": "workspace1.sql.projectarcadia.net"
    },
    "managedVirtualNetworkSettings": {
      "preventDataExfiltration": false,
      "linkedAccessCheckOnTargetResource": false,
      "allowedAadTenantIdsForLinking": [
        "740239CE-A25B-485B-86A0-262F29F6EBDB"
      ]
    },
    "purviewConfiguration": {
      "purviewResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.ProjectPurview/accounts/accountname1"
    },
    "sqlAdministratorLogin": "login",
    "managedResourceGroupName": "resourceGroup2",
    "workspaceRepositoryConfiguration": {
      "type": "FactoryGitHubConfiguration",
      "hostName": "",
      "accountName": "myGithubAccount",
      "projectName": "myProject",
      "repositoryName": "myRepository",
      "collaborationBranch": "master",
      "rootFolder": "/",
      "tenantId": "00000000-1111-2222-3333-444444444444"
    },
    "provisioningState": "Succeeded",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Synapse/workspaces/ExampleWorkspace/privateEndpointConnections/ExamplePrivateEndpointConnection",
        "name": "sql",
        "type": "Microsoft.Synapse/workspaces/privateEndpointConnections",
        "properties": {
          "provisioningState": "Succeeded",
          "privateEndpoint": {
            "id": "/subscriptions/01234567-89ab-4def-0123-456789abcdef/resourceGroups/ExampleResourceGroup/providers/Microsoft.Network/privateEndpoints/ExamplePrivateEndpoint"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-approved",
            "actionsRequired": "None"
          }
        }
      }
    ],
    "workspaceUID": "00000000-1111-2222-3333-444444444444",
    "cspWorkspaceAdminProperties": {
      "initialWorkspaceAdminObjectId": "6c20646f-8050-49ec-b3b1-80a0e58e454d"
    },
    "extraProperties": {
      "IsScopeEnabled": "false",
      "WorkspaceType": "Normal"
    }
  },
  "tags": {
    "key": "value"
  }
}
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definiciones

Nombre Description
CspWorkspaceAdminProperties

Propiedades de administrador de AAD del área de trabajo iniciales para una suscripción de CSP

CustomerManagedKeyDetails

Detalles de la clave administrada por el cliente asociada al área de trabajo

DataLakeStorageAccountDetails

Detalles de la cuenta de almacenamiento de Data Lake asociada al área de trabajo

EncryptionDetails

Detalles del cifrado asociado al área de trabajo

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

ErrorDetail

Detalle del error.

ErrorResponse

Respuesta de error

KekIdentityProperties

Propiedades de clave de cifrado de claves

ManagedIdentity

La identidad administrada del área de trabajo

ManagedVirtualNetworkSettings

Configuración de red virtual administrada

PrivateEndpoint

Detalles del punto de conexión privado

PrivateEndpointConnection

Una conexión de punto de conexión privado

PrivateLinkServiceConnectionState

Detalles del estado de conexión del punto de conexión privado

PurviewConfiguration

Configuración de Purview

ResourceIdentityType

Tipo de identidad administrada para el área de trabajo

UserAssignedManagedIdentity

Identidad administrada asignada por el usuario

VirtualNetworkProfile

Perfil de red virtual

Workspace

Un área de trabajo

WorkspaceKeyDetails

Detalles de la clave administrada por el cliente asociada al área de trabajo

WorkspacePublicNetworkAccess

Habilitación o deshabilitación del acceso de red pública al área de trabajo

WorkspaceRepositoryConfiguration

Configuración de integración de Git

CspWorkspaceAdminProperties

Propiedades de administrador de AAD del área de trabajo iniciales para una suscripción de CSP

Nombre Tipo Description
initialWorkspaceAdminObjectId

string

Identificador de objeto de AAD del administrador inicial del área de trabajo

CustomerManagedKeyDetails

Detalles de la clave administrada por el cliente asociada al área de trabajo

Nombre Tipo Description
kekIdentity

KekIdentityProperties

Clave de cifrado de claves

key

WorkspaceKeyDetails

El objeto clave del área de trabajo

status

string

Estado de la clave administrada por el cliente en el área de trabajo

DataLakeStorageAccountDetails

Detalles de la cuenta de almacenamiento de Data Lake asociada al área de trabajo

Nombre Tipo Description
accountUrl

string

Dirección URL de la cuenta

createManagedPrivateEndpoint

boolean

Creación de un punto de conexión privado administrado en esta cuenta de almacenamiento o no

filesystem

string

Nombre del sistema de archivos

resourceId

string

Identificador de recurso de ARM de esta cuenta de almacenamiento

EncryptionDetails

Detalles del cifrado asociado al área de trabajo

Nombre Tipo Description
cmk

CustomerManagedKeyDetails

Detalles de clave administrada por el cliente

doubleEncryptionEnabled

boolean

Cifrado doble habilitado

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre Tipo Description
info

object

Información adicional.

type

string

Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre Tipo Description
additionalInfo

ErrorAdditionalInfo[]

Información adicional del error.

code

string

Código de error.

details

ErrorDetail[]

Detalles del error.

message

string

Mensaje de error.

target

string

Destino del error.

ErrorResponse

Respuesta de error

Nombre Tipo Description
error

ErrorDetail

Objeto de error.

KekIdentityProperties

Propiedades de clave de cifrado de claves

Nombre Tipo Description
useSystemAssignedIdentity

Boolean que especifica si se va a usar la identidad asignada por el sistema o no

userAssignedIdentity

string

Identificador de recurso de identidad asignado por el usuario

ManagedIdentity

La identidad administrada del área de trabajo

Nombre Tipo Description
principalId

string

Identificador de entidad de seguridad de la identidad administrada del área de trabajo

tenantId

string (uuid)

Identificador de inquilino de la identidad administrada del área de trabajo

type

ResourceIdentityType

Tipo de identidad administrada para el área de trabajo

userAssignedIdentities

<string,  UserAssignedManagedIdentity>

Identidades administradas asignadas por el usuario.

ManagedVirtualNetworkSettings

Configuración de red virtual administrada

Nombre Tipo Description
allowedAadTenantIdsForLinking

string[]

Identificadores de inquilino de Aad permitidos para vincular

linkedAccessCheckOnTargetResource

boolean

Comprobación de acceso vinculado en el recurso de destino

preventDataExfiltration

boolean

Impedir la filtración de datos

PrivateEndpoint

Detalles del punto de conexión privado

Nombre Tipo Description
id

string

Identificador de recurso del punto de conexión privado.

PrivateEndpointConnection

Una conexión de punto de conexión privado

Nombre Tipo Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Nombre del recurso

properties.privateEndpoint

PrivateEndpoint

Punto de conexión privado al que pertenece la conexión.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Estado de conexión de la conexión del punto de conexión privado.

properties.provisioningState

string

Estado de aprovisionamiento de la conexión de punto de conexión privado.

type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Detalles del estado de conexión del punto de conexión privado

Nombre Tipo Description
actionsRequired

string

Las acciones necesarias para la conexión del servicio Private Link.

description

string

Descripción de la conexión del servicio private link.

status

string

Estado de conexión del servicio private link.

PurviewConfiguration

Configuración de Purview

Nombre Tipo Description
purviewResourceId

string

Identificador de recurso de Purview

ResourceIdentityType

Tipo de identidad administrada para el área de trabajo

Valor Description
None
SystemAssigned
SystemAssigned,UserAssigned

UserAssignedManagedIdentity

Identidad administrada asignada por el usuario

Nombre Tipo Description
clientId

string (uuid)

Identificador de cliente.

principalId

string (uuid)

Identificador de entidad de seguridad.

VirtualNetworkProfile

Perfil de red virtual

Nombre Tipo Description
computeSubnetId

string

Identificador de subred usado para los procesos en el área de trabajo

Workspace

Un área de trabajo

Nombre Tipo Valor predeterminado Description
id

string

Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedIdentity

Identidad del área de trabajo

location

string

Ubicación geográfica donde reside el recurso

name

string

Nombre del recurso

properties.adlaResourceId

string

Identificador de recurso de ADLA.

properties.azureADOnlyAuthentication

boolean

Habilitación o deshabilitación de AzureADOnlyAuthentication en todo el subrecurso del área de trabajo

properties.connectivityEndpoints

object

Puntos de conexión de conectividad

properties.cspWorkspaceAdminProperties

CspWorkspaceAdminProperties

Propiedades de administrador de AAD del área de trabajo iniciales para una suscripción de CSP

properties.defaultDataLakeStorage

DataLakeStorageAccountDetails

Detalles de la cuenta de almacenamiento de Data Lake predeterminada del área de trabajo

properties.encryption

EncryptionDetails

Detalles de cifrado del área de trabajo

properties.extraProperties

object

Configuraciones de nivel de área de trabajo y marcas de características

properties.managedResourceGroupName

string

Grupo de recursos administrados del área de trabajo. El nombre del grupo de recursos identifica de forma única el grupo de recursos dentro del identificador de suscripción de usuario. El nombre del grupo de recursos no debe tener más de 90 caracteres y debe tener caracteres alfanuméricos (Char.IsLetterOrDigit()) y '-', '_', '(', ')' y'.'. Tenga en cuenta que el nombre no puede terminar con '.'

properties.managedVirtualNetwork

string

Si se establece en "valor predeterminado", se asegurará de que todo el proceso de esta área de trabajo esté en una red virtual administrada en nombre del usuario.

properties.managedVirtualNetworkSettings

ManagedVirtualNetworkSettings

Configuración de red virtual administrada

properties.privateEndpointConnections

PrivateEndpointConnection[]

Conexiones de punto de conexión privado al área de trabajo

properties.provisioningState

string

Estado de aprovisionamiento de recursos

properties.publicNetworkAccess

WorkspacePublicNetworkAccess

Enabled

Habilitación o deshabilitación del acceso de red pública al área de trabajo

properties.purviewConfiguration

PurviewConfiguration

Configuración de Purview

properties.settings

object

Configuración del área de trabajo

properties.sqlAdministratorLogin

string

Inicio de sesión del administrador de SQL Active Directory del área de trabajo

properties.sqlAdministratorLoginPassword

string

Contraseña de inicio de sesión del administrador de SQL

properties.trustedServiceBypassEnabled

boolean

False

Es trustedServiceBypassEnabled para el área de trabajo.

properties.virtualNetworkProfile

VirtualNetworkProfile

Perfil de red virtual

properties.workspaceRepositoryConfiguration

WorkspaceRepositoryConfiguration

Configuración de integración de Git

properties.workspaceUID

string (uuid)

Identificador único del área de trabajo

tags

object

Etiquetas de recursos.

type

string

Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

WorkspaceKeyDetails

Detalles de la clave administrada por el cliente asociada al área de trabajo

Nombre Tipo Description
keyVaultUrl

string

Dirección URL del almacén de claves de subrecurso de la clave del área de trabajo

name

string

Nombre del subrecurso de clave del área de trabajo

WorkspacePublicNetworkAccess

Habilitación o deshabilitación del acceso de red pública al área de trabajo

Valor Description
Enabled
Disabled

WorkspaceRepositoryConfiguration

Configuración de integración de Git

Nombre Tipo Description
accountName

string

Nombre de la cuenta

collaborationBranch

string

Rama de colaboración

hostName

string

Nombre de host de GitHub Enterprise. Por ejemplo: https://github.mydomain.com

lastCommitId

string

El último identificador de confirmación

projectName

string

Nombre del proyecto de VSTS

repositoryName

string

Nombre del repositorio

rootFolder

string

Carpeta raíz que se va a usar en el repositorio

tenantId

string (uuid)

Identificador de inquilino de VSTS

type

string

Tipo de configuración de repositoryID del área de trabajo. Ejemplo workspaceVSTSConfiguration, WorkspaceGitHubConfiguration