Workspaces - Get

Dienst:

Databricks

API-Version:

2024-05-01

Ruft den Arbeitsbereich ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceName	path	True	string minLength: 3 maxLength: 64	Der Name des Arbeitsbereichs.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	Workspace	OK : Gibt den Arbeitsbereich zurück.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Get a workspace

Get a workspace with custom parameters

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

Get a workspace with Enhanced Security & Compliance Add-On

Get a workspace

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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

Get a workspace with custom parameters

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "name": "myWorkspace",
  "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace",
  "type": "Microsoft.Databricks/workspaces",
  "location": "East US 2",
  "sku": {
    "name": "premium"
  },
  "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"
      }
    },
    "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"
    },
    "createdDateTime": "2020-02-20T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "privateEndpointConnections": [
      {
        "id": "/subscriptions/subscriptionId/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace/privateEndpointConnections/myWorkspace.23456789-1111-1111-1111-111111111111",
        "name": "myWorkspace.23456789-1111-1111-1111-111111111111",
        "type": "Microsoft.Databricks/workspaces/privateEndpointConnections",
        "properties": {
          "privateEndpoint": {
            "id": "/subscriptions/subscriptionId/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
          },
          "privateLinkServiceConnectionState": {
            "status": "Approved",
            "description": "Auto-Approved",
            "actionsRequired": "None"
          },
          "provisioningState": "Succeeded"
        }
      }
    ],
    "publicNetworkAccess": "Disabled",
    "requiredNsgRules": "NoAzureDatabricksRules",
    "isUcEnabled": false
  }
}

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

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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",
    "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": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}

Get a workspace with Enhanced Security & Compliance Add-On

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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": "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"
    },
    "createdDateTime": "2023-08-24T00:10:29.2858439Z",
    "workspaceId": "5555555555555555",
    "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net",
    "isUcEnabled": true
  }
}

Definitionen

