Compartilhar via


Workspaces - Create Or Update

Cria um novo workspace.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}?api-version=2024-05-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.managedResourceGroupId True

string

A ID do grupo de recursos gerenciados.

properties.accessConnector

AccessConnector

Recurso do Conector de Acesso que será associado ao Workspace do Databricks

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.

properties.defaultStorageFirewall

defaultStorageFirewall

Obtém ou define informações de configuração do Firewall de Armazenamento Padrão

properties.encryption

WorkspaceProperties.Encryption

Propriedades de criptografia para o workspace do Databricks

properties.enhancedSecurityCompliance

EnhancedSecurityComplianceDefinition

Contém configurações relacionadas ao Complemento avançado de Segurança e Conformidade.

properties.managedDiskIdentity

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada do Conjunto de Criptografia de Disco usado para Criptografia de Disco Gerenciado

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.

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.

properties.storageAccountIdentity

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada da Conta de Armazenamento

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

Marcas de recurso.

Respostas

Nome Tipo Description
200 OK

Workspace

Criado – Retorna informações sobre o workspace, incluindo o status de provisionamento.

201 Created

Workspace

Criado – Retorna informações sobre o workspace, incluindo o status de provisionamento.

Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo 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 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=2024-05-01

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

Resposta de exemplo

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

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=2024-05-01

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

Resposta de exemplo

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

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=2024-05-01

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

Resposta de exemplo

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

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=2024-05-01

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

Resposta de exemplo

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

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=2024-05-01

{
  "properties": {
    "managedResourceGroupId": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/myManagedRG",
    "defaultCatalog": {
      "initialType": "HiveMetastore",
      "initialName": ""
    },
    "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"
    },
    "defaultStorageFirewall": "Enabled",
    "parameters": {
      "customVirtualNetworkId": {
        "value": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork"
      },
      "customPublicSubnetName": {
        "value": "myPublicSubnet"
      },
      "customPrivateSubnetName": {
        "value": "myPrivateSubnet"
      }
    }
  },
  "location": "westus"
}

Resposta de exemplo

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

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=2024-05-01

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

Resposta de exemplo

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

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=2024-05-01

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

Resposta de exemplo

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

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=2024-05-01

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

Resposta de exemplo

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

Definições

Nome Description
AccessConnector

Recurso do Conector de Acesso que será associado ao Workspace do Databricks

AutomaticClusterUpdateDefinition

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

AutomaticClusterUpdateValue
ComplianceSecurityProfileDefinition

Status do recurso Perfil de Segurança de Conformidade.

ComplianceSecurityProfileValue
ComplianceStandard

Padrões de conformidade associados ao workspace.

CreatedBy

Fornece detalhes da entidade que criou/atualizou o workspace.

createdByType

O tipo de identidade que criou o recurso.

CustomParameterType

O tipo de variável que esta é

DefaultCatalogProperties

Essas propriedades permitem que o usuário especifique propriedades de catálogo padrão durante a criação do workspace.

defaultStorageFirewall

Obtém ou define informações de configuração do Firewall de Armazenamento Padrão

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.

EnhancedSecurityComplianceDefinition

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

EnhancedSecurityMonitoringDefinition

Status do recurso monitoramento de segurança aprimorado.

EnhancedSecurityMonitoringValue
ErrorDetail

Detalhes do erro.

ErrorInfo

O código e a mensagem para um erro.

ErrorResponse

Resposta de 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

KeyVaultProperties

Propriedades de entrada do Key Vault para criptografia.

ManagedDiskEncryption

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

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada para a 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.

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.

Sku

SKU para o recurso.

systemData

Metadados relativos à criação e última modificação do recurso.

Workspace

Informações sobre workspace.

Workspace.WorkspaceProperties.Encryption

Propriedades de criptografia para o workspace do Databricks

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 cluster.

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.

WorkspaceProperties.Encryption

Propriedades de criptografia para o workspace do Databricks

WorkspaceProviderAuthorization

A autorização do provedor de workspace.

AccessConnector

Recurso do Conector de Acesso que será associado ao Workspace do Databricks

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'.

AutomaticClusterUpdateDefinition

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

Nome Tipo Description
value

AutomaticClusterUpdateValue

AutomaticClusterUpdateValue

Valor Description
Disabled
Enabled

ComplianceSecurityProfileDefinition

Status do recurso Perfil de Segurança de Conformidade.

Nome Tipo Description
complianceStandards

ComplianceStandard[]

Padrões de conformidade associados ao workspace.

value

