Workspaces - Create Or Update

參考

服務:: Databricks

API 版本:: 2024-05-01

建立新的工作區。

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

URI 參數

名稱	位於	必要	類型	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
workspaceName	path	True	string minLength: 3 maxLength: 64	工作區的名稱。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求本文

名稱	必要	類型	Description
location	True	string	資源所在的地理位置
properties.managedResourceGroupId	True	string	受控資源群組標識碼。
properties.accessConnector		AccessConnector	存取即將與 Databricks 工作區相關聯的連接器資源
properties.authorizations		WorkspaceProviderAuthorization[]	工作區提供者授權。
properties.createdBy		CreatedBy	指出建立工作區之實體的物件標識碼、PUID 和應用程式識別碼。
properties.defaultCatalog		DefaultCatalogProperties	工作區建立期間的預設目錄組態屬性。
properties.defaultStorageFirewall		defaultStorageFirewall	取得或設定預設記憶體防火牆組態資訊
properties.encryption		WorkspaceProperties.Encryption	databricks 工作區的加密屬性
properties.enhancedSecurityCompliance		EnhancedSecurityComplianceDefinition	包含與增強式安全性與合規性附加元件相關的設定。
properties.managedDiskIdentity		ManagedIdentityConfiguration	用於受控磁碟加密之磁碟加密集的受控識別詳細數據
properties.parameters		WorkspaceCustomParameters	工作區的自定義參數。
properties.publicNetworkAccess		PublicNetworkAccess	用於存取工作區的網路存取類型。將值設定為停用，以僅透過私人連結存取工作區。
properties.requiredNsgRules		RequiredNsgRules	取得或設定值，指出是否透過私人端點控制平面通訊的數據平面（叢集）。支援的值為 'AllRules' 和 'NoAzureDatabricksRules'。 'NoAzureServiceRules' 值僅供內部使用。
properties.storageAccountIdentity		ManagedIdentityConfiguration	記憶體帳戶受控識別的詳細數據
properties.uiDefinitionUri		string	UI 定義檔案所在的 Blob URI。
properties.updatedBy		CreatedBy	指出上次更新工作區之實體的物件標識碼、PUID 和應用程式識別碼。
sku		Sku	資源的 SKU。
tags		object	資源標籤。

回應

名稱	類型	Description
200 OK	Workspace	已建立 - 傳回工作區的相關信息，包括布建狀態。
201 Created	Workspace	已建立 - 傳回工作區的相關信息，包括布建狀態。
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

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

範例要求

HTTP

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"
}

範例回覆

狀態碼:: 200

{
  "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"
  }
}

狀態碼:: 201

{
  "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

範例要求

HTTP

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"
}

範例回覆

狀態碼:: 200

{
  "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
  }
}

狀態碼:: 201

{
  "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

範例要求

HTTP

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"
}

範例回覆

狀態碼:: 200

{
  "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
  }
}

狀態碼:: 201

{
  "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

範例要求

HTTP

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"
}

範例回覆

狀態碼:: 200

{
  "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
  }
}

狀態碼:: 201

{
  "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

範例要求

HTTP

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"
}

範例回覆

狀態碼:: 200

{
  "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
  }
}

狀態碼:: 201

{
  "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

範例要求

HTTP

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"
}

範例回覆

狀態碼:: 200

{
  "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
  }
}

狀態碼:: 201

{
  "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

範例要求

HTTP

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"
}

範例回覆

狀態碼:: 200

{
  "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
  }
}

狀態碼:: 201

{
  "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

範例要求

HTTP

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"
  }
}

範例回覆

狀態碼:: 200

{
  "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
  }
}

狀態碼:: 201

{
  "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
  }
}

定義