Name	Beschreibung
AccessConnector	Access Connector-Ressource, die dem Databricks-Arbeitsbereich zugeordnet werden soll
AutomaticClusterUpdateDefinition	Status des Features für automatische Clusterupdates.
AutomaticClusterUpdateValue
ComplianceSecurityProfileDefinition	Status des Compliancesicherheitsprofilfeatures.
ComplianceSecurityProfileValue
ComplianceStandard	Compliancestandards, die dem Arbeitsbereich zugeordnet sind.
CreatedBy	Enthält Details zur Entität, die den Arbeitsbereich erstellt/aktualisiert hat.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
CustomParameterType	Der Typ der Variablen, die dies ist
DefaultCatalogProperties	Mit diesen Eigenschaften können Benutzer standardkatalogeigenschaften während der Arbeitsbereicherstellung angeben.
defaultStorageFirewall	Dient zum Abrufen oder Festlegen von Konfigurationsinformationen zur Standardspeicherfirewall
Encryption	Das Objekt, das Details zur Verschlüsselung enthält, die im Arbeitsbereich verwendet wird.
EncryptionEntitiesDefinition	Verschlüsselungsentitäten für Databricks-Arbeitsbereichsressource.
EncryptionKeySource	Die Verschlüsselungsschlüsselquelle (Anbieter). Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Microsoft.Keyvault
EncryptionV2	Das Objekt, das Details zur Verschlüsselung enthält, die im Arbeitsbereich verwendet wird.
EnhancedSecurityComplianceDefinition	Status der Einstellungen im Zusammenhang mit dem Add-On "Erweiterte Sicherheit und Compliance".
EnhancedSecurityMonitoringDefinition	Status der Erweiterten Sicherheitsüberwachungsfunktion.
EnhancedSecurityMonitoringValue
ErrorDetail	Fehlerdetails.
ErrorInfo	Der Code und die Meldung für einen Fehler.
ErrorResponse	Fehlerantwort.
IdentityType	Der Identitätstyp der Access Connector-Ressource.
initialType	Definiert den ursprünglichen Typ des Standardkatalogs. Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): HiveMetastore, UnityCatalog
KeySource	Die Verschlüsselungsschlüsselquelle (Anbieter). Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Default, Microsoft.Keyvault
KeyVaultProperties	Key Vault-Eingabeeigenschaften für die Verschlüsselung.
ManagedDiskEncryption	Das Objekt, das Details zur Verschlüsselung enthält, die im Arbeitsbereich verwendet wird.
ManagedIdentityConfiguration	Die Details zur verwalteten Identität für das Speicherkonto.
PrivateEndpoint	Die private Endpunkteigenschaft einer privaten Endpunktverbindung
PrivateEndpointConnection	Die private Endpunktverbindung eines Arbeitsbereichs
PrivateEndpointConnectionProperties	Die Eigenschaften einer privaten Endpunktverbindung
PrivateEndpointConnectionProvisioningState	Der aktuelle Bereitstellungsstatus.
PrivateLinkServiceConnectionState	Der aktuelle Status einer privaten Endpunktverbindung
PrivateLinkServiceConnectionStatus	Der Status einer privaten Endpunktverbindung
ProvisioningState	Bereitstellungsstatus des Arbeitsbereichs.
PublicNetworkAccess	Der Netzwerkzugriffstyp für den Zugriff auf den Arbeitsbereich. Legen Sie den Wert auf "Deaktiviert" fest, um nur über einen privaten Link auf den Arbeitsbereich zuzugreifen.
RequiredNsgRules	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Datenebene (Cluster) zur Steuerung der Flugzeugkommunikation über privaten Endpunkt erfolgt. Unterstützte Werte sind "AllRules" und "NoAzureDatabricksRules". Der Wert "NoAzureServiceRules" ist nur für die interne Verwendung vorgesehen.
Sku	SKU für die Ressource.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
Workspace	Informationen zum Arbeitsbereich.
WorkspaceCustomBooleanParameter	Der Wert, der für dieses Feld verwendet werden soll.
WorkspaceCustomObjectParameter	Der Wert, der für dieses Feld verwendet werden soll.
WorkspaceCustomParameters	Benutzerdefinierte Parameter, die für die Clustererstellung verwendet werden.
WorkspaceCustomStringParameter	Der Wert.
WorkspaceEncryptionParameter	Das Objekt, das Details zur Verschlüsselung enthält, die im Arbeitsbereich verwendet wird.
WorkspaceNoPublicIPBooleanParameter	Der Wert, der für dieses Feld verwendet werden soll.
WorkspaceProperties.Encryption	Verschlüsselungseigenschaften für databricks-Arbeitsbereich
WorkspaceProviderAuthorization	Die Autorisierung des Arbeitsbereichsanbieters.

AccessConnector

Objekt

Access Connector-Ressource, die dem Databricks-Arbeitsbereich zugeordnet werden soll

Name	Typ	Beschreibung
id	string (arm-id)	Die Ressourcen-ID der Azure Databricks Access Connector-Ressource.
identityType	IdentityType	Der Identitätstyp der Access Connector-Ressource.
userAssignedIdentityId	string (arm-id)	Die Ressourcen-ID der vom Benutzer zugewiesenen Identität, die der Access Connector-Ressource zugeordnet ist. Dies ist für den Typ 'UserAssigned' erforderlich und nicht gültig für den Typ 'SystemAssigned'.

AutomaticClusterUpdateDefinition

Objekt

Status des Features für automatische Clusterupdates.

Name	Typ	Beschreibung
value	AutomaticClusterUpdateValue

AutomaticClusterUpdateValue

Enumeration

Wert	Beschreibung
Disabled
Enabled

ComplianceSecurityProfileDefinition

Objekt

Status des Compliancesicherheitsprofilfeatures.

Name	Typ	Beschreibung
complianceStandards	ComplianceStandard[]	Compliancestandards, die dem Arbeitsbereich zugeordnet sind.
value	ComplianceSecurityProfileValue

