Compartilhar via


Workspaces - Create Or Update

Cria um novo espaço de trabalho.

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

Parâmetros de URI

Nome Em Obrigató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 (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.

workspaceName
path True

string

minLength: 3
maxLength: 64

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 da solicitação

Nome Obrigatório Tipo Description
location True

string

A localização geográfica onde o recurso reside

properties.computeMode True

ComputeMode

O modo de computação do workspace. Necessário na criação, não pode ser alterado. Os valores possíveis incluem: 'Sem servidor', 'Híbrido'

properties.accessConnector

WorkspacePropertiesAccessConnector

Recurso do Conector de Acesso que será associado ao Workspace do Databricks. Não permitido no workspace Serverless ComputeMode.

properties.authorizations

WorkspaceProviderAuthorization[]

As autorizações do provedor de workspace.

properties.createdBy

CreatedBy

Indica a ID do objeto, a PUID e a ID do aplicativo da entidade que criou o workspace.

properties.defaultCatalog

DefaultCatalogProperties

Propriedades para a configuração padrão do catálogo durante a criação do workspace. Não permitido no workspace Serverless ComputeMode.

properties.defaultStorageFirewall

DefaultStorageFirewall

Obtém ou define informações de configuração do Firewall de armazenamento padrão. Não permitido no workspace Serverless ComputeMode.

properties.encryption

WorkspacePropertiesEncryption

Propriedades de criptografia para workspace do Databricks. Com suporte no workspace Serverless e Hybrid ComputeMode.

properties.enhancedSecurityCompliance

EnhancedSecurityComplianceDefinition

Contém configurações relacionadas ao Complemento avançado de Segurança e Conformidade. Com suporte no workspace Serverless e Hybrid ComputeMode.

properties.managedDiskIdentity

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada do Conjunto de Criptografia de Disco usado para Criptografia de Disco Gerenciado. Retornado apenas no workspace Hybrid ComputeMode.

properties.managedResourceGroupId

string

A ID do grupo de recursos gerenciados. Necessário no workspace Hybrid ComputeMode. Não permitido no workspace Serverless ComputeMode.

properties.parameters

WorkspaceCustomParameters

Os parâmetros personalizados do workspace.

properties.publicNetworkAccess

PublicNetworkAccess

O tipo de acesso à rede para acessar o workspace. Defina o valor como desabilitado para acessar o workspace somente por meio de link privado. Usado para configurar um link privado apenas front-end para o workspace Serverless ComputeMode.

properties.requiredNsgRules

RequiredNsgRules

Obtém ou define um valor que indica se o plano de dados (clusters) para controlar a comunicação do plano ocorre no ponto de extremidade privado. Os valores com suporte são 'AllRules' e 'NoAzureDatabricksRules'. O valor 'NoAzureServiceRules' é apenas para uso interno. Não permitido no workspace Serverless ComputeMode.

properties.storageAccountIdentity

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada da Conta de Armazenamento. Retornado apenas no workspace Hybrid ComputeMode.

properties.uiDefinitionUri

string

O URI do blob em que o arquivo de definição da interface do usuário está localizado.

properties.updatedBy

CreatedBy

Indica a ID do objeto, a PUID e a ID do aplicativo da entidade que atualizou o workspace pela última vez.

sku

Sku

A SKU do recurso.

tags

object

Tags de recursos.

Respostas

Nome Tipo Description
200 OK

Workspace

Operação de atualização do recurso 'Espaço de trabalho' bem-sucedida

201 Created

Workspace

Operação de criação do recurso 'Workspace' bem-sucedida

Cabeçalhos

  • Location: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

Create a workspace which is ready for Customer-Managed Key (CMK) encryption
Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks
Create or update a workspace with Enhanced Security & Compliance Add-On
Create or update serverless workspace
Create or update workspace
Create or update workspace with custom parameters
Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption
Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace
Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks

Create a workspace which is ready for Customer-Managed Key (CMK) encryption

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "location": "westus",
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "prepareEncryption": {
        "value": true
      }
    }
  },
  "sku": {
    "name": "premium"
  }
}

Resposta de exemplo

{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Succeeded",
    "storageAccountIdentity": {
      "type": "SystemAssigned",
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666"
    },
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  }
}
{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    }
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "environment": "dev"
  }
}

Create a workspace with Customer-Managed Key (CMK) encryption for Managed Disks

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "location": "westus",
  "properties": {
    "computeMode": "Hybrid",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyName": "test-cmk-key",
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG"
  },
  "sku": {
    "name": "premium"
  }
}

Resposta de exemplo

{
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyName": "test-cmk-key",
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "isUcEnabled": true,
    "managedDiskIdentity": {
      "type": "SystemAssigned",
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444"
    },
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  },
  "tags": null
}
{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyName": "test-cmk-key",
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "isUcEnabled": true,
    "managedDiskIdentity": {
      "type": "SystemAssigned",
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444"
    },
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    }
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "environment": "dev"
  }
}