名稱	Description
AccessConnector	存取即將與 Databricks 工作區相關聯的連接器資源
AutomaticClusterUpdateDefinition	自動化叢集更新功能的狀態。
AutomaticClusterUpdateValue
ComplianceSecurityProfileDefinition	合規性安全性配置檔功能的狀態。
ComplianceSecurityProfileValue
ComplianceStandard	與工作區相關聯的合規性標準。
CreatedBy	提供建立/更新工作區之實體的詳細數據。
createdByType	建立資源的身分識別類型。
CustomParameterType	這是的變數類型
DefaultCatalogProperties	這些屬性可讓使用者在建立工作區期間指定預設目錄屬性。
defaultStorageFirewall	取得或設定預設記憶體防火牆組態資訊
Encryption	物件，其中包含工作區上所使用的加密詳細數據。
EncryptionEntitiesDefinition	databricks 工作區資源的加密實體。
EncryptionKeySource	加密金鑰來源（提供者）。可能的值（不區分大小寫）：Microsoft.Keyvault
EncryptionV2	物件，其中包含工作區上所使用的加密詳細數據。
EnhancedSecurityComplianceDefinition	與增強式安全性與合規性附加元件相關的設定狀態。
EnhancedSecurityMonitoringDefinition	增強式安全性監視功能的狀態。
EnhancedSecurityMonitoringValue
ErrorDetail	錯誤詳細數據。
ErrorInfo	錯誤的程式代碼和訊息。
ErrorResponse	錯誤回應。
IdentityType	Access Connector 資源的識別類型。
initialType	定義預設目錄的初始類型。可能的值（不區分大小寫）：HiveMetastore、UnityCatalog
KeySource	加密金鑰來源（提供者）。可能的值（不區分大小寫）：預設值，Microsoft.Keyvault
KeyVaultProperties	用於加密的 Key Vault 輸入屬性。
ManagedDiskEncryption	物件，其中包含工作區上所使用的加密詳細數據。
ManagedIdentityConfiguration	記憶體帳戶的受控識別詳細數據。
PrivateEndpoint	私人端點連線的私人端點屬性
PrivateEndpointConnection	工作區的私人端點連線
PrivateEndpointConnectionProperties	私人端點連線的屬性
PrivateEndpointConnectionProvisioningState	目前的布建狀態。
PrivateLinkServiceConnectionState	私人端點連線的目前狀態
PrivateLinkServiceConnectionStatus	私人端點連線的狀態
ProvisioningState	工作區的布建狀態。
PublicNetworkAccess	用於存取工作區的網路存取類型。將值設定為停用，以僅透過私人連結存取工作區。
RequiredNsgRules	取得或設定值，指出是否透過私人端點控制平面通訊的數據平面（叢集）。支援的值為 'AllRules' 和 'NoAzureDatabricksRules'。 'NoAzureServiceRules' 值僅供內部使用。
Sku	資源的 SKU。
systemData	與建立和上次修改資源相關的元數據。
Workspace	工作區的相關信息。
Workspace.WorkspaceProperties.Encryption	databricks 工作區的加密屬性
WorkspaceCustomBooleanParameter	應該用於此欄位的值。
WorkspaceCustomObjectParameter	應該用於此欄位的值。
WorkspaceCustomParameters	用於建立叢集的自定義參數。
WorkspaceCustomStringParameter	值。
WorkspaceEncryptionParameter	物件，其中包含工作區上所使用的加密詳細數據。
WorkspaceNoPublicIPBooleanParameter	應該用於此欄位的值。
WorkspaceProperties.Encryption	databricks 工作區的加密屬性
WorkspaceProviderAuthorization	工作區提供者授權。

AccessConnector

Object

存取即將與 Databricks 工作區相關聯的連接器資源

名稱	類型	Description
id	string (arm-id)	Azure Databricks Access Connector 資源的資源標識符。
identityType	IdentityType	Access Connector 資源的識別類型。
userAssignedIdentityId	string (arm-id)	與 Access Connector 資源相關聯的使用者指派身分識別的資源識別碼。類型 'UserAssigned' 需要此專案，且類型 'SystemAssigned' 無效。

AutomaticClusterUpdateDefinition

Object

自動化叢集更新功能的狀態。

名稱	類型	Description
value	AutomaticClusterUpdateValue

AutomaticClusterUpdateValue

列舉型別

值	Description
Disabled
Enabled

ComplianceSecurityProfileDefinition

Object

合規性安全性配置檔功能的狀態。

名稱	類型	Description
complianceStandards	ComplianceStandard[]	與工作區相關聯的合規性標準。
value	ComplianceSecurityProfileValue