ComplianceSecurityProfileValue

Enumeration

Wert	Beschreibung
Disabled
Enabled

ComplianceStandard

Enumeration

Compliancestandards, die dem Arbeitsbereich zugeordnet sind.

Wert	Beschreibung
HIPAA
NONE
PCI_DSS

CreatedBy

Objekt

Enthält Details zur Entität, die den Arbeitsbereich erstellt/aktualisiert hat.

Name	Typ	Beschreibung
applicationId	string (uuid)	Die Anwendungs-ID der Anwendung, die die Erstellung des Arbeitsbereichs initiiert hat. Beispiel: Azure-Portal.
oid	string (uuid)	Die Objekt-ID, die den Arbeitsbereich erstellt hat.
puid	string	Die persönliche Objekt-ID, die der obigen Objekt-ID entspricht

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
Application
Key
ManagedIdentity
User

CustomParameterType

Enumeration

Der Typ der Variablen, die dies ist

Wert	Beschreibung
Bool
Object
String

DefaultCatalogProperties

Objekt

Mit diesen Eigenschaften können Benutzer standardkatalogeigenschaften während der Arbeitsbereicherstellung angeben.

Name	Typ	Standardwert	Beschreibung
initialName	string		Gibt den ursprünglichen Namen des Standardkatalogs an. Wenn nicht angegeben, wird der Name des Arbeitsbereichs verwendet.
initialType	initialType	HiveMetastore	Definiert den ursprünglichen Typ des Standardkatalogs. Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): HiveMetastore, UnityCatalog

defaultStorageFirewall

Enumeration

Dient zum Abrufen oder Festlegen von Konfigurationsinformationen zur Standardspeicherfirewall

Wert	Beschreibung
Disabled
Enabled

Encryption

Objekt

Das Objekt, das Details zur Verschlüsselung enthält, die im Arbeitsbereich verwendet wird.

Name	Typ	Standardwert	Beschreibung
KeyName	string		Der Name des KeyVault-Schlüssels.
keySource	KeySource	Default	Die Verschlüsselungsschlüsselquelle (Anbieter). Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Default, Microsoft.Keyvault
keyvaulturi	string		Der URI von KeyVault.
keyversion	string		Die Version des KeyVault-Schlüssels.

EncryptionEntitiesDefinition

Objekt

Verschlüsselungsentitäten für Databricks-Arbeitsbereichsressource.

Name	Typ	Beschreibung
managedDisk	ManagedDiskEncryption	Verschlüsselungseigenschaften für die von Databricks verwalteten Datenträger.
managedServices	EncryptionV2	Verschlüsselungseigenschaften für die verwalteten Databricks-Dienste.

EncryptionKeySource

Enumeration

Die Verschlüsselungsschlüsselquelle (Anbieter). Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Microsoft.Keyvault

Wert	Beschreibung
Microsoft.Keyvault

EncryptionV2

Objekt

Das Objekt, das Details zur Verschlüsselung enthält, die im Arbeitsbereich verwendet wird.

Name	Typ	Beschreibung
keySource	EncryptionKeySource	Die Verschlüsselungsschlüsselquelle (Anbieter). Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Microsoft.Keyvault
keyVaultProperties	KeyVaultProperties	Key Vault-Eingabeeigenschaften für die Verschlüsselung.

EnhancedSecurityComplianceDefinition

Objekt

Status der Einstellungen im Zusammenhang mit dem Add-On "Erweiterte Sicherheit und Compliance".

Name	Typ	Beschreibung
automaticClusterUpdate	AutomaticClusterUpdateDefinition	Status des Features für automatische Clusterupdates.
complianceSecurityProfile	ComplianceSecurityProfileDefinition	Status des Compliancesicherheitsprofilfeatures.
enhancedSecurityMonitoring	EnhancedSecurityMonitoringDefinition	Status der Erweiterten Sicherheitsüberwachungsfunktion.

EnhancedSecurityMonitoringDefinition