Create or update a workspace with Enhanced Security & Compliance Add-On

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "location": "eastus2",
  "properties": {
    "computeMode": "Hybrid",
    "enhancedSecurityCompliance": {
      "automaticClusterUpdate": {
        "value": "Enabled"
      },
      "complianceSecurityProfile": {
        "complianceStandards": [
          "PCI_DSS",
          "HIPAA"
        ],
        "value": "Enabled"
      },
      "enhancedSecurityMonitoring": {
        "value": "Enabled"
      }
    },
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG"
  },
  "sku": {
    "name": "premium"
  }
}

Resposta de exemplo

{
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2023-08-24T00:10:29.2858439Z",
    "enhancedSecurityCompliance": {
      "automaticClusterUpdate": {
        "value": "Enabled"
      },
      "complianceSecurityProfile": {
        "complianceStandards": [
          "PCI_DSS",
          "HIPAA"
        ],
        "value": "Enabled"
      },
      "enhancedSecurityMonitoring": {
        "value": "Enabled"
      }
    },
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  },
  "tags": null
}
{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2023-08-24T00:10:29.2858439Z",
    "enhancedSecurityCompliance": {
      "automaticClusterUpdate": {
        "value": "Enabled"
      },
      "complianceSecurityProfile": {
        "complianceStandards": [
          "PCI_DSS",
          "HIPAA"
        ],
        "value": "Enabled"
      },
      "enhancedSecurityMonitoring": {
        "value": "Enabled"
      }
    },
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    }
  },
  "sku": {
    "name": "premium"
  },
  "tags": null
}

Create or update serverless workspace

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "location": "westus",
  "properties": {
    "computeMode": "Serverless"
  },
  "sku": {
    "name": "premium"
  }
}

Resposta de exemplo

{
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Serverless",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "defaultCatalog": {
      "initialName": "",
      "initialType": "UnityCatalog"
    },
    "isUcEnabled": true,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  },
  "tags": null
}
{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Serverless",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "isUcEnabled": true,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    }
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "environment": "dev"
  }
}

Create or update workspace

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "location": "westus",
  "properties": {
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "SystemAssigned"
    },
    "computeMode": "Hybrid",
    "defaultCatalog": {
      "initialName": "",
      "initialType": "UnityCatalog"
    },
    "defaultStorageFirewall": "Enabled",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG"
  },
  "sku": {
    "name": "premium"
  }
}

Resposta de exemplo

{
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "SystemAssigned"
    },
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "defaultCatalog": {
      "initialName": "",
      "initialType": "UnityCatalog"
    },
    "defaultStorageFirewall": "Enabled",
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  },
  "tags": null
}
{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "SystemAssigned"
    },
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "defaultStorageFirewall": "Enabled",
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    }
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "environment": "dev"
  }
}

Create or update workspace with custom parameters

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "location": "westus",
  "properties": {
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "UserAssigned",
      "userAssignedIdentityId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
    },
    "computeMode": "Hybrid",
    "defaultCatalog": {
      "initialName": "",
      "initialType": "HiveMetastore"
    },
    "defaultStorageFirewall": "Enabled",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "value": "myPrivateSubnet"
      },
      "customPublicSubnetName": {
        "value": "myPublicSubnet"
      },
      "customVirtualNetworkId": {
        "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      }
    }
  },
  "sku": {
    "name": "premium"
  }
}

Resposta de exemplo

{
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "UserAssigned",
      "userAssignedIdentityId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
    },
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "defaultCatalog": {
      "initialName": "",
      "initialType": "HiveMetastore"
    },
    "defaultStorageFirewall": "Enabled",
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "type": "String",
        "value": "myPrivateSubnet"
      },
      "customPublicSubnetName": {
        "type": "String",
        "value": "myPublicSubnet"
      },
      "customVirtualNetworkId": {
        "type": "String",
        "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      }
    },
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  },
  "tags": null
}
{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "accessConnector": {
      "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/adbrg/providers/Microsoft.Databricks/accessConnectors/myAccessConnector",
      "identityType": "UserAssigned",
      "userAssignedIdentityId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity"
    },
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "defaultCatalog": {
      "initialName": "",
      "initialType": "HiveMetastore"
    },
    "defaultStorageFirewall": "Enabled",
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "provisioningState": "Accepted",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    }
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "environment": "dev"
  }
}

Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "location": "westus",
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "encryption": {
        "value": {
          "KeyName": "myKeyName",
          "keySource": "Microsoft.Keyvault",
          "keyvaulturi": "https://myKeyVault.vault.azure.net/",
          "keyversion": "00000000000000000000000000000000"
        }
      },
      "prepareEncryption": {
        "value": true
      }
    }
  },
  "sku": {
    "name": "premium"
  }
}

Resposta de exemplo