ComplianceSecurityProfileValue

列舉型別

值	Description
Disabled
Enabled

ComplianceStandard

列舉型別

與工作區相關聯的合規性標準。

值	Description
HIPAA
NONE
PCI_DSS

CreatedBy

Object

提供建立/更新工作區之實體的詳細數據。

名稱	類型	Description
applicationId	string (uuid)	起始建立工作區之應用程式的應用程式標識碼。例如，Azure 入口網站。
oid	string (uuid)	建立工作區的物件標識碼。
puid	string	對應至上述物件標識碼的個人對象標識碼

createdByType

列舉型別

建立資源的身分識別類型。

值	Description
Application
Key
ManagedIdentity
User

CustomParameterType

列舉型別

這是的變數類型

值	Description
Bool
Object
String

DefaultCatalogProperties

Object

這些屬性可讓使用者在建立工作區期間指定預設目錄屬性。

名稱	類型	預設值	Description
initialName	string		指定預設目錄的初始名稱。如果未指定，則會使用工作區的名稱。
initialType	initialType	HiveMetastore	定義預設目錄的初始類型。可能的值（不區分大小寫）：HiveMetastore、UnityCatalog

defaultStorageFirewall

列舉型別

取得或設定預設記憶體防火牆組態資訊

值	Description
Disabled
Enabled

Encryption

Object

物件，其中包含工作區上所使用的加密詳細數據。

名稱	類型	預設值	Description
KeyName	string		KeyVault 金鑰的名稱。
keySource	KeySource	Default	加密金鑰來源（提供者）。可能的值（不區分大小寫）：預設值，Microsoft.Keyvault
keyvaulturi	string		KeyVault 的 URI。
keyversion	string		KeyVault 金鑰的版本。

EncryptionEntitiesDefinition

Object

databricks 工作區資源的加密實體。

名稱	類型	Description
managedDisk	ManagedDiskEncryption	databricks 受控磁碟的加密屬性。
managedServices	EncryptionV2	databricks 受控服務的加密屬性。

EncryptionKeySource

列舉型別

加密金鑰來源（提供者）。可能的值（不區分大小寫）：Microsoft.Keyvault

值	Description
Microsoft.Keyvault

EncryptionV2

Object

物件，其中包含工作區上所使用的加密詳細數據。

名稱	類型	Description
keySource	EncryptionKeySource	加密金鑰來源（提供者）。可能的值（不區分大小寫）：Microsoft.Keyvault
keyVaultProperties	KeyVaultProperties	用於加密的 Key Vault 輸入屬性。

EnhancedSecurityComplianceDefinition

Object

與增強式安全性與合規性附加元件相關的設定狀態。

名稱	類型	Description
automaticClusterUpdate	AutomaticClusterUpdateDefinition	自動化叢集更新功能的狀態。
complianceSecurityProfile	ComplianceSecurityProfileDefinition	合規性安全性配置檔功能的狀態。
enhancedSecurityMonitoring	EnhancedSecurityMonitoringDefinition	增強式安全性監視功能的狀態。

EnhancedSecurityMonitoringDefinition

Object

增強式安全性監視功能的狀態。

名稱	類型	Description
value	EnhancedSecurityMonitoringValue

EnhancedSecurityMonitoringValue

列舉型別

值	Description
Disabled
Enabled

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
code	string	錯誤的程序代碼。
message	string	人類可讀取的錯誤訊息。
target	string	指出要求中的哪一個屬性負責錯誤。

ErrorInfo

Object

錯誤的程式代碼和訊息。

名稱	類型	Description
code	string	計算機可讀取的錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
innererror	string	如果內部錯誤詳細資料存在，則為。
message	string	人類可讀取的錯誤訊息。

ErrorResponse

Object

錯誤回應。

名稱	類型	Description
error	ErrorInfo	錯誤的程式代碼和訊息。錯誤詳細數據。

IdentityType

列舉型別

Access Connector 資源的識別類型。

值	Description
SystemAssigned
UserAssigned

initialType

列舉型別

定義預設目錄的初始類型。可能的值（不區分大小寫）：HiveMetastore、UnityCatalog

值	Description
HiveMetastore
UnityCatalog