Objekt

Status der Erweiterten Sicherheitsüberwachungsfunktion.

Name	Typ	Beschreibung
value	EnhancedSecurityMonitoringValue

EnhancedSecurityMonitoringValue

Enumeration

Wert	Beschreibung
Disabled
Enabled

ErrorDetail

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
code	string	Der Code des Fehlers.
message	string	Eine lesbare Fehlermeldung.
target	string	Gibt an, welche Eigenschaft in der Anforderung für den Fehler verantwortlich ist.

ErrorInfo

Objekt

Der Code und die Meldung für einen Fehler.

Name	Typ	Beschreibung
code	string	Ein computerlesbarer Fehlercode.
details	ErrorDetail[]	Fehlerdetails.
innererror	string	Innere Fehlerdetails, falls vorhanden.
message	string	Eine lesbare Fehlermeldung.

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	ErrorInfo	Der Code und die Meldung für einen Fehler. Die Fehlerdetails.

IdentityType

Enumeration

Der Identitätstyp der Access Connector-Ressource.

Wert	Beschreibung
SystemAssigned
UserAssigned

initialType

Enumeration

Definiert den ursprünglichen Typ des Standardkatalogs. Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): HiveMetastore, UnityCatalog

Wert	Beschreibung
HiveMetastore
UnityCatalog

KeySource

Enumeration

Die Verschlüsselungsschlüsselquelle (Anbieter). Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Default, Microsoft.Keyvault

Wert	Beschreibung
Default
Microsoft.Keyvault

KeyVaultProperties

Objekt

Key Vault-Eingabeeigenschaften für die Verschlüsselung.

Name	Typ	Beschreibung
keyName	string	Der Name des KeyVault-Schlüssels.
keyVaultUri	string	Der URI von KeyVault.
keyVersion	string	Die Version des KeyVault-Schlüssels.

ManagedDiskEncryption

Objekt

Das Objekt, das Details zur Verschlüsselung enthält, die im Arbeitsbereich verwendet wird.

Name	Typ	Beschreibung
keySource	EncryptionKeySource	Die Verschlüsselungsschlüsselquelle (Anbieter). Mögliche Werte (Groß-/Kleinschreibung wird nicht beachtet): Microsoft.Keyvault
keyVaultProperties	KeyVaultProperties	Key Vault-Eingabeeigenschaften für die Verschlüsselung.
rotationToLatestKeyVersionEnabled	boolean	Geben Sie an, ob die neueste Schlüsselversion automatisch für die Verschlüsselung verwalteter Datenträger verwendet werden soll.

ManagedIdentityConfiguration

Objekt

Die Details zur verwalteten Identität für das Speicherkonto.

Name	Typ	Beschreibung
principalId	string (uuid)	Die objectId der verwalteten Identität, die mit dem verwalteten Speicherkonto verknüpft ist.
tenantId	string (uuid)	Die Mandanten-ID, in der die verwaltete Identität erstellt wird.
type	string	Der Typ der erstellten Identität. Es kann entweder SystemAssigned oder UserAssigned sein.

PrivateEndpoint

Objekt

Die private Endpunkteigenschaft einer privaten Endpunktverbindung

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.

PrivateEndpointConnection

Objekt

Die private Endpunktverbindung eines Arbeitsbereichs

Name	Typ	Beschreibung
id	string	Der Ressourcenbezeichner.
name	string	Der Ressourcenname.
properties	PrivateEndpointConnectionProperties	Die Eigenschaften der privaten Endpunktverbindung.
type	string	Der Ressourcentyp.

PrivateEndpointConnectionProperties

Objekt

Die Eigenschaften einer privaten Endpunktverbindung

Name	Typ	Beschreibung
groupIds	string[]	GroupIds aus der Ressource für den privaten Linkdienst.
privateEndpoint	PrivateEndpoint	Privater Endpunkt Privater Endpunkt
privateLinkServiceConnectionState	PrivateLinkServiceConnectionState	Verbindungsstatus des Diensts für private Links Verbindungsstatus des privaten Endpunkts
provisioningState	PrivateEndpointConnectionProvisioningState	Bereitstellungsstatus der privaten Endpunktverbindung.