ComplianceSecurityProfileValue

ComplianceSecurityProfileValue

Valor Description
Disabled
Enabled

ComplianceStandard

Padrões de conformidade associados ao workspace.

Valor Description
HIPAA
NONE
PCI_DSS

CreatedBy

Fornece detalhes da entidade que criou/atualizou o workspace.

Nome Tipo Description
applicationId

string (uuid)

A ID do aplicativo que iniciou a criação do workspace. Por exemplo, portal do Azure.

oid

string (uuid)

A ID do objeto que criou o workspace.

puid

string

A ID do objeto pessoal correspondente à ID do objeto acima

createdByType

O tipo de identidade que criou o recurso.

Valor Description
Application
Key
ManagedIdentity
User

CustomParameterType

O tipo de variável que esta é

Valor Description
Bool
Object
String

DefaultCatalogProperties

Essas propriedades permitem que o usuário especifique propriedades de catálogo padrão durante a criação do workspace.

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

Valor Description
Disabled
Enabled

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.

managedServices

EncryptionV2

Propriedades de criptografia para os serviços gerenciados do databricks.

EncryptionKeySource

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

Valor Description
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

KeyVaultProperties

Propriedades de entrada do Key Vault para criptografia.

EnhancedSecurityComplianceDefinition

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

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
Disabled
Enabled

ErrorDetail

Detalhes do erro.

Nome Tipo Description
code

string

O código do erro.

message

string

Uma mensagem de erro legível humana.

target

string

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

ErrorInfo

O código e a mensagem para um erro.

Nome Tipo Description
code

string

Um código de erro legível do computador.

details

ErrorDetail[]

detalhes do erro.

innererror

string

Detalhes de erro interno se eles existirem.

message

string

Uma mensagem de erro legível humana.

ErrorResponse

Resposta de erro.

Nome Tipo Description
error

ErrorInfo

O código e a mensagem para um erro.
Os detalhes do erro.

IdentityType

O tipo de identidade do Recurso do Conector de Acesso.

Valor Description
SystemAssigned
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
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
Microsoft.Keyvault

KeyVaultProperties

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.

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 (que não diferenciam maiúsculas de minúsculas): Microsoft.Keyvault

keyVaultProperties

KeyVaultProperties

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.

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada para a conta de armazenamento.

Nome Tipo Description
principalId

string (uuid)

A objectId da Identidade Gerenciada que está 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. 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

O identificador de recurso.

name

string

O nome do recurso.

properties

PrivateEndpointConnectionProperties

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

type

string

O tipo de recurso.

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
Ponto de extremidade privado

privateLinkServiceConnectionState

PrivateLinkServiceConnectionState

Estado de conexão do serviço de link privado
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
Creating
Deleting
Failed
Succeeded
Updating

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
Approved
Disconnected
Pending
Rejected

ProvisioningState

Status de provisionamento do workspace.

Valor Description
Accepted
Canceled
Created
Creating
Deleted
Deleting
Failed
Ready
Running
Succeeded
Updating

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.

Valor Description
Disabled
Enabled

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.

Valor Description
AllRules
NoAzureDatabricksRules
NoAzureServiceRules

Sku

SKU para o recurso.

Nome Tipo Description
name

string

O nome da SKU.

tier

string

A camada de SKU.

systemData

Metadados relativos à criação e última modificação do recurso.

Nome Tipo Description
createdAt

string (date-time)

O carimbo de data/hora da criação de recursos (UTC).

createdBy

string

A identidade que criou o recurso.

createdByType

createdByType

O tipo de identidade que criou o recurso.

lastModifiedAt

string (date-time)

O carimbo de data/hora da última modificação do recurso (UTC)

lastModifiedBy

string

A identidade que modificou o recurso pela última vez.

lastModifiedByType

createdByType

O tipo de identidade que modificou o recurso pela última vez.

Workspace

Informações sobre workspace.

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

AccessConnector

Recurso do Conector de Acesso que será associado ao Workspace do Databricks

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.createdDateTime

string (date-time)

Especifica a data e a hora em que o workspace é criado.

properties.defaultCatalog

DefaultCatalogProperties

Propriedades para a configuração padrão do catálogo durante a criação do workspace.

properties.defaultStorageFirewall

defaultStorageFirewall

Obtém ou define informações de configuração do Firewall de Armazenamento Padrão

properties.diskEncryptionSetId

string

A ID do recurso do conjunto de criptografia de disco gerenciado.

properties.encryption

WorkspaceProperties.Encryption

Propriedades de criptografia para o workspace do Databricks