{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "type": "String",
        "value": "PrivateBob"
      },
      "customPublicSubnetName": {
        "type": "String",
        "value": "PublicSarah"
      },
      "customVirtualNetworkId": {
        "type": "String",
        "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      },
      "encryption": {
        "type": "Object",
        "value": {
          "KeyName": "myKeyName",
          "keySource": "Microsoft.Keyvault",
          "keyvaulturi": "https://myKeyVault.vault.azure.net/",
          "keyversion": "00000000000000000000000000000000"
        }
      },
      "prepareEncryption": {
        "type": "Bool",
        "value": true
      }
    },
    "provisioningState": "Succeeded",
    "storageAccountIdentity": {
      "type": "SystemAssigned",
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666"
    },
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  }
}
{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "provisioningState": "Accepted",
    "storageAccountIdentity": {
      "type": "SystemAssigned",
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666"
    },
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    }
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "environment": "dev"
  }
}

Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "location": "westus",
  "properties": {
    "computeMode": "Hybrid",
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "encryption": {
        "value": {
          "keySource": "Default"
        }
      }
    }
  },
  "sku": {
    "name": "premium"
  }
}

Resposta de exemplo

{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": {
      "customPrivateSubnetName": {
        "type": "String",
        "value": "PrivateBob"
      },
      "customPublicSubnetName": {
        "type": "String",
        "value": "PublicSarah"
      },
      "customVirtualNetworkId": {
        "type": "String",
        "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      },
      "encryption": {
        "type": "Object",
        "value": {
          "keySource": "Default"
        }
      },
      "prepareEncryption": {
        "type": "Bool",
        "value": true
      }
    },
    "provisioningState": "Succeeded",
    "storageAccountIdentity": {
      "type": "SystemAssigned",
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666"
    },
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  }
}
{
  "name": "myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "isUcEnabled": true,
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "provisioningState": "Accepted",
    "storageAccountIdentity": {
      "type": "SystemAssigned",
      "principalId": "55555555-5555-5555-5555-555555555555",
      "tenantId": "66666666-6666-6666-6666-666666666666"
    },
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    }
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "environment": "dev"
  }
}

Update a workspace with Customer-Managed Key (CMK) encryption for Managed Disks

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace?api-version=2026-01-01

{
  "location": "westus",
  "properties": {
    "computeMode": "Hybrid",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyName": "test-cmk-key",
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG"
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "mytag1": "myvalue1"
  }
}

Resposta de exemplo

{
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyName": "test-cmk-key",
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "isUcEnabled": true,
    "managedDiskIdentity": {
      "type": "SystemAssigned",
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444"
    },
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "6666666666666666",
    "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "mytag1": "myvalue1"
  }
}
{
  "type": "Microsoft.Databricks/workspaces",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "location": "East US 2",
  "properties": {
    "authorizations": [
      {
        "principalId": "00000000-0000-0000-0000-000000000000",
        "roleDefinitionId": "11111111-1111-1111-1111-111111111111"
      }
    ],
    "computeMode": "Hybrid",
    "createdBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "diskEncryptionSetId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet",
    "encryption": {
      "entities": {
        "managedDisk": {
          "keySource": "Microsoft.Keyvault",
          "keyVaultProperties": {
            "keyName": "test-cmk-key",
            "keyVaultUri": "https://test-vault-name.vault.azure.net/",
            "keyVersion": "00000000000000000000000000000000"
          },
          "rotationToLatestKeyVersionEnabled": true
        }
      }
    },
    "isUcEnabled": true,
    "managedDiskIdentity": {
      "type": "SystemAssigned",
      "principalId": "22222222-2222-2222-2222-222222222222",
      "tenantId": "44444444-4444-4444-4444-444444444444"
    },
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "parameters": null,
    "provisioningState": "Succeeded",
    "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json",
    "updatedBy": {
      "applicationId": "44444444-4444-4444-4444-444444444444",
      "oid": "22222222-2222-2222-2222-222222222222",
      "puid": "33333333"
    },
    "workspaceId": "6666666666666666",
    "workspaceUrl": "adb-6666666666666666.19.azuredatabricks.net"
  },
  "sku": {
    "name": "premium"
  },
  "tags": {
    "mytag1": "myvalue1"
  }
}

Definições

Nome Description
AutomaticClusterUpdateDefinition

Status do recurso de atualizações de cluster automatizado.

AutomaticClusterUpdateValue
ComplianceSecurityProfileDefinition

Status do recurso Perfil de Segurança de Conformidade.

ComplianceSecurityProfileValue
ComputeMode

O modo de computação do workspace. Necessário na criação, não pode ser alterado. Os valores possíveis incluem: 'Sem servidor', 'Híbrido'

CreatedBy

Fornece detalhes da entidade que criou/atualizou o espaço de trabalho.

CustomParameterType

Os parâmetros personalizados do workspace.

DefaultCatalogProperties

