Workspaces - Create Or Update

Cria ou atualiza um espaço de trabalho

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

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

subscriptionId
path True

string

minLength: 1

A ID da assinatura de destino.

workspaceName
path True

string

O nome do espaço de trabalho.

api-version
query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Corpo do Pedido

Name Necessário Tipo Description
location True

string

A geolocalização onde o recurso vive

identity

ManagedIdentity

Identidade do espaço de trabalho

properties.azureADOnlyAuthentication

boolean

Habilitar ou desabilitar o subrecurso AzureADOnlyAuthentication em Todos os espaços de trabalho

properties.cspWorkspaceAdminProperties

CspWorkspaceAdminProperties

Espaço de trabalho inicial Propriedades de administração do AAD para uma assinatura CSP

properties.defaultDataLakeStorage

DataLakeStorageAccountDetails

Detalhes da conta de armazenamento do data lake padrão do espaço de trabalho

properties.encryption

EncryptionDetails

Os detalhes de criptografia do espaço de trabalho

properties.managedResourceGroupName

string

Grupo de recursos gerenciados pelo espaço de trabalho. O nome do grupo de recursos identifica exclusivamente o grupo de recursos dentro do usuário subscriptionId. O nome do grupo de recursos não deve ter mais de 90 caracteres e deve ser caracteres alfanuméricos (Char.IsLetterOrDigit()) e '-', '_', '(', ')' e'.'. Observe que o nome não pode terminar com '.'

properties.managedVirtualNetwork

string

Definir isso como 'padrão' garantirá que toda a computação para esse espaço de trabalho esteja em uma rede virtual gerenciada em nome do usuário.

properties.managedVirtualNetworkSettings

ManagedVirtualNetworkSettings

Configurações de rede virtual gerenciadas

properties.privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privado com o espaço de trabalho

properties.publicNetworkAccess

WorkspacePublicNetworkAccess

Habilitar ou desabilitar o acesso de rede pública ao espaço de trabalho

properties.purviewConfiguration

PurviewConfiguration

Configuração de Purview

properties.sqlAdministratorLogin

string

Login para administrador do Ative Directory SQL do espaço de trabalho

properties.sqlAdministratorLoginPassword

string

Palavra-passe de início de sessão do administrador SQL

properties.trustedServiceBypassEnabled

boolean

É confiávelServiceBypassEnabled para o espaço de trabalho

properties.virtualNetworkProfile

VirtualNetworkProfile

Perfil da Rede Virtual

properties.workspaceRepositoryConfiguration

WorkspaceRepositoryConfiguration

Configurações de integração do Git

tags

object

Tags de recursos.

Respostas

Name Tipo Description
200 OK

Workspace

201 Created

Workspace

Other Status Codes

ErrorResponse

Exemplos

Create or update a workspace

Pedido de amostra

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

{
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {}
    }
  },
  "properties": {
    "defaultDataLakeStorage": {
      "accountUrl": "https://accountname.dfs.core.windows.net",
      "filesystem": "default"
    },
    "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",
    "sqlAdministratorLoginPassword": "password",
    "managedVirtualNetwork": "default",
    "managedResourceGroupName": "workspaceManagedResourceGroupUnique",
    "workspaceRepositoryConfiguration": {
      "type": "FactoryGitHubConfiguration",
      "hostName": "",
      "accountName": "mygithubaccount",
      "projectName": "myproject",
      "repositoryName": "myrepository",
      "collaborationBranch": "master",
      "rootFolder": "/"
    },
    "encryption": {
      "cmk": {
        "kekIdentity": {
          "userAssignedIdentity": "/subscriptions/b64d7b94-73e7-4d36-94b2-7764ea3fd74a/resourcegroups/SynapseCI/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1",
          "useSystemAssignedIdentity": false
        },
        "key": {
          "name": "default",
          "keyVaultUrl": "https://vault.azure.net/keys/key1"
        }
      }
    },
    "publicNetworkAccess": "Enabled",
    "cspWorkspaceAdminProperties": {
      "initialWorkspaceAdminObjectId": "6c20646f-8050-49ec-b3b1-80a0e58e454d"
    }
  },
  "location": "East US",
  "tags": {
    "key": "value"
  }
}

Resposta da amostra