PrivateEndpointConnectionProvisioningState

Enumeration

Der aktuelle Bereitstellungsstatus.

Wert	Beschreibung
Creating
Deleting
Failed
Succeeded
Updating

PrivateLinkServiceConnectionState

Objekt

Der aktuelle Status einer privaten Endpunktverbindung

Name	Typ	Beschreibung
actionsRequired	string	Aktionen, die für eine private Endpunktverbindung erforderlich sind
description	string	Die Beschreibung für den aktuellen Status einer privaten Endpunktverbindung
status	PrivateLinkServiceConnectionStatus	Der Status einer privaten Endpunktverbindung

PrivateLinkServiceConnectionStatus

Enumeration

Der Status einer privaten Endpunktverbindung

Wert	Beschreibung
Approved
Disconnected
Pending
Rejected

ProvisioningState

Enumeration

Bereitstellungsstatus des Arbeitsbereichs.

Wert	Beschreibung
Accepted
Canceled
Created
Creating
Deleted
Deleting
Failed
Ready
Running
Succeeded
Updating

PublicNetworkAccess

Enumeration

Der Netzwerkzugriffstyp für den Zugriff auf den Arbeitsbereich. Legen Sie den Wert auf "Deaktiviert" fest, um nur über einen privaten Link auf den Arbeitsbereich zuzugreifen.

Wert	Beschreibung
Disabled
Enabled

RequiredNsgRules

Enumeration

Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Datenebene (Cluster) zur Steuerung der Flugzeugkommunikation über privaten Endpunkt erfolgt. Unterstützte Werte sind "AllRules" und "NoAzureDatabricksRules". Der Wert "NoAzureServiceRules" ist nur für die interne Verwendung vorgesehen.

Wert	Beschreibung
AllRules
NoAzureDatabricksRules
NoAzureServiceRules

Sku

Objekt

SKU für die Ressource.

Name	Typ	Beschreibung
name	string	Der SKU-Name.
tier	string	Die SKU-Ebene.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

Workspace

Objekt