KeySource

列舉型別

加密金鑰來源（提供者）。可能的值（不區分大小寫）：預設值，Microsoft.Keyvault

值	Description
Default
Microsoft.Keyvault

KeyVaultProperties

Object

用於加密的 Key Vault 輸入屬性。

名稱	類型	Description
keyName	string	KeyVault 金鑰的名稱。
keyVaultUri	string	KeyVault 的 URI。
keyVersion	string	KeyVault 金鑰的版本。

ManagedDiskEncryption

Object

物件，其中包含工作區上所使用的加密詳細數據。

名稱	類型	Description
keySource	EncryptionKeySource	加密金鑰來源（提供者）。可能的值（不區分大小寫）：Microsoft.Keyvault
keyVaultProperties	KeyVaultProperties	用於加密的 Key Vault 輸入屬性。
rotationToLatestKeyVersionEnabled	boolean	指出是否應該自動將最新的金鑰版本用於受控磁碟加密。

ManagedIdentityConfiguration

Object

記憶體帳戶的受控識別詳細數據。

名稱	類型	Description
principalId	string (uuid)	連結到受控記憶體帳戶之受控識別的 objectId。
tenantId	string (uuid)	建立受控識別的租用戶標識碼。
type	string	建立的身分識別類型。它可以是 SystemAssigned 或 UserAssigned。

PrivateEndpoint

Object

私人端點連線的私人端點屬性

名稱	類型	Description
id	string	資源標識碼。

PrivateEndpointConnection

Object

工作區的私人端點連線

名稱	類型	Description
id	string	資源標識碼。
name	string	資源名稱。
properties	PrivateEndpointConnectionProperties	私人端點連線屬性。
type	string	資源類型。

PrivateEndpointConnectionProperties

Object

私人端點連線的屬性

名稱	類型	Description
groupIds	string[]	Private Link 服務資源的 GroupId。
privateEndpoint	PrivateEndpoint	私人端點私人端點
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	私人鏈接服務服務連線狀態私人端點連線狀態
provisioningState	PrivateEndpointConnectionProvisioningState	布建私人端點連線的狀態。

PrivateEndpointConnectionProvisioningState

列舉型別

目前的布建狀態。

值	Description
Creating
Deleting
Failed
Succeeded
Updating

PrivateLinkServiceConnectionState

Object

私人端點連線的目前狀態

名稱	類型	Description
actionsRequired	string	私人端點連線所需的動作
description	string	私人端點連線目前狀態的描述
status	PrivateLinkServiceConnectionStatus	私人端點連線的狀態

PrivateLinkServiceConnectionStatus

列舉型別

私人端點連線的狀態

值	Description
Approved
Disconnected
Pending
Rejected

ProvisioningState

列舉型別

工作區的布建狀態。

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

PublicNetworkAccess

列舉型別

用於存取工作區的網路存取類型。將值設定為停用，以僅透過私人連結存取工作區。

值	Description
Disabled
Enabled

RequiredNsgRules

列舉型別

取得或設定值，指出是否透過私人端點控制平面通訊的數據平面（叢集）。支援的值為 'AllRules' 和 'NoAzureDatabricksRules'。 'NoAzureServiceRules' 值僅供內部使用。

值	Description
AllRules
NoAzureDatabricksRules
NoAzureServiceRules

Sku

Object

資源的 SKU。

名稱	類型	Description
name	string	SKU 名稱。
tier	string	SKU 層。

systemData

Object

與建立和上次修改資源相關的元數據。

名稱	類型	Description
createdAt	string (date-time)	資源建立的時間戳（UTC）。
createdBy	string	建立資源的身分識別。
createdByType	createdByType	建立資源的身分識別類型。
lastModifiedAt	string (date-time)	上次修改的資源時間戳（UTC）
lastModifiedBy	string	上次修改資源的身分識別。
lastModifiedByType	createdByType	上次修改資源的身分識別類型。

Workspace

Object