{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1",
  "name": "workspace1",
  "type": "Microsoft.Synapse/workspaces",
  "location": "East US",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {
        "clientId": "ffffffff-8888-4444-8888-333333333333",
        "principalId": "eeeeeeee-9999-4444-8888-333333333333"
      }
    },
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444"
  },
  "properties": {
    "defaultDataLakeStorage": {
      "accountUrl": "https://accountname.dfs.core.windows.net",
      "filesystem": "default"
    },
    "connectivityEndpoints": {
      "dev": "workspace1.dev.projectarcadia.net",
      "sql": "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": "workspaceManagedResourceGroupUnique",
    "managedVirtualNetwork": "default",
    "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",
    "encryption": {
      "doubleEncryptionEnabled": true,
      "cmk": {
        "kekIdentity": {
          "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1",
          "useSystemAssignedIdentity": false
        },
        "status": "Consistent",
        "key": {
          "name": "default",
          "keyVaultUrl": "https://vault.azure.net/keys/key1"
        }
      }
    },
    "publicNetworkAccess": "Enabled"
  },
  "tags": {
    "key": "value"
  }
}
{
  "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/workspaces/workspace1",
  "name": "workspace1",
  "type": "Microsoft.Synapse/workspaces",
  "location": "East US",
  "identity": {
    "type": "SystemAssigned,UserAssigned",
    "userAssignedIdentities": {
      "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1": {
        "clientId": "ffffffff-8888-4444-8888-333333333333",
        "principalId": "eeeeeeee-9999-4444-8888-333333333333"
      }
    },
    "principalId": "00000000-1111-2222-3333-444444444444",
    "tenantId": "00000000-1111-2222-3333-444444444444"
  },
  "properties": {
    "defaultDataLakeStorage": {
      "accountUrl": "https://accountname.dfs.core.windows.net",
      "filesystem": "default"
    },
    "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"
    },
    "connectivityEndpoints": {
      "dev": "workspace1.dev.projectarcadia.net",
      "sql": "workspace1.sql.projectarcadia.net"
    },
    "sqlAdministratorLogin": "login",
    "managedResourceGroupName": "workspaceManagedResourceGroupUnique",
    "managedVirtualNetwork": "default",
    "provisioningState": "Provisioning",
    "workspaceUID": "86984b43-b873-4b91-bacd-2ca083a104c7",
    "encryption": {
      "doubleEncryptionEnabled": true,
      "cmk": {
        "kekIdentity": {
          "userAssignedIdentity": "/subscriptions/00000000-1111-2222-3333-444444444444/resourcegroups/resourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uami1",
          "useSystemAssignedIdentity": false
        },
        "status": "Consistent",
        "key": {
          "name": "default",
          "keyVaultUrl": "https://vault.azure.net/keys/key1"
        }
      }
    },
    "publicNetworkAccess": "Enabled"
  },
  "tags": {
    "key": "value"
  }
}
{
  "error": {
    "code": "Error code",
    "message": "Error message"
  }
}

Definições

Name Description
CspWorkspaceAdminProperties

Espaço de trabalho inicial Propriedades de administração do AAD para uma assinatura CSP

CustomerManagedKeyDetails

Detalhes da chave gerenciada pelo cliente associada ao espaço de trabalho

DataLakeStorageAccountDetails

Detalhes da conta de armazenamento do data lake associada ao espaço de trabalho

EncryptionDetails

Detalhes da criptografia associada ao espaço de trabalho

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

ErrorDetail

O detalhe do erro.

ErrorResponse

Resposta de erro

KekIdentityProperties

Propriedades da chave de criptografia de chave

ManagedIdentity

A identidade gerenciada do espaço de trabalho

ManagedVirtualNetworkSettings

Configurações de rede virtual gerenciadas

PrivateEndpoint

Detalhes do ponto final privado

PrivateEndpointConnection

Uma conexão de ponto de extremidade privada

PrivateLinkServiceConnectionState

Detalhes do estado da conexão do ponto de extremidade privado

PurviewConfiguration

Configuração de Purview

ResourceIdentityType

O tipo de identidade gerenciada para o espaço de trabalho

UserAssignedManagedIdentity

Identidade gerenciada atribuída pelo usuário

VirtualNetworkProfile

Perfil de rede virtual

Workspace

Um espaço de trabalho

WorkspaceKeyDetails

Detalhes da chave gerenciada pelo cliente associada ao espaço de trabalho