Informationen zum Arbeitsbereich.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.accessConnector	AccessConnector	Access Connector-Ressource, die dem Databricks-Arbeitsbereich zugeordnet werden soll
properties.authorizations	WorkspaceProviderAuthorization[]	Die Autorisierungen des Arbeitsbereichsanbieters.
properties.createdBy	CreatedBy	Gibt die Objekt-ID, PUID und Anwendungs-ID der Entität an, die den Arbeitsbereich erstellt hat.
properties.createdDateTime	string (date-time)	Gibt das Datum und die Uhrzeit der Erstellung des Arbeitsbereichs an.
properties.defaultCatalog	DefaultCatalogProperties	Eigenschaften für die Standardkatalogkonfiguration während der Arbeitsbereicherstellung.
properties.defaultStorageFirewall	defaultStorageFirewall	Dient zum Abrufen oder Festlegen von Konfigurationsinformationen zur Standardspeicherfirewall
properties.diskEncryptionSetId	string	Die Ressourcen-ID des Verschlüsselungssatzes für verwaltete Datenträger.
properties.encryption	WorkspaceProperties.Encryption	Verschlüsselungseigenschaften für databricks-Arbeitsbereich
properties.enhancedSecurityCompliance	EnhancedSecurityComplianceDefinition	Enthält Einstellungen im Zusammenhang mit dem Add-On für erweiterte Sicherheit und Compliance.
properties.isUcEnabled	boolean	Gibt an, ob der Unity-Katalog für den Arbeitsbereich aktiviert ist oder nicht.
properties.managedDiskIdentity	ManagedIdentityConfiguration	Details zur verwalteten Identität des Datenträgerverschlüsselungssatzes, der für die Verschlüsselung verwalteter Datenträger verwendet wird
properties.managedResourceGroupId	string	Die ID der verwalteten Ressourcengruppe.
properties.parameters	WorkspaceCustomParameters	Die benutzerdefinierten Parameter des Arbeitsbereichs.
properties.privateEndpointConnections	PrivateEndpointConnection[]	Private Endpunktverbindungen, die im Arbeitsbereich erstellt wurden
properties.provisioningState	ProvisioningState	Der Bereitstellungsstatus des Arbeitsbereichs.
properties.publicNetworkAccess	PublicNetworkAccess	Der Netzwerkzugriffstyp für den Zugriff auf den Arbeitsbereich. Legen Sie den Wert auf "Deaktiviert" fest, um nur über einen privaten Link auf den Arbeitsbereich zuzugreifen.
properties.requiredNsgRules	RequiredNsgRules	Dient zum Abrufen oder Festlegen eines Werts, der angibt, ob die Datenebene (Cluster) zur Steuerung der Flugzeugkommunikation über privaten Endpunkt erfolgt. Unterstützte Werte sind "AllRules" und "NoAzureDatabricksRules". Der Wert "NoAzureServiceRules" ist nur für die interne Verwendung vorgesehen.
properties.storageAccountIdentity	ManagedIdentityConfiguration	Details zur verwalteten Identität des Speicherkontos
properties.uiDefinitionUri	string	Der BLOB-URI, in dem sich die UI-Definitionsdatei befindet.
properties.updatedBy	CreatedBy	Gibt die Objekt-ID, PUID und Anwendungs-ID der Entität an, die den Arbeitsbereich zuletzt aktualisiert hat.
properties.workspaceId	string	Der eindeutige Bezeichner des Databricks-Arbeitsbereichs in der Datenbricks-Steuerebene.
properties.workspaceUrl	string	Die Arbeitsbereichs-URL, die das Format "adb-{workspaceId}" aufweist. {random}.azuredatabricks.net'
sku	Sku	Die SKU der Ressource.
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Ex- Microsoft.Compute/virtualMachines oder Microsoft.Storage/storageAccounts.

WorkspaceCustomBooleanParameter

Objekt

Der Wert, der für dieses Feld verwendet werden soll.

Name	Typ	Beschreibung
type	CustomParameterType	Der Typ der Variablen, die dies ist
value	boolean	Der Wert, der für dieses Feld verwendet werden soll.

WorkspaceCustomObjectParameter

Objekt

Der Wert, der für dieses Feld verwendet werden soll.

Name	Typ	Beschreibung
type	CustomParameterType	Der Typ der Variablen, die dies ist
value	object	Der Wert, der für dieses Feld verwendet werden soll.

WorkspaceCustomParameters

Objekt

Benutzerdefinierte Parameter, die für die Clustererstellung verwendet werden.