properties.enhancedSecurityCompliance

EnhancedSecurityComplianceDefinition

Contém configurações relacionadas ao Complemento avançado de Segurança e Conformidade.

properties.isUcEnabled

boolean

Indica se o catálogo do Unity está habilitado para o workspace ou não.

properties.managedDiskIdentity

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada do Conjunto de Criptografia de Disco usado para Criptografia de Disco Gerenciado

properties.managedResourceGroupId

string

A ID do grupo de recursos gerenciados.

properties.parameters

WorkspaceCustomParameters

Os parâmetros personalizados do workspace.

properties.privateEndpointConnections

PrivateEndpointConnection[]

Conexões de ponto de extremidade privado criadas no workspace

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.

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.

properties.storageAccountIdentity

ManagedIdentityConfiguration

Os detalhes da Identidade Gerenciada da Conta de Armazenamento

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 plano de controle do databricks.

properties.workspaceUrl

string

A URL do workspace que é do formato 'adb-{workspaceId}. {random}.azuredatabricks.net'

sku

Sku

A SKU do recurso.

systemData

systemData

Os metadados do sistema relacionados a esse recurso

tags

object

Marcas de recurso.

type

string

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

Workspace.WorkspaceProperties.Encryption

Propriedades de criptografia para o workspace do Databricks

Nome Tipo Description
entities

EncryptionEntitiesDefinition

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

WorkspaceCustomBooleanParameter

O valor que deve ser usado para esse campo.

Nome Tipo Description
type

CustomParameterType

O tipo de variável que esta é

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 esta é

value

object

O valor que deve ser usado para esse campo.

WorkspaceCustomParameters

Parâmetros personalizados usados para criação de cluster.

Nome Tipo Description
amlWorkspaceId

WorkspaceCustomStringParameter

A ID de um workspace do Azure Machine Learning para vincular ao workspace do Databricks

customPrivateSubnetName

WorkspaceCustomStringParameter

O nome da sub-rede privada na Rede Virtual

customPublicSubnetName

WorkspaceCustomStringParameter

O nome de uma sub-rede pública na Rede Virtual

customVirtualNetworkId

WorkspaceCustomStringParameter

A ID de uma rede virtual em que esse cluster do Databricks deve ser criado

enableNoPublicIp

WorkspaceNoPublicIPBooleanParameter

Booliano indicando se o IP público deve ser desabilitado. O valor padrão é verdadeiro

encryption

WorkspaceEncryptionParameter

Contém os detalhes de criptografia do workspace habilitado para CMK (chave Customer-Managed).

loadBalancerBackendPoolName

WorkspaceCustomStringParameter

Nome do pool de back-end do Load Balancer de saída para conectividade de cluster seguro (sem IP público).

loadBalancerId

WorkspaceCustomStringParameter

URI de recurso do balanceador de carga de saída para o workspace conectividade de cluster seguro (sem IP público).

natGatewayName

WorkspaceCustomStringParameter

Nome do gateway nat para sub-redes de workspace de conectividade de cluster seguro (sem IP público).

prepareEncryption

WorkspaceCustomBooleanParameter

Prepare o workspace para criptografia. Habilita a Identidade Gerenciada para a conta de armazenamento gerenciada.

publicIpName

WorkspaceCustomStringParameter

Nome do IP público para nenhum workspace de IP público com vNet gerenciada.

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.

resourceTags

WorkspaceCustomObjectParameter

Marcas aplicadas a recursos em grupo de recursos gerenciados. Elas podem ser atualizadas atualizando marcas no nível do workspace.

storageAccountName

WorkspaceCustomStringParameter

Nome da conta de armazenamento DBFS padrão.

storageAccountSkuName

WorkspaceCustomStringParameter

Nome da SKU da conta de armazenamento, por exemplo: Standard_GRS, Standard_LRS. Consulte https://aka.ms/storageskus de entradas válidas.

vnetAddressPrefix

WorkspaceCustomStringParameter

Prefixo de endereço para rede virtual gerenciada. O valor padrão dessa entrada é 10.139.

WorkspaceCustomStringParameter

O valor.

Nome Tipo Description
type

CustomParameterType

O tipo de variável que esta é

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 esta é

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 esta é

value

boolean

O valor que deve ser usado para esse campo.

WorkspaceProperties.Encryption

Propriedades de criptografia para o workspace do Databricks

Nome Tipo Description
entities

EncryptionEntitiesDefinition

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

WorkspaceProviderAuthorization

A autorização do provedor de workspace.

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.