WorkspacePublicNetworkAccess

Habilitar ou desabilitar o acesso de rede pública ao espaço de trabalho

WorkspaceRepositoryConfiguration

Configurações de integração do Git

CspWorkspaceAdminProperties

Espaço de trabalho inicial Propriedades de administração do AAD para uma assinatura CSP

Name Tipo Description
initialWorkspaceAdminObjectId

string

ID do objeto AAD do administrador do espaço de trabalho inicial

CustomerManagedKeyDetails

Detalhes da chave gerenciada pelo cliente associada ao espaço de trabalho

Name Tipo Description
kekIdentity

KekIdentityProperties

Chave de criptografia de chave

key

WorkspaceKeyDetails

O objeto principal do espaço de trabalho

status

string

O status da chave gerenciada pelo cliente no espaço de trabalho

DataLakeStorageAccountDetails

Detalhes da conta de armazenamento do data lake associada ao espaço de trabalho

Name Tipo Description
accountUrl

string

URL da conta

createManagedPrivateEndpoint

boolean

Criar ponto de extremidade privado gerenciado para esta conta de armazenamento ou não

filesystem

string

Nome do sistema de arquivos

resourceId

string

ID do recurso ARM desta conta de armazenamento

EncryptionDetails

Detalhes da criptografia associada ao espaço de trabalho

Name Tipo Description
cmk

CustomerManagedKeyDetails

Principais detalhes gerenciados pelo cliente

doubleEncryptionEnabled

boolean

Criptografia dupla ativada

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

Name Tipo Description
info

object

As informações adicionais.

type

string

O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name Tipo Description
additionalInfo

ErrorAdditionalInfo[]

O erro informações adicionais.

code

string

O código de erro.

details

ErrorDetail[]

Os detalhes do erro.

message

string

A mensagem de erro.

target

string

O destino do erro.

ErrorResponse

Resposta de erro

Name Tipo Description
error

ErrorDetail

O objeto de erro.

KekIdentityProperties

Propriedades da chave de criptografia de chave

Name Tipo Description
useSystemAssignedIdentity

Booleano especificando se a identidade atribuída ao sistema deve ser usada ou não

userAssignedIdentity

string

ID do recurso de identidade atribuído pelo usuário

ManagedIdentity

A identidade gerenciada do espaço de trabalho

Name Tipo Description
principalId

string

A ID principal da identidade gerenciada do espaço de trabalho

tenantId

string (uuid)

A ID do locatário da identidade gerenciada do espaço de trabalho

type

ResourceIdentityType

O tipo de identidade gerenciada para o espaço de trabalho

userAssignedIdentities

<string,  UserAssignedManagedIdentity>

O usuário atribuiu identidades gerenciadas.

ManagedVirtualNetworkSettings

Configurações de rede virtual gerenciadas

Name Tipo Description
allowedAadTenantIdsForLinking

string[]

Ids de locatário do Aad permitidos para vinculação

linkedAccessCheckOnTargetResource

boolean

Recurso de destino de verificação de acesso vinculado

preventDataExfiltration

boolean

Evitar a exfiltração de dados

PrivateEndpoint

Detalhes do ponto final privado

Name Tipo Description
id

string

ID do recurso do ponto de extremidade privado.

PrivateEndpointConnection

Uma conexão de ponto de extremidade privada

Name Tipo Description
id

string

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

O nome do recurso

properties.privateEndpoint

PrivateEndpoint

O ponto de extremidade privado ao qual a conexão pertence.

properties.privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Estado da conexão da conexão de ponto de extremidade privado.

properties.provisioningState

string

Estado de provisionamento da conexão de ponto de extremidade privado.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

PrivateLinkServiceConnectionState

Detalhes do estado da conexão do ponto de extremidade privado

Name Tipo Description
actionsRequired

string

As ações necessárias para conexão de serviço de link privado.

description

string

A descrição da conexão do serviço de link privado.

status

string

O status da conexão do serviço de link privado.

PurviewConfiguration

Configuração de Purview

Name Tipo Description
purviewResourceId

string

ID do recurso Purview

ResourceIdentityType

O tipo de identidade gerenciada para o espaço de trabalho

Valor Description
None
SystemAssigned
SystemAssigned,UserAssigned

UserAssignedManagedIdentity

Identidade gerenciada atribuída pelo usuário