Essas propriedades permitem que o usuário especifique as propriedades padrão do catálogo durante a criação do espaço de trabalho. Não permitido no workspace Serverless ComputeMode.

DefaultStorageFirewall

Obtém ou define informações de configuração do Firewall de armazenamento padrão. Não permitido no workspace Serverless ComputeMode.

Encryption

O objeto que contém detalhes da criptografia usada no workspace.

EncryptionEntitiesDefinition

Entidades de criptografia para o recurso de workspace do Databricks.

EncryptionKeySource

A chave de criptografiaSource (provedor). Valores possíveis (que não diferenciam maiúsculas de minúsculas): Microsoft.Keyvault

EncryptionV2

O objeto que contém detalhes da criptografia usada no workspace.

EncryptionV2KeyVaultProperties

Propriedades de entrada do Key Vault para criptografia.

EnhancedSecurityComplianceDefinition

Status das configurações relacionadas ao Complemento de Segurança e Conformidade Aprimoradas.

EnhancedSecurityMonitoringDefinition

Status do recurso monitoramento de segurança aprimorado.

EnhancedSecurityMonitoringValue
ErrorDetail

Detalhes do erro.

ErrorInfo

O código e a mensagem de um erro.

ErrorResponse

Contém detalhes quando o código de resposta indica um erro.

IdentityType

O tipo de identidade do Recurso do Conector de Acesso.

InitialType

Define o tipo inicial do catálogo padrão. Valores possíveis (que não diferenciam maiúsculas de minúsculas): HiveMetastore, UnityCatalog

KeySource

A chave de criptografiaSource (provedor). Valores possíveis (que não diferenciam maiúsculas de minúsculas): Padrão, Microsoft.Keyvault

ManagedDiskEncryption

O objeto que contém detalhes da criptografia usada no workspace.

ManagedDiskEncryptionKeyVaultProperties

Propriedades de entrada do Key Vault para criptografia.

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada da conta de armazenamento.

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado.

PrivateEndpointConnection

A conexão de ponto de extremidade privado de um workspace.

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privado.

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

PrivateLinkServiceConnectionState

O estado atual de uma conexão de ponto de extremidade privado.

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privado

ProvisioningState

Status de provisionamento do workspace.

PublicNetworkAccess

O tipo de acesso à rede para acessar o workspace. Defina o valor como desabilitado para acessar o workspace somente por meio de link privado. Usado para configurar um link privado apenas front-end para o workspace Serverless ComputeMode.

RequiredNsgRules

Obtém ou define um valor que indica se o plano de dados (clusters) para controlar a comunicação do plano ocorre no ponto de extremidade privado. Os valores com suporte são 'AllRules' e 'NoAzureDatabricksRules'. O valor 'NoAzureServiceRules' é apenas para uso interno. Não permitido no workspace Serverless ComputeMode.

Sku

SKU para o recurso.

Workspace

Informações sobre o espaço de trabalho.

WorkspaceCustomBooleanParameter

O valor que deve ser usado para esse campo.

WorkspaceCustomObjectParameter

O valor que deve ser usado para esse campo.

WorkspaceCustomParameters

Parâmetros Personalizados usados para Criação de Workspace. Não permitido no workspace Serverless ComputeMode.

WorkspaceCustomStringParameter

O valor.

WorkspaceEncryptionParameter

O objeto que contém detalhes da criptografia usada no workspace.

WorkspaceNoPublicIPBooleanParameter

O valor que deve ser usado para esse campo.

WorkspacePropertiesAccessConnector

Recurso do Conector de Acesso que será associado ao Workspace do Databricks. Não permitido no workspace Serverless ComputeMode.

WorkspacePropertiesEncryption

Propriedades de criptografia para workspace do Databricks. Com suporte no workspace Serverless e Hybrid ComputeMode.

WorkspaceProviderAuthorization

A autorização do provedor de espaço de trabalho.

AutomaticClusterUpdateDefinition

Status do recurso de atualizações de cluster automatizado.

Nome Tipo Description
value

AutomaticClusterUpdateValue

AutomaticClusterUpdateValue

Valor Description
Enabled

Habilitado

Disabled

Desactivado

ComplianceSecurityProfileDefinition

Status do recurso Perfil de Segurança de Conformidade.

Nome Tipo Description
complianceStandards

string[]

Padrões de conformidade associados ao workspace.

value

ComplianceSecurityProfileValue

ComplianceSecurityProfileValue

Valor Description
Enabled

Habilitado

Disabled

Desactivado

ComputeMode

O modo de computação do workspace. Necessário na criação, não pode ser alterado. Os valores possíveis incluem: 'Sem servidor', 'Híbrido'

Valor Description
Serverless

Sem servidor

Hybrid

Híbrido

CreatedBy

Fornece detalhes da entidade que criou/atualizou o espaço de trabalho.

Nome Tipo Description
applicationId

string (uuid)

A ID do aplicativo que iniciou a criação do espaço de trabalho. Por exemplo, Portal do Azure.

