Workspaces - Create Or Update

Tjänst:

Databricks

API-version:

2024-05-01

Skapar en ny arbetsyta.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
workspaceName	path	True	string minLength: 3 maxLength: 64	Namnet på arbetsytan.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandetext

Name	Obligatorisk	Typ	Description
location	True	string	Den geo-plats där resursen finns
properties.managedResourceGroupId	True	string	Det hanterade resursgrupps-ID:t.
properties.accessConnector		AccessConnector	Åtkomstanslutningsresurs som ska associeras med Databricks-arbetsytan
properties.authorizations		WorkspaceProviderAuthorization[]	Auktoriseringar för arbetsytans provider.
properties.createdBy		CreatedBy	Anger objekt-ID, PUID och program-ID för entiteten som skapade arbetsytan.
properties.defaultCatalog		DefaultCatalogProperties	Egenskaper för standardkatalogkonfiguration när arbetsytan skapas.
properties.defaultStorageFirewall		defaultStorageFirewall	Hämtar eller anger standardkonfigurationsinformation för Storage Firewall
properties.encryption		WorkspaceProperties.Encryption	Krypteringsegenskaper för databricks-arbetsytan
properties.enhancedSecurityCompliance		EnhancedSecurityComplianceDefinition	Innehåller inställningar relaterade till tillägget Utökad säkerhet och efterlevnad.
properties.managedDiskIdentity		ManagedIdentityConfiguration	Information om hanterad identitet för diskkrypteringsuppsättning som används för kryptering av hanterade diskar
properties.parameters		WorkspaceCustomParameters	Arbetsytans anpassade parametrar.
properties.publicNetworkAccess		PublicNetworkAccess	Nätverksåtkomsttypen för åtkomst till arbetsytan. Ange värdet till inaktiverad för åtkomst till arbetsytan endast via privat länk.
properties.requiredNsgRules		RequiredNsgRules	Hämtar eller anger ett värde som anger om dataplanet (kluster) för att kontrollera flygplanskommunikation sker via privat slutpunkt. Värden som stöds är "AllRules" och "NoAzureDatabricksRules". Värdet "NoAzureServiceRules" är endast för internt bruk.
properties.storageAccountIdentity		ManagedIdentityConfiguration	Information om hanterad identitet för lagringskonto
properties.uiDefinitionUri		string	Blob-URI:n där UI-definitionsfilen finns.
properties.updatedBy		CreatedBy	Anger objekt-ID, PUID och program-ID för entiteten som senast uppdaterade arbetsytan.
sku		Sku	Resursens SKU.
tags		object	Resurstaggar.

Svar

Name	Typ	Description
200 OK	Workspace	Skapad – Returnerar information om arbetsytan, inklusive etableringsstatus.
201 Created	Workspace	Skapad – Returnerar information om arbetsytan, inklusive etableringsstatus.
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Exempelbegäran

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

Exempelsvar

Statuskod:

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

Statuskod:

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

Definitioner