Name Tipo Description
clientId

string (uuid)

O ID do cliente.

principalId

string (uuid)

O ID principal.

VirtualNetworkProfile

Perfil de rede virtual

Name Tipo Description
computeSubnetId

string

ID de sub-rede usado para cálculos no espaço de trabalho

Workspace

Um espaço de trabalho

Name Tipo Default value Description
id

string

ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

ManagedIdentity

Identidade do espaço de trabalho

location

string

A geolocalização onde o recurso vive

name

string

O nome do recurso

properties.adlaResourceId

string

O ID do recurso ADLA.

properties.azureADOnlyAuthentication

boolean

Habilitar ou desabilitar o subrecurso AzureADOnlyAuthentication em Todos os espaços de trabalho

properties.connectivityEndpoints

object

Pontos finais de conectividade

properties.cspWorkspaceAdminProperties

CspWorkspaceAdminProperties

Espaço de trabalho inicial Propriedades de administração do AAD para uma assinatura CSP

properties.defaultDataLakeStorage

DataLakeStorageAccountDetails

Detalhes da conta de armazenamento do data lake padrão do espaço de trabalho

properties.encryption

EncryptionDetails

Os detalhes de criptografia do espaço de trabalho

properties.extraProperties

object

Configurações no nível do espaço de trabalho e sinalizadores de recursos

properties.managedResourceGroupName

string

Grupo de recursos gerenciados pelo espaço de trabalho. O nome do grupo de recursos identifica exclusivamente o grupo de recursos dentro do usuário subscriptionId. O nome do grupo de recursos não deve ter mais de 90 caracteres e deve ser caracteres alfanuméricos (Char.IsLetterOrDigit()) e '-', '_', '(', ')' e'.'. Observe que o nome não pode terminar com '.'

properties.managedVirtualNetwork

string

Definir isso como 'padrão' garantirá que toda a computação para esse espaço de trabalho esteja em uma rede virtual gerenciada em nome do usuário.

properties.managedVirtualNetworkSettings

ManagedVirtualNetworkSettings

Configurações de rede virtual gerenciadas

properties.privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privado com o espaço de trabalho

properties.provisioningState

string

Estado de provisionamento de recursos

properties.publicNetworkAccess

WorkspacePublicNetworkAccess

Enabled

Habilitar ou desabilitar o acesso de rede pública ao espaço de trabalho

properties.purviewConfiguration

PurviewConfiguration

Configuração de Purview

properties.settings

object

Configurações do espaço de trabalho

properties.sqlAdministratorLogin

string

Login para administrador do Ative Directory SQL do espaço de trabalho

properties.sqlAdministratorLoginPassword

string

Palavra-passe de início de sessão do administrador SQL

properties.trustedServiceBypassEnabled

boolean

False

É confiávelServiceBypassEnabled para o espaço de trabalho

properties.virtualNetworkProfile

VirtualNetworkProfile

Perfil da Rede Virtual

properties.workspaceRepositoryConfiguration

WorkspaceRepositoryConfiguration

Configurações de integração do Git

properties.workspaceUID

string (uuid)

O identificador exclusivo do espaço de trabalho

tags

object

Tags de recursos.

type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

WorkspaceKeyDetails

Detalhes da chave gerenciada pelo cliente associada ao espaço de trabalho

Name Tipo Description
keyVaultUrl

string

URL do cofre da chave de sub-recurso da chave do espaço de trabalho

name

string

Nome do subrecurso Chave do Espaço de Trabalho

WorkspacePublicNetworkAccess

Habilitar ou desabilitar o acesso de rede pública ao espaço de trabalho

Valor Description
Enabled
Disabled

WorkspaceRepositoryConfiguration

Configurações de integração do Git

Name Tipo Description
accountName

string

Nome da conta

collaborationBranch

string

Ramo de colaboração

hostName

string

Nome do host do GitHub Enterprise. Por exemplo: https://github.mydomain.com

lastCommitId

string

A última ID de confirmação

projectName

string

Nome do projeto VSTS

repositoryName

string

Nome do repositório

rootFolder

string

Pasta raiz a ser usada no repositório

tenantId

string (uuid)

O ID do locatário VSTS

type

string

Tipo de configuração repositoryID do espaço de trabalho. Exemplo WorkspaceVSTSConfiguration, WorkspaceGitHubConfiguration