oid

string (uuid)

A ID do objeto que criou o espaço de trabalho.

puid

string

O ID do objeto pessoal correspondente ao ID do objeto acima

CustomParameterType

Os parâmetros personalizados do workspace.

Valor Description
Bool

Bool

Object

Objeto

String

String

DefaultCatalogProperties

Essas propriedades permitem que o usuário especifique as propriedades padrão do catálogo durante a criação do espaço de trabalho. Não permitido no workspace Serverless ComputeMode.

Nome Tipo Valor padrão Description
initialName

string

Especifica o nome inicial do catálogo padrão. Se não for especificado, o nome do workspace será usado.

initialType

InitialType

HiveMetastore

Define o tipo inicial do catálogo padrão. Valores possíveis (que não diferenciam maiúsculas de minúsculas): HiveMetastore, UnityCatalog

DefaultStorageFirewall

Obtém ou define informações de configuração do Firewall de armazenamento padrão. Não permitido no workspace Serverless ComputeMode.

Valor Description
Disabled

Desactivado

Enabled

Habilitado

Encryption

O objeto que contém detalhes da criptografia usada no workspace.

Nome Tipo Valor padrão Description
KeyName

string

O nome da chave KeyVault.

keySource

KeySource

Default

A chave de criptografiaSource (provedor). Valores possíveis (que não diferenciam maiúsculas de minúsculas): Padrão, Microsoft.Keyvault

keyvaulturi

string

O Uri de KeyVault.

keyversion

string

A versão da chave KeyVault.

EncryptionEntitiesDefinition

Entidades de criptografia para o recurso de workspace do Databricks.

Nome Tipo Description
managedDisk

ManagedDiskEncryption

Propriedades de criptografia para os discos gerenciados do databricks. Não permitido no workspace Serverless ComputeMode.

managedServices

EncryptionV2

Propriedades de criptografia para os serviços gerenciados do databricks. Com suporte em Serverless e Hybrid ComputeMode.

EncryptionKeySource

A chave de criptografiaSource (provedor). Valores possíveis (que não diferenciam maiúsculas de minúsculas): Microsoft.Keyvault

Valor Description
Microsoft.Keyvault

Microsoft.Keyvault

EncryptionV2

O objeto que contém detalhes da criptografia usada no workspace.

Nome Tipo Description
keySource

EncryptionKeySource

A chave de criptografiaSource (provedor). Valores possíveis (que não diferenciam maiúsculas de minúsculas): Microsoft.Keyvault

keyVaultProperties

EncryptionV2KeyVaultProperties

Propriedades de entrada do Key Vault para criptografia.

EncryptionV2KeyVaultProperties

Propriedades de entrada do Key Vault para criptografia.

Nome Tipo Description
keyName

string

O nome da chave KeyVault.

keyVaultUri

string

O Uri de KeyVault.

keyVersion

string

A versão da chave KeyVault.

EnhancedSecurityComplianceDefinition

Status das configurações relacionadas ao Complemento de Segurança e Conformidade Aprimoradas.

Nome Tipo Description
automaticClusterUpdate

AutomaticClusterUpdateDefinition

Status do recurso de atualizações de cluster automatizado.

complianceSecurityProfile

ComplianceSecurityProfileDefinition

Status do recurso Perfil de Segurança de Conformidade.

enhancedSecurityMonitoring

EnhancedSecurityMonitoringDefinition

Status do recurso monitoramento de segurança aprimorado.

EnhancedSecurityMonitoringDefinition

Status do recurso monitoramento de segurança aprimorado.

Nome Tipo Description
value

EnhancedSecurityMonitoringValue

EnhancedSecurityMonitoringValue

Valor Description
Enabled

Habilitado

Disabled

Desactivado

ErrorDetail

Detalhes do erro.

Nome Tipo Description
code

string

O código do erro.

message

string

Uma mensagem de erro legível por humanos.

target

string

Indica qual propriedade na solicitação é responsável pelo erro.

ErrorInfo

O código e a mensagem de um erro.

Nome Tipo Description
code

string

Um código de erro legível por máquina.

details

ErrorDetail[]

Detalhes do erro.

innererror

string

Detalhes do erro interno, se existirem.

message

string

Uma mensagem de erro legível por humanos.

ErrorResponse

Contém detalhes quando o código de resposta indica um erro.

Nome Tipo Description
error

ErrorInfo

Os detalhes do erro.

IdentityType

O tipo de identidade do Recurso do Conector de Acesso.

Valor Description
SystemAssigned

SystemAssigned

UserAssigned

UserAssigned

InitialType

Define o tipo inicial do catálogo padrão. Valores possíveis (que não diferenciam maiúsculas de minúsculas): HiveMetastore, UnityCatalog

Valor Description
HiveMetastore

HiveMetastore

UnityCatalog

UnityCatalog

KeySource