Name	Description
AccessConnector	Åtkomstanslutningsresurs som ska associeras med Databricks-arbetsytan
AutomaticClusterUpdateDefinition	Status för funktionen för automatiska klusteruppdateringar.
AutomaticClusterUpdateValue
ComplianceSecurityProfileDefinition	Status för funktionen Efterlevnadssäkerhetsprofil.
ComplianceSecurityProfileValue
ComplianceStandard	Efterlevnadsstandarder som är associerade med arbetsytan.
CreatedBy	Innehåller information om entiteten som skapade/uppdaterade arbetsytan.
createdByType	Den typ av identitet som skapade resursen.
CustomParameterType	Den typ av variabel som detta är
DefaultCatalogProperties	Med de här egenskaperna kan användaren ange standardkatalogegenskaper när arbetsytan skapas.
defaultStorageFirewall	Hämtar eller anger standardkonfigurationsinformation för Storage Firewall
Encryption	Objektet som innehåller information om kryptering som används på arbetsytan.
EncryptionEntitiesDefinition	Krypteringsentiteter för databricks-arbetsyteresurs.
EncryptionKeySource	Krypteringsnyckelkällan (providern). Möjliga värden (skiftlägesokänsliga): Microsoft.Keyvault
EncryptionV2	Objektet som innehåller information om kryptering som används på arbetsytan.
EnhancedSecurityComplianceDefinition	Status för inställningar relaterade till tillägget Förbättrad säkerhet och efterlevnad.
EnhancedSecurityMonitoringDefinition	Status för funktionen Förbättrad säkerhetsövervakning.
EnhancedSecurityMonitoringValue
ErrorDetail	Felinformation.
ErrorInfo	Koden och meddelandet för ett fel.
ErrorResponse	Felsvar.
IdentityType	Identitetstypen för åtkomstanslutningsresursen.
initialType	Definierar den första typen av standardkatalog. Möjliga värden (skiftlägesokänsliga): HiveMetastore, UnityCatalog
KeySource	Krypteringsnyckelkällan (providern). Möjliga värden (skiftlägesokänsliga): Standard, Microsoft.Keyvault
KeyVaultProperties	Key Vault-indataegenskaper för kryptering.
ManagedDiskEncryption	Objektet som innehåller information om kryptering som används på arbetsytan.
ManagedIdentityConfiguration	Information om hanterad identitet för lagringskontot.
PrivateEndpoint	Egenskapen privat slutpunkt för en privat slutpunktsanslutning
PrivateEndpointConnection	Den privata slutpunktsanslutningen för en arbetsyta
PrivateEndpointConnectionProperties	Egenskaperna för en privat slutpunktsanslutning
PrivateEndpointConnectionProvisioningState	Det aktuella etableringstillståndet.
PrivateLinkServiceConnectionState	Det aktuella tillståndet för en privat slutpunktsanslutning
PrivateLinkServiceConnectionStatus	Status för en privat slutpunktsanslutning
ProvisioningState	Etableringsstatus för arbetsytan.
PublicNetworkAccess	Nätverksåtkomsttypen för åtkomst till arbetsytan. Ange värdet till inaktiverad för åtkomst till arbetsytan endast via privat länk.
RequiredNsgRules	Hämtar eller anger ett värde som anger om dataplanet (kluster) för att kontrollera flygplanskommunikation sker via privat slutpunkt. Värden som stöds är "AllRules" och "NoAzureDatabricksRules". Värdet "NoAzureServiceRules" är endast för internt bruk.
Sku	SKU för resursen.
systemData	Metadata som rör skapande och senaste ändring av resursen.
Workspace	Information om arbetsyta.
Workspace.WorkspaceProperties.Encryption	Krypteringsegenskaper för databricks-arbetsytan
WorkspaceCustomBooleanParameter	Det värde som ska användas för det här fältet.
WorkspaceCustomObjectParameter	Det värde som ska användas för det här fältet.
WorkspaceCustomParameters	Anpassade parametrar som används för att skapa kluster.
WorkspaceCustomStringParameter	Värdet.
WorkspaceEncryptionParameter	Objektet som innehåller information om kryptering som används på arbetsytan.
WorkspaceNoPublicIPBooleanParameter	Det värde som ska användas för det här fältet.
WorkspaceProperties.Encryption	Krypteringsegenskaper för databricks-arbetsytan
WorkspaceProviderAuthorization	Auktorisering för arbetsyteprovider.

AccessConnector

Objekt

Åtkomstanslutningsresurs som ska associeras med Databricks-arbetsytan

Name	Typ	Description
id	string (arm-id)	Resurs-ID:t för Azure Databricks Access Connector-resursen.
identityType	IdentityType	Identitetstypen för åtkomstanslutningsresursen.
userAssignedIdentityId	string (arm-id)	Resurs-ID för den användartilldelade identitet som är associerad med åtkomstanslutningsresursen. Detta krävs för typen "UserAssigned" och ogiltig för typen "SystemAssigned".

AutomaticClusterUpdateDefinition

Objekt

Status för funktionen för automatiska klusteruppdateringar.

Name	Typ	Description
value	AutomaticClusterUpdateValue

AutomaticClusterUpdateValue

Uppräkning

Värde	Description
Disabled
Enabled

ComplianceSecurityProfileDefinition

Objekt

Status för funktionen Efterlevnadssäkerhetsprofil.

Name	Typ	Description
complianceStandards	ComplianceStandard[]	Efterlevnadsstandarder som är associerade med arbetsytan.
value	ComplianceSecurityProfileValue

ComplianceSecurityProfileValue

Uppräkning

Värde	Description
Disabled
Enabled

ComplianceStandard

Uppräkning