Name	Typ	Beschreibung
amlWorkspaceId	WorkspaceCustomStringParameter	Die ID eines Azure Machine Learning-Arbeitsbereichs, der mit dem Databricks-Arbeitsbereich verknüpft werden soll
customPrivateSubnetName	WorkspaceCustomStringParameter	Der Name des privaten Subnetzes innerhalb des virtuellen Netzwerks
customPublicSubnetName	WorkspaceCustomStringParameter	Der Name eines öffentlichen Subnetzes im virtuellen Netzwerk
customVirtualNetworkId	WorkspaceCustomStringParameter	Die ID eines virtuellen Netzwerks, in dem dieser Databricks-Cluster erstellt werden soll
enableNoPublicIp	WorkspaceNoPublicIPBooleanParameter	Boolescher Wert, der angibt, ob die öffentliche IP deaktiviert werden soll. Der Standardwert ist true.
encryption	WorkspaceEncryptionParameter	Enthält die Verschlüsselungsdetails für den aktivierten Arbeitsbereich für Customer-Managed Schlüssel (CMK).
loadBalancerBackendPoolName	WorkspaceCustomStringParameter	Name des ausgehenden Lastenausgleichs-Back-End-Pools für sichere Clusterkonnektivität (keine öffentliche IP).
loadBalancerId	WorkspaceCustomStringParameter	Ressourcen-URI des Ausgehenden Lastenausgleichs für den Arbeitsbereich "Secure Cluster Connectivity (No Public IP)".
natGatewayName	WorkspaceCustomStringParameter	Name des NAT-Gateways für Subnetze des Secure Cluster Connectivity (No Public IP)-Arbeitsbereichs.
prepareEncryption	WorkspaceCustomBooleanParameter	Bereiten Sie den Arbeitsbereich für die Verschlüsselung vor. Aktiviert die verwaltete Identität für verwaltetes Speicherkonto.
publicIpName	WorkspaceCustomStringParameter	Name der öffentlichen IP für keinen öffentlichen IP-Arbeitsbereich mit verwaltetem vNet.
requireInfrastructureEncryption	WorkspaceCustomBooleanParameter	Ein boolescher Wert, der angibt, ob das DBFS-Stammdateisystem mit sekundärer Verschlüsselungsebene mit plattformverwalteten Schlüsseln für ruhende Daten aktiviert wird.
resourceTags	WorkspaceCustomObjectParameter	Tags, die auf Ressourcen unter verwalteter Ressourcengruppe angewendet werden. Diese können aktualisiert werden, indem Tags auf Arbeitsbereichsebene aktualisiert werden.
storageAccountName	WorkspaceCustomStringParameter	Standardmäßiger DBFS-Speicherkontoname.
storageAccountSkuName	WorkspaceCustomStringParameter	SKU-Name des Speicherkontos, z. B. Standard_GRS, Standard_LRS. Weitere Informationen zu gültigen Eingaben finden Sie in https://aka.ms/storageskus.
vnetAddressPrefix	WorkspaceCustomStringParameter	Adresspräfix für verwaltetes virtuelles Netzwerk. Der Standardwert für diese Eingabe ist 10,139.

WorkspaceCustomStringParameter

Objekt

Der Wert.

Name	Typ	Beschreibung
type	CustomParameterType	Der Typ der Variablen, die dies ist
value	string	Der Wert, der für dieses Feld verwendet werden soll.

WorkspaceEncryptionParameter

Objekt

Das Objekt, das Details zur Verschlüsselung enthält, die im Arbeitsbereich verwendet wird.

Name	Typ	Beschreibung
type	CustomParameterType	Der Typ der Variablen, die dies ist
value	Encryption	Der Wert, der für dieses Feld verwendet werden soll.

WorkspaceNoPublicIPBooleanParameter

Objekt

Der Wert, der für dieses Feld verwendet werden soll.

Name	Typ	Beschreibung
type	CustomParameterType	Der Typ der Variablen, die dies ist
value	boolean	Der Wert, der für dieses Feld verwendet werden soll.

WorkspaceProperties.Encryption

Objekt

Verschlüsselungseigenschaften für databricks-Arbeitsbereich

Name	Typ	Beschreibung
entities	EncryptionEntitiesDefinition	Definition von Verschlüsselungsentitäten für den Arbeitsbereich.

WorkspaceProviderAuthorization

Objekt

Die Autorisierung des Arbeitsbereichsanbieters.

Name	Typ	Beschreibung
principalId	string (uuid)	Der Prinzipalbezeichner des Anbieters. Dies ist die Identität, die der Anbieter zum Aufrufen von ARM zum Verwalten der Arbeitsbereichsressourcen verwendet.
roleDefinitionId	string (uuid)	Der Rollendefinitionsbezeichner des Anbieters. Diese Rolle definiert alle Berechtigungen, die der Anbieter für die Containerressourcengruppe des Arbeitsbereichs besitzen muss. Diese Rollendefinition kann nicht über die Berechtigung zum Löschen der Ressourcengruppe verfügen.