A chave de criptografiaSource (provedor). Valores possíveis (que não diferenciam maiúsculas de minúsculas): Padrão, Microsoft.Keyvault

Valor Description
Default

Default

Microsoft.Keyvault

Microsoft.Keyvault

ManagedDiskEncryption

O objeto que contém detalhes da criptografia usada no workspace.

Nome Tipo Description
keySource

EncryptionKeySource

A chave de criptografiaSource (provedor). Valores possíveis (sem distinção entre maiúsculas e minúsculas): Microsoft.Keyvault. Não permitido no workspace Serverless ComputeMode.

keyVaultProperties

ManagedDiskEncryptionKeyVaultProperties

Propriedades de entrada do Key Vault para criptografia.

rotationToLatestKeyVersionEnabled

boolean

Indique se a versão mais recente da chave deve ser usada automaticamente para a Criptografia de Disco Gerenciado.

ManagedDiskEncryptionKeyVaultProperties

Propriedades de entrada do Key Vault para criptografia.

Nome Tipo Description
keyName

string

O nome da chave KeyVault.

keyVaultUri

string

O URI de KeyVault.

keyVersion

string

A versão da chave KeyVault.

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada da conta de armazenamento.

Nome Tipo Description
principalId

string (uuid)

O objectId da Identidade Gerenciada vinculada à conta de Armazenamento Gerenciado.

tenantId

string (uuid)

A ID do locatário em que a Identidade Gerenciada é criada.

type

string

O tipo de identidade criada. Ele pode ser SystemAssigned ou UserAssigned.

PrivateEndpoint

A propriedade de ponto de extremidade privado de uma conexão de ponto de extremidade privado.

Nome Tipo Description
id

string

O identificador de recurso.

PrivateEndpointConnection

A conexão de ponto de extremidade privado de um workspace.

Nome Tipo Description
id

string

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

name

string

O nome do recurso

properties

PrivateEndpointConnectionProperties

As propriedades de conexão do ponto de extremidade privado.

type

string

O tipo do recurso. Ex- Microsoft.Compute/virtualMachines ou Microsoft.Storage/storageAccounts.

PrivateEndpointConnectionProperties

As propriedades de uma conexão de ponto de extremidade privado.

Nome Tipo Description
groupIds

string[]

GroupIds do recurso de serviço de link privado.

privateEndpoint

PrivateEndpoint

Ponto de extremidade privado

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Estado de conexão de ponto de extremidade privado

provisioningState

PrivateEndpointConnectionProvisioningState

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

PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.

Valor Description
Succeeded

Succeeded

Creating

Criando

Updating

Atualização

Deleting

Excluindo

Failed

Falha

PrivateLinkServiceConnectionState

O estado atual de uma conexão de ponto de extremidade privado.

Nome Tipo Description
actionsRequired

string

Ações necessárias para uma conexão de ponto de extremidade privado

description

string

A descrição do estado atual de uma conexão de ponto de extremidade privado

status

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privado

PrivateLinkServiceConnectionStatus

O status de uma conexão de ponto de extremidade privado

Valor Description
Pending

Pendente

Approved

Aprovada

Rejected

Rejeitado

Disconnected

Desconectado

ProvisioningState

Status de provisionamento do workspace.

Valor Description
Accepted

Aceitado

Running

Em execução

Ready

Pronto

Creating

Criando

Created

Criado

Deleting

Excluindo

Deleted

Excluída

Canceled

Cancelado

Failed

Falha

Succeeded

Succeeded

Updating

Atualização

PublicNetworkAccess

O tipo de acesso à rede para acessar o workspace. Defina o valor como desabilitado para acessar o workspace somente por meio de link privado. Usado para configurar um link privado apenas front-end para o workspace Serverless ComputeMode.

Valor Description
Enabled

Habilitado

Disabled

Desactivado

RequiredNsgRules

Obtém ou define um valor que indica se o plano de dados (clusters) para controlar a comunicação do plano ocorre no ponto de extremidade privado. Os valores com suporte são 'AllRules' e 'NoAzureDatabricksRules'. O valor 'NoAzureServiceRules' é apenas para uso interno. Não permitido no workspace Serverless ComputeMode.

Valor Description
AllRules

Todas as Regras

NoAzureDatabricksRules

NoAzureDatabricksRules

NoAzureServiceRules

NoAzureServiceRules

Sku

SKU para o recurso.

Nome Tipo Description
name

string

O nome da SKU.

tier

string

A camada de SKU.

Workspace

Informações sobre o espaço de trabalho.

Nome Tipo Description
id

string

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

location

string

A localização geográfica onde o recurso reside

name

string

O nome do recurso

properties.accessConnector

WorkspacePropertiesAccessConnector

Recurso do Conector de Acesso que será associado ao Workspace do Databricks. Não permitido no workspace Serverless ComputeMode.

properties.authorizations

WorkspaceProviderAuthorization[]