Efterlevnadsstandarder som är associerade med arbetsytan.

Värde	Description
HIPAA
NONE
PCI_DSS

CreatedBy

Objekt

Innehåller information om entiteten som skapade/uppdaterade arbetsytan.

Name	Typ	Description
applicationId	string (uuid)	Program-ID för programmet som initierade skapandet av arbetsytan. Till exempel Azure-portalen.
oid	string (uuid)	Objekt-ID:t som skapade arbetsytan.
puid	string	Det personliga objekt-ID som motsvarar objekt-ID:t ovan

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
Application
Key
ManagedIdentity
User

CustomParameterType

Uppräkning

Den typ av variabel som detta är

Värde	Description
Bool
Object
String

DefaultCatalogProperties

Objekt

Med de här egenskaperna kan användaren ange standardkatalogegenskaper när arbetsytan skapas.

Name	Typ	Standardvärde	Description
initialName	string		Anger det första namnet på standardkatalogen. Om det inte anges används namnet på arbetsytan.
initialType	initialType	HiveMetastore	Definierar den första typen av standardkatalog. Möjliga värden (skiftlägesokänsliga): HiveMetastore, UnityCatalog

defaultStorageFirewall

Uppräkning

Hämtar eller anger standardkonfigurationsinformation för Storage Firewall

Värde	Description
Disabled
Enabled

Encryption

Objekt

Objektet som innehåller information om kryptering som används på arbetsytan.

Name	Typ	Standardvärde	Description
KeyName	string		Namnet på KeyVault-nyckeln.
keySource	KeySource	Default	Krypteringsnyckelkällan (providern). Möjliga värden (skiftlägesokänsliga): Standard, Microsoft.Keyvault
keyvaulturi	string		Uri för KeyVault.
keyversion	string		Versionen av KeyVault-nyckeln.

EncryptionEntitiesDefinition

Objekt

Krypteringsentiteter för databricks-arbetsyteresurs.

Name	Typ	Description
managedDisk	ManagedDiskEncryption	Krypteringsegenskaper för databricks-hanterade diskar.
managedServices	EncryptionV2	Krypteringsegenskaper för databricks-hanterade tjänster.

EncryptionKeySource

Uppräkning

Krypteringsnyckelkällan (providern). Möjliga värden (skiftlägesokänsliga): Microsoft.Keyvault

Värde	Description
Microsoft.Keyvault

EncryptionV2

Objekt

Objektet som innehåller information om kryptering som används på arbetsytan.

Name	Typ	Description
keySource	EncryptionKeySource	Krypteringsnyckelkällan (providern). Möjliga värden (skiftlägesokänsliga): Microsoft.Keyvault
keyVaultProperties	KeyVaultProperties	Key Vault-indataegenskaper för kryptering.

EnhancedSecurityComplianceDefinition

Objekt

Status för inställningar relaterade till tillägget Förbättrad säkerhet och efterlevnad.

Name	Typ	Description
automaticClusterUpdate	AutomaticClusterUpdateDefinition	Status för funktionen för automatiska klusteruppdateringar.
complianceSecurityProfile	ComplianceSecurityProfileDefinition	Status för funktionen Efterlevnadssäkerhetsprofil.
enhancedSecurityMonitoring	EnhancedSecurityMonitoringDefinition	Status för funktionen Förbättrad säkerhetsövervakning.

EnhancedSecurityMonitoringDefinition

Objekt

Status för funktionen Förbättrad säkerhetsövervakning.

Name	Typ	Description
value	EnhancedSecurityMonitoringValue

EnhancedSecurityMonitoringValue

Uppräkning

Värde	Description
Disabled
Enabled

ErrorDetail

Objekt

Felinformation.

Name	Typ	Description
code	string	Felets kod.
message	string	Ett mänskligt läsbart felmeddelande.
target	string	Anger vilken egenskap i begäran som ansvarar för felet.

ErrorInfo

Objekt

Koden och meddelandet för ett fel.

Name	Typ	Description
code	string	En maskinläsbar felkod.
details	ErrorDetail[]	felinformation.
innererror	string	Inre felinformation om de finns.
message	string	Ett mänskligt läsbart felmeddelande.

ErrorResponse

Objekt

Felsvar.

Name	Typ	Description
error	ErrorInfo	Koden och meddelandet för ett fel. Felinformationen.