工作區的相關信息。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	資源所在的地理位置
name	string	資源的名稱
properties.accessConnector	AccessConnector	存取即將與 Databricks 工作區相關聯的連接器資源
properties.authorizations	WorkspaceProviderAuthorization[]	工作區提供者授權。
properties.createdBy	CreatedBy	指出建立工作區之實體的物件標識碼、PUID 和應用程式識別碼。
properties.createdDateTime	string (date-time)	指定建立工作區的日期和時間。
properties.defaultCatalog	DefaultCatalogProperties	工作區建立期間的預設目錄組態屬性。
properties.defaultStorageFirewall	defaultStorageFirewall	取得或設定預設記憶體防火牆組態資訊
properties.diskEncryptionSetId	string	受控磁碟加密集的資源標識碼。
properties.encryption	WorkspaceProperties.Encryption	databricks 工作區的加密屬性
properties.enhancedSecurityCompliance	EnhancedSecurityComplianceDefinition	包含與增強式安全性與合規性附加元件相關的設定。
properties.isUcEnabled	boolean	指出是否為工作區啟用 Unity 目錄。
properties.managedDiskIdentity	ManagedIdentityConfiguration	用於受控磁碟加密之磁碟加密集的受控識別詳細數據
properties.managedResourceGroupId	string	受控資源群組標識碼。
properties.parameters	WorkspaceCustomParameters	工作區的自定義參數。
properties.privateEndpointConnections	PrivateEndpointConnection[]	在工作區上建立的私人端點連線
properties.provisioningState	ProvisioningState	工作區布建狀態。
properties.publicNetworkAccess	PublicNetworkAccess	用於存取工作區的網路存取類型。將值設定為停用，以僅透過私人連結存取工作區。
properties.requiredNsgRules	RequiredNsgRules	取得或設定值，指出是否透過私人端點控制平面通訊的數據平面（叢集）。支援的值為 'AllRules' 和 'NoAzureDatabricksRules'。 'NoAzureServiceRules' 值僅供內部使用。
properties.storageAccountIdentity	ManagedIdentityConfiguration	記憶體帳戶受控識別的詳細數據
properties.uiDefinitionUri	string	UI 定義檔案所在的 Blob URI。
properties.updatedBy	CreatedBy	指出上次更新工作區之實體的物件標識碼、PUID 和應用程式識別碼。
properties.workspaceId	string	databricks 控制平面中 databricks 工作區的唯一標識符。
properties.workspaceUrl	string	工作區 URL，其格式為 'adb-{workspaceId}。{random}.azuredatabricks.net'
sku	Sku	資源的 SKU。
systemData	systemData	與此資源相關的系統元數據
tags	object	資源標籤。
type	string	資源的型別。 Ex- Microsoft.Compute/virtualMachines 或 Microsoft.Storage/storageAccounts。

Workspace.WorkspaceProperties.Encryption

Object

databricks 工作區的加密屬性

名稱	類型	Description
entities	EncryptionEntitiesDefinition	工作區的加密實體定義。

WorkspaceCustomBooleanParameter

Object

應該用於此欄位的值。

名稱	類型	Description
type	CustomParameterType	這是的變數類型
value	boolean	應該用於此欄位的值。

WorkspaceCustomObjectParameter

Object

應該用於此欄位的值。

名稱	類型	Description
type	CustomParameterType	這是的變數類型
value	object	應該用於此欄位的值。

WorkspaceCustomParameters

Object

用於建立叢集的自定義參數。