As autorizações do provedor de workspace.

properties.computeMode

ComputeMode

O modo de computação do workspace. Necessário na criação, não pode ser alterado. Os valores possíveis incluem: 'Sem servidor', 'Híbrido'

properties.createdBy

CreatedBy

Indica a ID do objeto, a PUID e a ID do aplicativo da entidade que criou o workspace.

properties.createdDateTime

string (date-time)

Especifica a data e a hora em que o espaço de trabalho é criado.

properties.defaultCatalog

DefaultCatalogProperties

Propriedades para a configuração padrão do catálogo durante a criação do workspace. Não permitido no workspace Serverless ComputeMode.

properties.defaultStorageFirewall

DefaultStorageFirewall

Obtém ou define informações de configuração do Firewall de armazenamento padrão. Não permitido no workspace Serverless ComputeMode.

properties.diskEncryptionSetId

string

A ID do recurso do conjunto de criptografia de disco gerenciado. Não permitido no workspace Serverless ComputeMode.

properties.encryption

WorkspacePropertiesEncryption

Propriedades de criptografia para workspace do Databricks. Com suporte no workspace Serverless e Hybrid ComputeMode.

properties.enhancedSecurityCompliance

EnhancedSecurityComplianceDefinition

Contém configurações relacionadas ao Complemento avançado de Segurança e Conformidade. Com suporte no workspace Serverless e Hybrid ComputeMode.

properties.isUcEnabled

boolean

Indica se o catálogo do Unity está habilitado para o workspace ou não. Defina como true no workspace Serverless ComputeMode.

properties.managedDiskIdentity

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada do Conjunto de Criptografia de Disco usado para Criptografia de Disco Gerenciado. Retornado apenas no workspace Hybrid ComputeMode.

properties.managedResourceGroupId

string

A ID do grupo de recursos gerenciados. Necessário no workspace Hybrid ComputeMode. Não permitido no workspace Serverless ComputeMode.

properties.parameters

WorkspaceCustomParameters

Os parâmetros personalizados do workspace.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privado criadas no workspace. Com suporte no workspace Serverless e Hybrid ComputeMode.

properties.provisioningState

ProvisioningState

O estado de provisionamento do workspace.

properties.publicNetworkAccess

PublicNetworkAccess

O tipo de acesso à rede para acessar o workspace. Defina o valor como desabilitado para acessar o workspace somente por meio de link privado. Usado para configurar um link privado apenas front-end para o workspace Serverless ComputeMode.

properties.requiredNsgRules

RequiredNsgRules

Obtém ou define um valor que indica se o plano de dados (clusters) para controlar a comunicação do plano ocorre no ponto de extremidade privado. Os valores com suporte são 'AllRules' e 'NoAzureDatabricksRules'. O valor 'NoAzureServiceRules' é apenas para uso interno. Não permitido no workspace Serverless ComputeMode.

properties.storageAccountIdentity

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada da Conta de Armazenamento. Retornado apenas no workspace Hybrid ComputeMode.

properties.uiDefinitionUri

string

O URI do blob em que o arquivo de definição da interface do usuário está localizado.

properties.updatedBy

CreatedBy

Indica a ID do objeto, a PUID e a ID do aplicativo da entidade que atualizou o workspace pela última vez.

properties.workspaceId

string

O identificador exclusivo do workspace do Databricks no painel de controle do Databricks.

properties.workspaceUrl

string

A URL do espaço de trabalho que está no formato 'adb-{workspaceId}. {aleatório}.azuredatabricks.net'

sku

Sku

A SKU do recurso.

tags

object

Tags de recursos.

type

string

O tipo do recurso. Ex- Microsoft.Compute/virtualMachines ou Microsoft.Storage/storageAccounts.

WorkspaceCustomBooleanParameter

O valor que deve ser usado para esse campo.

Nome Tipo Description
type

CustomParameterType

O tipo de variável que é

value

boolean

O valor que deve ser usado para esse campo.

WorkspaceCustomObjectParameter

O valor que deve ser usado para esse campo.

Nome Tipo Description
type

CustomParameterType

O tipo de variável que é

value

O valor que deve ser usado para esse campo.

WorkspaceCustomParameters

Parâmetros Personalizados usados para Criação de Workspace. Não permitido no workspace Serverless ComputeMode.

Nome Tipo Description
amlWorkspaceId

WorkspaceCustomStringParameter

A ID de um workspace do Azure Machine Learning a ser vinculado ao workspace do Databricks. Não permitido no workspace Serverless ComputeMode.

customPrivateSubnetName

WorkspaceCustomStringParameter

O nome da Sub-rede Privada dentro da Rede Virtual. Não permitido no workspace Serverless ComputeMode.

customPublicSubnetName

WorkspaceCustomStringParameter

O nome de uma Sub-rede Pública dentro da Rede Virtual. Não permitido no workspace Serverless ComputeMode.