IdentityType

Uppräkning

Identitetstypen för åtkomstanslutningsresursen.

Värde	Description
SystemAssigned
UserAssigned

initialType

Uppräkning

Definierar den första typen av standardkatalog. Möjliga värden (skiftlägesokänsliga): HiveMetastore, UnityCatalog

Värde	Description
HiveMetastore
UnityCatalog

KeySource

Uppräkning

Krypteringsnyckelkällan (providern). Möjliga värden (skiftlägesokänsliga): Standard, Microsoft.Keyvault

Värde	Description
Default
Microsoft.Keyvault

KeyVaultProperties

Objekt

Key Vault-indataegenskaper för kryptering.

Name	Typ	Description
keyName	string	Namnet på KeyVault-nyckeln.
keyVaultUri	string	Uri för KeyVault.
keyVersion	string	Versionen av KeyVault-nyckeln.

ManagedDiskEncryption

Objekt

Objektet som innehåller information om kryptering som används på arbetsytan.

Name	Typ	Description
keySource	EncryptionKeySource	Krypteringsnyckelkällan (providern). Möjliga värden (skiftlägesokänsliga): Microsoft.Keyvault
keyVaultProperties	KeyVaultProperties	Key Vault-indataegenskaper för kryptering.
rotationToLatestKeyVersionEnabled	boolean	Ange om den senaste nyckelversionen ska användas automatiskt för kryptering av hanterade diskar.

ManagedIdentityConfiguration

Objekt

Information om hanterad identitet för lagringskontot.

Name	Typ	Description
principalId	string (uuid)	ObjectId för den hanterade identitet som är länkad till det hanterade lagringskontot.
tenantId	string (uuid)	Klient-ID:t där den hanterade identiteten skapas.
type	string	Typen av identitet som skapats. Det kan vara antingen SystemAssigned eller UserAssigned.

PrivateEndpoint

Objekt

Egenskapen privat slutpunkt för en privat slutpunktsanslutning

Name	Typ	Description
id	string	Resursidentifieraren.

PrivateEndpointConnection

Objekt

Den privata slutpunktsanslutningen för en arbetsyta

Name	Typ	Description
id	string	Resursidentifieraren.
name	string	Resursnamnet.
properties	PrivateEndpointConnectionProperties	Egenskaperna för privat slutpunktsanslutning.
type	string	Resurstypen.

PrivateEndpointConnectionProperties

Objekt

Egenskaperna för en privat slutpunktsanslutning

Name	Typ	Description
groupIds	string[]	GroupIds från private link-tjänstresursen.
privateEndpoint	PrivateEndpoint	Privat slutpunkt Privat slutpunkt
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Tjänstanslutningstillstånd för privat länktjänst Anslutningstillstånd för privat slutpunkt
provisioningState	PrivateEndpointConnectionProvisioningState	Etableringstillstånd för den privata slutpunktsanslutningen.

PrivateEndpointConnectionProvisioningState

Uppräkning

Det aktuella etableringstillståndet.

Värde	Description
Creating
Deleting
Failed
Succeeded
Updating

PrivateLinkServiceConnectionState

Objekt

Det aktuella tillståndet för en privat slutpunktsanslutning

Name	Typ	Description
actionsRequired	string	Åtgärder som krävs för en privat slutpunktsanslutning
description	string	Beskrivningen av det aktuella tillståndet för en privat slutpunktsanslutning
status	PrivateLinkServiceConnectionStatus	Status för en privat slutpunktsanslutning

PrivateLinkServiceConnectionStatus

Uppräkning

Status för en privat slutpunktsanslutning

Värde	Description
Approved
Disconnected
Pending
Rejected

ProvisioningState

Uppräkning

Etableringsstatus för arbetsytan.

Värde	Description
Accepted
Canceled
Created
Creating
Deleted
Deleting
Failed
Ready
Running
Succeeded
Updating

PublicNetworkAccess

Uppräkning

Nätverksåtkomsttypen för åtkomst till arbetsytan. Ange värdet till inaktiverad för åtkomst till arbetsytan endast via privat länk.

Värde	Description
Disabled
Enabled

RequiredNsgRules

Uppräkning

Hämtar eller anger ett värde som anger om dataplanet (kluster) för att kontrollera flygplanskommunikation sker via privat slutpunkt. Värden som stöds är "AllRules" och "NoAzureDatabricksRules". Värdet "NoAzureServiceRules" är endast för internt bruk.