名稱	類型	Description
amlWorkspaceId	WorkspaceCustomStringParameter	要與 Databricks 工作區連結的 Azure Machine Learning 工作區標識符
customPrivateSubnetName	WorkspaceCustomStringParameter	虛擬網路內私人子網的名稱
customPublicSubnetName	WorkspaceCustomStringParameter	虛擬網路內公用子網的名稱
customVirtualNetworkId	WorkspaceCustomStringParameter	應該建立此 Databricks 叢集之虛擬網路的標識碼
enableNoPublicIp	WorkspaceNoPublicIPBooleanParameter	布爾值，指出是否應該停用公用IP。默認值為 true
encryption	WorkspaceEncryptionParameter	包含已啟用 Customer-Managed 金鑰（CMK）工作區的加密詳細資料。
loadBalancerBackendPoolName	WorkspaceCustomStringParameter	安全叢集聯機的輸出Load Balancer後端集區名稱（無公用IP）。
loadBalancerId	WorkspaceCustomStringParameter	安全叢集連線（無公用IP）工作區輸出負載平衡器的資源URI。
natGatewayName	WorkspaceCustomStringParameter	安全叢集聯機（無公用IP）工作區子網的NAT閘道名稱。
prepareEncryption	WorkspaceCustomBooleanParameter	準備工作區以進行加密。啟用受控記憶體帳戶的受控識別。
publicIpName	WorkspaceCustomStringParameter	具有受控 vNet 之 [無公用 IP] 工作區的 [公用 IP] 名稱。
requireInfrastructureEncryption	WorkspaceCustomBooleanParameter	布爾值，指出是否要啟用 DBFS 根文件系統，使用平臺管理密鑰進行待用數據的第二層加密。
resourceTags	WorkspaceCustomObjectParameter	套用至受控資源群組下資源的標籤。更新工作區層級的標籤，即可更新這些標記。
storageAccountName	WorkspaceCustomStringParameter	預設 DBFS 記憶體帳戶名稱。
storageAccountSkuName	WorkspaceCustomStringParameter	記憶體帳戶 SKU 名稱，例如：Standard_GRS，Standard_LRS。如需有效的輸入，請參閱 https://aka.ms/storageskus。
vnetAddressPrefix	WorkspaceCustomStringParameter	受控虛擬網路的位址前綴。此輸入的預設值為 10.139。

WorkspaceCustomStringParameter

Object

值。

名稱	類型	Description
type	CustomParameterType	這是的變數類型
value	string	應該用於此欄位的值。

WorkspaceEncryptionParameter

Object

物件，其中包含工作區上所使用的加密詳細數據。

名稱	類型	Description
type	CustomParameterType	這是的變數類型
value	Encryption	應該用於此欄位的值。

WorkspaceNoPublicIPBooleanParameter

Object

應該用於此欄位的值。

名稱	類型	Description
type	CustomParameterType	這是的變數類型
value	boolean	應該用於此欄位的值。

WorkspaceProperties.Encryption

Object

databricks 工作區的加密屬性

名稱	類型	Description
entities	EncryptionEntitiesDefinition	工作區的加密實體定義。

WorkspaceProviderAuthorization

Object

工作區提供者授權。

名稱	類型	Description
principalId	string (uuid)	提供者的主體標識碼。這是提供者將用來呼叫ARM來管理工作區資源的身分識別。
roleDefinitionId	string (uuid)	提供者的角色定義標識碼。此角色會定義提供者在工作區容器資源群組上必須擁有的所有許可權。這個角色定義不能有刪除資源群組的許可權。

共用方式為

Workspaces - Create Or Update

URI 參數

要求本文

回應

安全性

azure_auth

範圍

範例

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

範例要求

範例回覆

定義

AccessConnector

AutomaticClusterUpdateDefinition

AutomaticClusterUpdateValue

ComplianceSecurityProfileDefinition

ComplianceSecurityProfileValue

ComplianceStandard

CreatedBy

createdByType

CustomParameterType

DefaultCatalogProperties

defaultStorageFirewall

Encryption

EncryptionEntitiesDefinition

EncryptionKeySource

EncryptionV2

EnhancedSecurityComplianceDefinition

EnhancedSecurityMonitoringDefinition

EnhancedSecurityMonitoringValue

ErrorDetail

ErrorInfo

ErrorResponse

IdentityType

initialType

KeySource

KeyVaultProperties

ManagedDiskEncryption

ManagedIdentityConfiguration

PrivateEndpoint

PrivateEndpointConnection

PrivateEndpointConnectionProperties

PrivateEndpointConnectionProvisioningState

PrivateLinkServiceConnectionState

PrivateLinkServiceConnectionStatus

ProvisioningState

PublicNetworkAccess

RequiredNsgRules

Sku

systemData

Workspace

Workspace.WorkspaceProperties.Encryption

WorkspaceCustomBooleanParameter

WorkspaceCustomObjectParameter

WorkspaceCustomParameters

WorkspaceCustomStringParameter

WorkspaceEncryptionParameter

WorkspaceNoPublicIPBooleanParameter