customVirtualNetworkId

WorkspaceCustomStringParameter

A ID de uma Rede Virtual em que esse Cluster do Databricks deve ser criado. Não permitido no workspace Serverless ComputeMode.

enableNoPublicIp

WorkspaceNoPublicIPBooleanParameter

Booliano indicando se o IP público deve ser desabilitado. O valor padrão é verdadeiro. Não permitido no workspace Serverless ComputeMode.

encryption

WorkspaceEncryptionParameter

Contém os detalhes de criptografia para o workspace habilitado para CMK (chave Customer-Managed). Não permitido no workspace Serverless ComputeMode.

loadBalancerBackendPoolName

WorkspaceCustomStringParameter

Nome do pool de back-end do Load Balancer de saída para conectividade de cluster seguro (sem IP público). Não permitido no workspace Serverless ComputeMode.

loadBalancerId

WorkspaceCustomStringParameter

URI de recurso do balanceador de carga de saída para o workspace conectividade de cluster seguro (sem IP público). Não permitido no workspace Serverless ComputeMode.

natGatewayName

WorkspaceCustomStringParameter

Nome do gateway nat para sub-redes de workspace de conectividade de cluster seguro (sem IP público). Não permitido no workspace Serverless ComputeMode.

prepareEncryption

WorkspaceCustomBooleanParameter

Prepare o workspace para criptografia. Habilita a Identidade Gerenciada para a conta de armazenamento gerenciada. Não permitido no workspace Serverless ComputeMode.

publicIpName

WorkspaceCustomStringParameter

Nome do IP público para nenhum workspace de IP público com vNet gerenciada. Não permitido no workspace Serverless ComputeMode.

requireInfrastructureEncryption

WorkspaceCustomBooleanParameter

Um booliano que indica se o sistema de arquivos raiz do DBFS será habilitado com uma camada secundária de criptografia com chaves gerenciadas pela plataforma para dados em repouso. Não permitido no workspace Serverless ComputeMode.

resourceTags

WorkspaceCustomObjectParameter

Tags aplicadas a recursos em Grupo de recursos gerenciados. Eles podem ser atualizados atualizando as tags no nível do workspace. Não permitido no workspace Serverless ComputeMode.

storageAccountName

WorkspaceCustomStringParameter

Nome da conta de armazenamento DBFS padrão. Não permitido no workspace Serverless ComputeMode.

storageAccountSkuName

WorkspaceCustomStringParameter

Nome da SKU da conta de armazenamento, por exemplo: Standard_GRS, Standard_LRS. Consulte https://aka.ms/storageskus de entradas válidas. Não permitido no workspace Serverless ComputeMode.

vnetAddressPrefix

WorkspaceCustomStringParameter

Prefixo de endereço para rede virtual gerenciada. O valor padrão dessa entrada é 10.139. Não permitido no workspace Serverless ComputeMode.

WorkspaceCustomStringParameter

O valor.

Nome Tipo Description
type

CustomParameterType

O tipo de variável que é

value

string

O valor que deve ser usado para esse campo.

WorkspaceEncryptionParameter

O objeto que contém detalhes da criptografia usada no workspace.

Nome Tipo Description
type

CustomParameterType

O tipo de variável que é

value

Encryption

O valor que deve ser usado para esse campo.

WorkspaceNoPublicIPBooleanParameter

O valor que deve ser usado para esse campo.

Nome Tipo Description
type

CustomParameterType

O tipo de variável que é

value

boolean

O valor que deve ser usado para esse campo.

WorkspacePropertiesAccessConnector

Recurso do Conector de Acesso que será associado ao Workspace do Databricks. Não permitido no workspace Serverless ComputeMode.

Nome Tipo Description
id

string (arm-id)

A ID do recurso do Conector de Acesso do Azure Databricks.

identityType

IdentityType

O tipo de identidade do Recurso do Conector de Acesso.

userAssignedIdentityId

string (arm-id)

A ID do recurso da Identidade Atribuída ao Usuário associada ao Recurso do Conector de Acesso. Isso é necessário para o tipo 'UserAssigned' e não é válido para o tipo 'SystemAssigned'.

WorkspacePropertiesEncryption

Propriedades de criptografia para workspace do Databricks. Com suporte no workspace Serverless e Hybrid ComputeMode.

Nome Tipo Description
entities

EncryptionEntitiesDefinition

Definição de entidades de criptografia para o workspace.

WorkspaceProviderAuthorization

A autorização do provedor de espaço de trabalho.

Nome Tipo Description
principalId

string (uuid)

O identificador principal do provedor. Essa é a identidade que o provedor usará para chamar o ARM para gerenciar os recursos do workspace.

roleDefinitionId

string (uuid)

O identificador de definição de função do provedor. Essa função definirá todas as permissões que o provedor deve ter no grupo de recursos de contêiner do workspace. Essa definição de função não pode ter permissão para excluir o grupo de recursos.