Värde	Description
AllRules
NoAzureDatabricksRules
NoAzureServiceRules

Sku

Objekt

SKU för resursen.

Name	Typ	Description
name	string	SKU-namnet.
tier	string	SKU-nivån.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

Workspace

Objekt

Information om arbetsyta.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Den geo-plats där resursen finns
name	string	Namnet på resursen
properties.accessConnector	AccessConnector	Åtkomstanslutningsresurs som ska associeras med Databricks-arbetsytan
properties.authorizations	WorkspaceProviderAuthorization[]	Auktoriseringar för arbetsytans provider.
properties.createdBy	CreatedBy	Anger objekt-ID, PUID och program-ID för entiteten som skapade arbetsytan.
properties.createdDateTime	string (date-time)	Anger datum och tid när arbetsytan skapas.
properties.defaultCatalog	DefaultCatalogProperties	Egenskaper för standardkatalogkonfiguration när arbetsytan skapas.
properties.defaultStorageFirewall	defaultStorageFirewall	Hämtar eller anger standardkonfigurationsinformation för Storage Firewall
properties.diskEncryptionSetId	string	Resurs-ID för den hanterade diskkrypteringsuppsättningen.
properties.encryption	WorkspaceProperties.Encryption	Krypteringsegenskaper för databricks-arbetsytan
properties.enhancedSecurityCompliance	EnhancedSecurityComplianceDefinition	Innehåller inställningar relaterade till tillägget Utökad säkerhet och efterlevnad.
properties.isUcEnabled	boolean	Anger om Unity-katalogen är aktiverad för arbetsytan eller inte.
properties.managedDiskIdentity	ManagedIdentityConfiguration	Information om hanterad identitet för diskkrypteringsuppsättning som används för kryptering av hanterade diskar
properties.managedResourceGroupId	string	Det hanterade resursgrupps-ID:t.
properties.parameters	WorkspaceCustomParameters	Arbetsytans anpassade parametrar.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Privata slutpunktsanslutningar som skapats på arbetsytan
properties.provisioningState	ProvisioningState	Etableringstillståndet för arbetsytan.
properties.publicNetworkAccess	PublicNetworkAccess	Nätverksåtkomsttypen för åtkomst till arbetsytan. Ange värdet till inaktiverad för åtkomst till arbetsytan endast via privat länk.
properties.requiredNsgRules	RequiredNsgRules	Hämtar eller anger ett värde som anger om dataplanet (kluster) för att kontrollera flygplanskommunikation sker via privat slutpunkt. Värden som stöds är "AllRules" och "NoAzureDatabricksRules". Värdet "NoAzureServiceRules" är endast för internt bruk.
properties.storageAccountIdentity	ManagedIdentityConfiguration	Information om hanterad identitet för lagringskonto
properties.uiDefinitionUri	string	Blob-URI:n där UI-definitionsfilen finns.
properties.updatedBy	CreatedBy	Anger objekt-ID, PUID och program-ID för entiteten som senast uppdaterade arbetsytan.
properties.workspaceId	string	Den unika identifieraren för databricks-arbetsytan i databricks-kontrollplanet.
properties.workspaceUrl	string	Url:en för arbetsytan som har formatet "adb-{workspaceId}. {random}.azuredatabricks.net'
sku	Sku	Resursens SKU.
systemData	systemData	Systemmetadata för den här resursen
tags	object	Resurstaggar.
type	string	Resurstypen. Ex- Microsoft.Compute/virtualMachines eller Microsoft.Storage/storageAccounts.

Workspace.WorkspaceProperties.Encryption

Objekt

Krypteringsegenskaper för databricks-arbetsytan

Name	Typ	Description
entities	EncryptionEntitiesDefinition	Definition av krypteringsentiteter för arbetsytan.

WorkspaceCustomBooleanParameter

Objekt

Det värde som ska användas för det här fältet.

Name	Typ	Description
type	CustomParameterType	Den typ av variabel som detta är
value	boolean	Det värde som ska användas för det här fältet.

WorkspaceCustomObjectParameter

Objekt

Det värde som ska användas för det här fältet.

Name	Typ	Description
type	CustomParameterType	Den typ av variabel som detta är
value	object	Det värde som ska användas för det här fältet.

