azure.mgmt.databricks.models module¶

class azure.mgmt.databricks.models.AddressSpace(*, address_prefixes: Optional[List[str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.

Parameters: address_prefixes (list[str]) – A list of address blocks reserved for this virtual network in CIDR notation.

class azure.mgmt.databricks.models.CreatedBy(**kwargs)[source]¶

Bases: msrest.serialization.Model

Provides details of the entity that created/updated the workspace.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

oid (str) – The Object ID that created the workspace.
puid (str) – The Personal Object ID corresponding to the object ID above.
application_id (str) – The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.

class azure.mgmt.databricks.models.CreatedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.databricks.models.CustomParameterType(value)[source]¶

Bases: str, enum.Enum

Provisioning status of the workspace.

BOOL = 'Bool'¶

OBJECT = 'Object'¶

STRING = 'String'¶

class azure.mgmt.databricks.models.Encryption(*, key_source: Optional[str] = 'Default', key_name: Optional[str] = None, key_version: Optional[str] = None, key_vault_uri: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The object that contains details of encryption used on the workspace.

Parameters

key_source (str or KeySource) – The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault. Possible values include: “Default”, “Microsoft.Keyvault”. Default value: “Default”.
key_name (str) – The name of KeyVault key.
key_version (str) – The version of KeyVault key.
key_vault_uri (str) – The Uri of KeyVault.

class azure.mgmt.databricks.models.EncryptionEntitiesDefinition(*, managed_services: Optional[azure.mgmt.databricks.models._models_py3.EncryptionV2] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Encryption entities for databricks workspace resource.

Parameters: managed_services (EncryptionV2) – Encryption properties for the databricks managed services.

class azure.mgmt.databricks.models.EncryptionKeySource(value)[source]¶

Bases: str, enum.Enum

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault

MICROSOFT_KEYVAULT = 'Microsoft.Keyvault'¶

class azure.mgmt.databricks.models.EncryptionV2(*, key_source: str, key_vault_properties: Optional[azure.mgmt.databricks.models._models_py3.EncryptionV2KeyVaultProperties] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The object that contains details of encryption used on the workspace.

All required parameters must be populated in order to send to Azure.

Parameters

key_source (str or EncryptionKeySource) – Required. The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Possible values include: “Microsoft.Keyvault”.
key_vault_properties (EncryptionV2KeyVaultProperties) – Key Vault input properties for encryption.

class azure.mgmt.databricks.models.EncryptionV2KeyVaultProperties(*, key_vault_uri: str, key_name: str, key_version: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Key Vault input properties for encryption.

All required parameters must be populated in order to send to Azure.

Parameters

key_vault_uri (str) – Required. The Uri of KeyVault.
key_name (str) – Required. The name of KeyVault key.
key_version (str) – Required. The version of KeyVault key.

class azure.mgmt.databricks.models.ErrorDetail(*, code: str, message: str, target: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Error details.

All required parameters must be populated in order to send to Azure.

Parameters

code (str) – Required. The error’s code.
message (str) – Required. A human readable error message.
target (str) – Indicates which property in the request is responsible for the error.

class azure.mgmt.databricks.models.ErrorInfo(*, code: str, message: str, details: Optional[List[azure.mgmt.databricks.models._models_py3.ErrorDetail]] = None, innererror: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The code and message for an error.

All required parameters must be populated in order to send to Azure.

Parameters

code (str) – Required. A machine readable error code.
message (str) – Required. A human readable error message.
details (list[ErrorDetail]) – error details.
innererror (str) – Inner error details if they exist.

class azure.mgmt.databricks.models.ErrorResponse(*, error: azure.mgmt.databricks.models._models_py3.ErrorInfo, **kwargs)[source]¶

Bases: msrest.serialization.Model

Contains details when the response code indicates an error.

All required parameters must be populated in order to send to Azure.

Parameters: error (ErrorInfo) – Required. The error details.

class azure.mgmt.databricks.models.GroupIdInformation(*, properties: azure.mgmt.databricks.models._models_py3.GroupIdInformationProperties, **kwargs)[source]¶

Bases: azure.mgmt.databricks.models._models_py3.Resource

The group information for creating a private endpoint on a workspace.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

properties (GroupIdInformationProperties) – Required. The group id properties.

class azure.mgmt.databricks.models.GroupIdInformationProperties(*, group_id: Optional[str] = None, required_members: Optional[List[str]] = None, required_zone_names: Optional[List[str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The properties for a group information object.

Parameters

group_id (str) – The group id.
required_members (list[str]) – The required members for a specific group id.
required_zone_names (list[str]) – The required DNS zones for a specific group id.

class azure.mgmt.databricks.models.KeySource(value)[source]¶

Bases: str, enum.Enum

The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault

DEFAULT = 'Default'¶

MICROSOFT_KEYVAULT = 'Microsoft.Keyvault'¶

class azure.mgmt.databricks.models.ManagedIdentityConfiguration(**kwargs)[source]¶

Bases: msrest.serialization.Model

The Managed Identity details for storage account.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

principal_id (str) – The objectId of the Managed Identity that is linked to the Managed Storage account.
tenant_id (str) – The tenant Id where the Managed Identity is created.
type (str) – The type of Identity created. It can be either SystemAssigned or UserAssigned.

class azure.mgmt.databricks.models.Operation(*, name: Optional[str] = None, display: Optional[azure.mgmt.databricks.models._models_py3.OperationDisplay] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

REST API operation.

Parameters

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.

class azure.mgmt.databricks.models.OperationDisplay(*, provider: Optional[str] = None, resource: Optional[str] = None, operation: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The object that represents the operation.

Parameters

provider (str) – Service provider: Microsoft.ResourceProvider.
resource (str) – Resource on which the operation is performed.
operation (str) – Operation type: Read, write, delete, etc.

class azure.mgmt.databricks.models.OperationListResult(*, value: Optional[List[azure.mgmt.databricks.models._models_py3.Operation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.

Parameters

value (list[Operation]) – List of Resource Provider operations supported by the Resource Provider resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.databricks.models.PeeringProvisioningState(value)[source]¶

Bases: str, enum.Enum

The current provisioning state.

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.databricks.models.PeeringState(value)[source]¶

Bases: str, enum.Enum

The status of the virtual network peering.

CONNECTED = 'Connected'¶

DISCONNECTED = 'Disconnected'¶

INITIATED = 'Initiated'¶

class azure.mgmt.databricks.models.PrivateEndpoint(**kwargs)[source]¶

Bases: msrest.serialization.Model

The private endpoint property of a private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: id (str) – The resource identifier.

class azure.mgmt.databricks.models.PrivateEndpointConnection(*, properties: azure.mgmt.databricks.models._models_py3.PrivateEndpointConnectionProperties, **kwargs)[source]¶

Bases: msrest.serialization.Model

The private endpoint connection of a workspace.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The resource identifier.
name (str) – The resource name.
type (str) – The resource type.

Parameters

properties (PrivateEndpointConnectionProperties) – Required. The private endpoint connection properties.

class azure.mgmt.databricks.models.PrivateEndpointConnectionProperties(*, private_link_service_connection_state: azure.mgmt.databricks.models._models_py3.PrivateLinkServiceConnectionState, private_endpoint: Optional[azure.mgmt.databricks.models._models_py3.PrivateEndpoint] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The properties of a private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters

private_endpoint (PrivateEndpoint) – Private endpoint.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – Required. Private endpoint connection state.

Variables

provisioning_state (str or PrivateEndpointConnectionProvisioningState) – Provisioning state of the private endpoint connection. Possible values include: “Succeeded”, “Creating”, “Updating”, “Deleting”, “Failed”.

class azure.mgmt.databricks.models.PrivateEndpointConnectionProvisioningState(value)[source]¶

Bases: str, enum.Enum

The current provisioning state.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.databricks.models.PrivateEndpointConnectionsList(*, value: Optional[List[azure.mgmt.databricks.models._models_py3.PrivateEndpointConnection]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

List of private link connections.

Parameters

value (list[PrivateEndpointConnection]) – The list of returned private endpoint connection.
next_link (str) – The URL to get the next set of endpoint connections.

class azure.mgmt.databricks.models.PrivateLinkResourcesList(*, value: Optional[List[azure.mgmt.databricks.models._models_py3.GroupIdInformation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The available private link resources for a workspace.

Parameters

value (list[GroupIdInformation]) – The list of available private link resources for a workspace.
next_link (str) – The URL to get the next set of private link resources.

class azure.mgmt.databricks.models.PrivateLinkServiceConnectionState(*, status: str, description: Optional[str] = None, action_required: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The current state of a private endpoint connection.

All required parameters must be populated in order to send to Azure.

Parameters

status (str or PrivateLinkServiceConnectionStatus) – Required. The status of a private endpoint connection. Possible values include: “Pending”, “Approved”, “Rejected”, “Disconnected”.
description (str) – The description for the current state of a private endpoint connection.
action_required (str) – Actions required for a private endpoint connection.

class azure.mgmt.databricks.models.PrivateLinkServiceConnectionStatus(value)[source]¶

Bases: str, enum.Enum

The status of a private endpoint connection

APPROVED = 'Approved'¶

DISCONNECTED = 'Disconnected'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.databricks.models.ProvisioningState(value)[source]¶

Bases: str, enum.Enum

Provisioning status of the workspace.

ACCEPTED = 'Accepted'¶

CANCELED = 'Canceled'¶

CREATED = 'Created'¶

CREATING = 'Creating'¶

DELETED = 'Deleted'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

READY = 'Ready'¶

RUNNING = 'Running'¶

SUCCEEDED = 'Succeeded'¶

UPDATING = 'Updating'¶

class azure.mgmt.databricks.models.PublicNetworkAccess(value)[source]¶

Bases: str, enum.Enum

The network access type for accessing workspace. Set value to disabled to access workspace only via private link.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.databricks.models.RequiredNsgRules(value)[source]¶

Bases: str, enum.Enum

Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are ‘AllRules’ and ‘NoAzureDatabricksRules’. ‘NoAzureServiceRules’ value is for internal use only.

ALL_RULES = 'AllRules'¶

NO_AZURE_DATABRICKS_RULES = 'NoAzureDatabricksRules'¶

NO_AZURE_SERVICE_RULES = 'NoAzureServiceRules'¶

class azure.mgmt.databricks.models.Resource(**kwargs)[source]¶

Bases: msrest.serialization.Model

The core properties of ARM resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

class azure.mgmt.databricks.models.Sku(*, name: str, tier: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

SKU for the resource.

All required parameters must be populated in order to send to Azure.

Parameters

name (str) – Required. The SKU name.
tier (str) – The SKU tier.

class azure.mgmt.databricks.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[str] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[str] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Metadata pertaining to creation and last modification of the resource.

Parameters

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Possible values include: “User”, “Application”, “ManagedIdentity”, “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.databricks.models.TrackedResource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.databricks.models._models_py3.Resource

The resource model definition for a ARM tracked top level resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.
location (str) – Required. The geo-location where the resource lives.

class azure.mgmt.databricks.models.VirtualNetworkPeering(*, remote_virtual_network: azure.mgmt.databricks.models._models_py3.VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork, allow_virtual_network_access: Optional[bool] = None, allow_forwarded_traffic: Optional[bool] = None, allow_gateway_transit: Optional[bool] = None, use_remote_gateways: Optional[bool] = None, databricks_virtual_network: Optional[azure.mgmt.databricks.models._models_py3.VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork] = None, databricks_address_space: Optional[azure.mgmt.databricks.models._models_py3.AddressSpace] = None, remote_address_space: Optional[azure.mgmt.databricks.models._models_py3.AddressSpace] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Peerings in a VirtualNetwork resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Name of the virtual network peering resource.
id (str) – Resource ID.
type (str) – type of the virtual network peering resource.
peering_state (str or PeeringState) – The status of the virtual network peering. Possible values include: “Initiated”, “Connected”, “Disconnected”.
provisioning_state (str or PeeringProvisioningState) – The provisioning state of the virtual network peering resource. Possible values include: “Succeeded”, “Updating”, “Deleting”, “Failed”.

Parameters

allow_virtual_network_access (bool) – Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space.
allow_forwarded_traffic (bool) – Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network.
allow_gateway_transit (bool) – If gateway links can be used in remote virtual networking to link to this virtual network.
use_remote_gateways (bool) – If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway.
databricks_virtual_network (VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork) – The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
databricks_address_space (AddressSpace) – The reference to the databricks virtual network address space.
remote_virtual_network (VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork) – Required. The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).
remote_address_space (AddressSpace) – The reference to the remote virtual network address space.

class azure.mgmt.databricks.models.VirtualNetworkPeeringList(*, value: Optional[List[azure.mgmt.databricks.models._models_py3.VirtualNetworkPeering]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Gets all virtual network peerings under a workspace.

Parameters

value (list[VirtualNetworkPeering]) – List of virtual network peerings on workspace.
next_link (str) – URL to get the next set of virtual network peering list results if there are any.

class azure.mgmt.databricks.models.VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).

Parameters: id (str) – The Id of the databricks virtual network.

class azure.mgmt.databricks.models.VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering).

Parameters: id (str) – The Id of the remote virtual network.

class azure.mgmt.databricks.models.Workspace(*, location: str, managed_resource_group_id: str, tags: Optional[Dict[str, str]] = None, sku: Optional[azure.mgmt.databricks.models._models_py3.Sku] = None, parameters: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomParameters] = None, ui_definition_uri: Optional[str] = None, authorizations: Optional[List[azure.mgmt.databricks.models._models_py3.WorkspaceProviderAuthorization]] = None, created_by: Optional[azure.mgmt.databricks.models._models_py3.CreatedBy] = None, updated_by: Optional[azure.mgmt.databricks.models._models_py3.CreatedBy] = None, storage_account_identity: Optional[azure.mgmt.databricks.models._models_py3.ManagedIdentityConfiguration] = None, encryption: Optional[azure.mgmt.databricks.models._models_py3.WorkspacePropertiesEncryption] = None, public_network_access: Optional[str] = None, required_nsg_rules: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.databricks.models._models_py3.TrackedResource

Information about workspace.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
system_data (SystemData) – The system metadata relating to this resource.
provisioning_state (str or ProvisioningState) – The workspace provisioning state. Possible values include: “Accepted”, “Running”, “Ready”, “Creating”, “Created”, “Deleting”, “Deleted”, “Canceled”, “Failed”, “Succeeded”, “Updating”.
created_date_time (datetime) – Specifies the date and time when the workspace is created.
workspace_id (str) – The unique identifier of the databricks workspace in databricks control plane.
workspace_url (str) – The workspace URL which is of the format ‘adb-{workspaceId}.{random}.azuredatabricks.net’.
private_endpoint_connections (list[PrivateEndpointConnection]) – Private endpoint connections created on the workspace.

Parameters

tags (dict[str, str]) – A set of tags. Resource tags.
location (str) – Required. The geo-location where the resource lives.
sku (Sku) – The SKU of the resource.
managed_resource_group_id (str) – Required. The managed resource group Id.
parameters (WorkspaceCustomParameters) – The workspace’s custom parameters.
ui_definition_uri (str) – The blob URI where the UI definition file is located.
authorizations (list[WorkspaceProviderAuthorization]) – The workspace provider authorizations.
created_by (CreatedBy) – Indicates the Object ID, PUID and Application ID of entity that created the workspace.
updated_by (CreatedBy) – Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.
storage_account_identity (ManagedIdentityConfiguration) – The details of Managed Identity of Storage Account.
encryption (WorkspacePropertiesEncryption) – Encryption properties for databricks workspace.
public_network_access (str or PublicNetworkAccess) – The network access type for accessing workspace. Set value to disabled to access workspace only via private link. Possible values include: “Enabled”, “Disabled”.
required_nsg_rules (str or RequiredNsgRules) – Gets or sets a value indicating whether data plane (clusters) to control plane communication happen over private endpoint. Supported values are ‘AllRules’ and ‘NoAzureDatabricksRules’. ‘NoAzureServiceRules’ value is for internal use only. Possible values include: “AllRules”, “NoAzureDatabricksRules”, “NoAzureServiceRules”.

class azure.mgmt.databricks.models.WorkspaceCustomBooleanParameter(*, value: bool, **kwargs)[source]¶

Bases: msrest.serialization.Model

The value which should be used for this field.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables: type (str or CustomParameterType) – The type of variable that this is. Possible values include: “Bool”, “Object”, “String”.
Parameters: value (bool) – Required. The value which should be used for this field.

class azure.mgmt.databricks.models.WorkspaceCustomObjectParameter(*, value: Any, **kwargs)[source]¶

Bases: msrest.serialization.Model

The value which should be used for this field.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables: type (str or CustomParameterType) – The type of variable that this is. Possible values include: “Bool”, “Object”, “String”.
Parameters: value (any) – Required. The value which should be used for this field.

class azure.mgmt.databricks.models.WorkspaceCustomParameters(*, aml_workspace_id: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, custom_virtual_network_id: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, custom_public_subnet_name: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, custom_private_subnet_name: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, enable_no_public_ip: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomBooleanParameter] = None, load_balancer_backend_pool_name: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, load_balancer_id: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, nat_gateway_name: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, public_ip_name: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, prepare_encryption: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomBooleanParameter] = None, encryption: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceEncryptionParameter] = None, require_infrastructure_encryption: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomBooleanParameter] = None, storage_account_name: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, storage_account_sku_name: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, vnet_address_prefix: Optional[azure.mgmt.databricks.models._models_py3.WorkspaceCustomStringParameter] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Custom Parameters used for Cluster Creation.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

aml_workspace_id (WorkspaceCustomStringParameter) – The ID of a Azure Machine Learning workspace to link with Databricks workspace.
custom_virtual_network_id (WorkspaceCustomStringParameter) – The ID of a Virtual Network where this Databricks Cluster should be created.
custom_public_subnet_name (WorkspaceCustomStringParameter) – The name of a Public Subnet within the Virtual Network.
custom_private_subnet_name (WorkspaceCustomStringParameter) – The name of the Private Subnet within the Virtual Network.
enable_no_public_ip (WorkspaceCustomBooleanParameter) – Should the Public IP be Disabled?.
load_balancer_backend_pool_name (WorkspaceCustomStringParameter) – Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP).
load_balancer_id (WorkspaceCustomStringParameter) – Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace.
nat_gateway_name (WorkspaceCustomStringParameter) – Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets.
public_ip_name (WorkspaceCustomStringParameter) – Name of the Public IP for No Public IP workspace with managed vNet.
prepare_encryption (WorkspaceCustomBooleanParameter) – Prepare the workspace for encryption. Enables the Managed Identity for managed storage account.
encryption (WorkspaceEncryptionParameter) – Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.
require_infrastructure_encryption (WorkspaceCustomBooleanParameter) – A boolean indicating whether or not the DBFS root file system will be enabled with secondary layer of encryption with platform managed keys for data at rest.
storage_account_name (WorkspaceCustomStringParameter) – Default DBFS storage account name.
storage_account_sku_name (WorkspaceCustomStringParameter) – Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer https://aka.ms/storageskus for valid inputs.
vnet_address_prefix (WorkspaceCustomStringParameter) – Address prefix for Managed virtual network. Default value for this input is 10.139.

Variables

resource_tags (WorkspaceCustomObjectParameter) – Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level.

class azure.mgmt.databricks.models.WorkspaceCustomStringParameter(*, value: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

The Value.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables: type (str or CustomParameterType) – The type of variable that this is. Possible values include: “Bool”, “Object”, “String”.
Parameters: value (str) – Required. The value which should be used for this field.

class azure.mgmt.databricks.models.WorkspaceEncryptionParameter(*, value: Optional[azure.mgmt.databricks.models._models_py3.Encryption] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The object that contains details of encryption used on the workspace.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: type (str or CustomParameterType) – The type of variable that this is. Possible values include: “Bool”, “Object”, “String”.
Parameters: value (Encryption) – The value which should be used for this field.

class azure.mgmt.databricks.models.WorkspaceListResult(*, value: Optional[List[azure.mgmt.databricks.models._models_py3.Workspace]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

List of workspaces.

Parameters

value (list[Workspace]) – The array of workspaces.
next_link (str) – The URL to use for getting the next set of results.

class azure.mgmt.databricks.models.WorkspacePropertiesEncryption(*, entities: azure.mgmt.databricks.models._models_py3.EncryptionEntitiesDefinition, **kwargs)[source]¶

Bases: msrest.serialization.Model

Encryption properties for databricks workspace.

All required parameters must be populated in order to send to Azure.

Parameters: entities (EncryptionEntitiesDefinition) – Required. Encryption entities definition for the workspace.

class azure.mgmt.databricks.models.WorkspaceProviderAuthorization(*, principal_id: str, role_definition_id: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

The workspace provider authorization.

All required parameters must be populated in order to send to Azure.

Parameters

principal_id (str) – Required. The provider’s principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources.
role_definition_id (str) – Required. The provider’s role definition identifier. This role will define all the permissions that the provider must have on the workspace’s container resource group. This role definition cannot have permission to delete the resource group.

class azure.mgmt.databricks.models.WorkspaceUpdate(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An update to a workspace.

Parameters: tags (dict[str, str]) – A set of tags. Resource tags.