WorkspaceCustomParameters

Objekt

Anpassade parametrar som används för att skapa kluster.

Name	Typ	Description
amlWorkspaceId	WorkspaceCustomStringParameter	ID:t för en Azure Machine Learning-arbetsyta som ska länkas till Databricks-arbetsytan
customPrivateSubnetName	WorkspaceCustomStringParameter	Namnet på det privata undernätet i det virtuella nätverket
customPublicSubnetName	WorkspaceCustomStringParameter	Namnet på ett offentligt undernät i det virtuella nätverket
customVirtualNetworkId	WorkspaceCustomStringParameter	ID för ett virtuellt nätverk där det här Databricks-klustret ska skapas
enableNoPublicIp	WorkspaceNoPublicIPBooleanParameter	Booleskt värde som anger om den offentliga IP-adressen ska inaktiveras. Standardvärdet är sant
encryption	WorkspaceEncryptionParameter	Innehåller krypteringsinformation för Customer-Managed nyckelaktiverad arbetsyta (CMK).
loadBalancerBackendPoolName	WorkspaceCustomStringParameter	Namnet på den utgående lastbalanserarens serverdelspool för säker klusteranslutning (ingen offentlig IP-adress).
loadBalancerId	WorkspaceCustomStringParameter	Resurs-URI för utgående lastbalanserare för säker klusteranslutning (ingen offentlig IP)-arbetsyta.
natGatewayName	WorkspaceCustomStringParameter	Namn på NAT-gatewayen för undernät för säker klusteranslutning (ingen offentlig IP-adress).
prepareEncryption	WorkspaceCustomBooleanParameter	Förbered arbetsytan för kryptering. Aktiverar hanterad identitet för hanterat lagringskonto.
publicIpName	WorkspaceCustomStringParameter	Namnet på den offentliga IP-adressen för ingen offentlig IP-arbetsyta med hanterat vNet.
requireInfrastructureEncryption	WorkspaceCustomBooleanParameter	Ett booleskt värde som anger om DBFS-rotfilsystemet ska aktiveras med sekundärt krypteringslager med plattformshanterade nycklar för vilande data.
resourceTags	WorkspaceCustomObjectParameter	Taggar som tillämpas på resurser under Hanterad resursgrupp. Dessa kan uppdateras genom att uppdatera taggar på arbetsytenivå.
storageAccountName	WorkspaceCustomStringParameter	Standardnamn för DBFS-lagringskonto.
storageAccountSkuName	WorkspaceCustomStringParameter	Lagringskontots SKU-namn, till exempel Standard_GRS, Standard_LRS. Se https://aka.ms/storageskus för giltiga indata.
vnetAddressPrefix	WorkspaceCustomStringParameter	Adressprefix för hanterat virtuellt nätverk. Standardvärdet för den här indatan är 10,139.

WorkspaceCustomStringParameter

Objekt

Värdet.

Name	Typ	Description
type	CustomParameterType	Den typ av variabel som detta är
value	string	Det värde som ska användas för det här fältet.

WorkspaceEncryptionParameter

Objekt

Objektet som innehåller information om kryptering som används på arbetsytan.

Name	Typ	Description
type	CustomParameterType	Den typ av variabel som detta är
value	Encryption	Det värde som ska användas för det här fältet.

WorkspaceNoPublicIPBooleanParameter

Objekt

Det värde som ska användas för det här fältet.

Name	Typ	Description
type	CustomParameterType	Den typ av variabel som detta är
value	boolean	Det värde som ska användas för det här fältet.

WorkspaceProperties.Encryption

Objekt

Krypteringsegenskaper för databricks-arbetsytan

Name	Typ	Description
entities	EncryptionEntitiesDefinition	Definition av krypteringsentiteter för arbetsytan.

WorkspaceProviderAuthorization

Objekt

Auktorisering för arbetsyteprovider.

Name	Typ	Description
principalId	string (uuid)	Providerns huvudidentifierare. Det här är den identitet som providern använder för att anropa ARM för att hantera arbetsyteresurserna.
roleDefinitionId	string (uuid)	Providerns rolldefinitionsidentifierare. Den här rollen definierar alla behörigheter som providern måste ha för arbetsytans containerresursgrupp. Den här rolldefinitionen kan inte ha behörighet att ta bort resursgruppen.