azure.mgmt.databricks.models module¶
-
class
azure.mgmt.databricks.models.
AccessConnector
(*, location: str, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityData] = None, properties: Optional[_models.AccessConnectorProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks.models._models_py3.TrackedResource
Information about azure databricks accessConnector.
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.
location (str) – The geo-location where the resource lives. Required.
identity (IdentityData) – Identity for the resource.
properties (AccessConnectorProperties) – Azure Databricks accessConnector properties.
- Keyword Arguments
location (str) – The geo-location where the resource lives. Required.
identity (IdentityData) – Identity for the resource.
properties (AccessConnectorProperties) – Azure Databricks accessConnector properties.
-
class
azure.mgmt.databricks.models.
AccessConnectorListResult
(*, value: Optional[List[_models.AccessConnector]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
List of azure databricks accessConnector.
- Variables
value (list[AccessConnector]) – The array of azure databricks accessConnector.
next_link (str) – The URL to use for getting the next set of results.
- Keyword Arguments
value (list[AccessConnector]) – The array of azure databricks accessConnector.
next_link (str) – The URL to use for getting the next set of results.
-
class
azure.mgmt.databricks.models.
AccessConnectorProperties
(**kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
AccessConnectorProperties.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
provisioning_state (str or ProvisioningState) – Provisioning status of the accessConnector. Known values are: “Accepted”, “Running”, “Ready”, “Creating”, “Created”, “Deleting”, “Deleted”, “Canceled”, “Failed”, “Succeeded”, and “Updating”.
-
class
azure.mgmt.databricks.models.
AccessConnectorUpdate
(*, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.IdentityData] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
An update to an azure databricks accessConnector.
- Variables
identity (IdentityData) – The identity of the resource.
- Keyword Arguments
identity (IdentityData) – The identity of the resource.
-
class
azure.mgmt.databricks.models.
AddressSpace
(*, address_prefixes: Optional[List[str]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network.
-
class
azure.mgmt.databricks.models.
CreatedBy
(**kwargs)[source]¶ Bases:
azure.mgmt.databricks._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.
-
class
azure.mgmt.databricks.models.
CreatedByType
(value)[source]¶ -
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]¶ -
Provisioning status of the workspace.
-
BOOL
= 'Bool'¶
-
OBJECT
= 'Object'¶
-
STRING
= 'String'¶
-
-
class
azure.mgmt.databricks.models.
Encryption
(*, key_source: Union[str, _models.KeySource] = 'Default', key_name: Optional[str] = None, key_version: Optional[str] = None, key_vault_uri: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
The object that contains details of encryption used on the workspace.
- Variables
key_source (str or KeySource) – The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault. Known values are: “Default” and “Microsoft.Keyvault”.
key_name (str) – The name of KeyVault key.
key_version (str) – The version of KeyVault key.
key_vault_uri (str) – The Uri of KeyVault.
- Keyword Arguments
key_source (str or KeySource) – The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault. Known values are: “Default” and “Microsoft.Keyvault”.
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[_models.EncryptionV2] = None, managed_disk: Optional[_models.ManagedDiskEncryption] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Encryption entities for databricks workspace resource.
- Variables
managed_services (EncryptionV2) – Encryption properties for the databricks managed services.
managed_disk (ManagedDiskEncryption) – Encryption properties for the databricks managed disks.
- Keyword Arguments
managed_services (EncryptionV2) – Encryption properties for the databricks managed services.
managed_disk (ManagedDiskEncryption) – Encryption properties for the databricks managed disks.
-
class
azure.mgmt.databricks.models.
EncryptionKeySource
(value)[source]¶ -
The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault.
-
MICROSOFT_KEYVAULT
= 'Microsoft.Keyvault'¶
-
-
class
azure.mgmt.databricks.models.
EncryptionV2
(*, key_source: Union[str, _models.EncryptionKeySource], key_vault_properties: Optional[_models.EncryptionV2KeyVaultProperties] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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.
- Variables
key_source (str or EncryptionKeySource) – The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Required. “Microsoft.Keyvault”
key_vault_properties (EncryptionV2KeyVaultProperties) – Key Vault input properties for encryption.
- Keyword Arguments
key_source (str or EncryptionKeySource) – The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Required. “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:
azure.mgmt.databricks._serialization.Model
Key Vault input properties for encryption.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.databricks.models.
EndpointDependency
(*, domain_name: Optional[str] = None, endpoint_details: Optional[List[_models.EndpointDetail]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
A domain name or IP address the Workspace is reaching at.
- Variables
domain_name (str) – The domain name of the dependency.
endpoint_details (list[EndpointDetail]) – The Ports used when connecting to domainName.
- Keyword Arguments
domain_name (str) – The domain name of the dependency.
endpoint_details (list[EndpointDetail]) – The Ports used when connecting to domainName.
-
class
azure.mgmt.databricks.models.
EndpointDetail
(*, ip_address: Optional[str] = None, port: Optional[int] = None, latency: Optional[float] = None, is_accessible: Optional[bool] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Connect information from the Workspace to a single endpoint.
- Variables
ip_address (str) – An IP Address that Domain Name currently resolves to.
port (int) – The port an endpoint is connected to.
latency (float) – The time in milliseconds it takes for the connection to be created from the Workspace to this IpAddress at this Port.
is_accessible (bool) – Whether it is possible to create a connection from the Workspace to this IpAddress at this Port.
- Keyword Arguments
ip_address (str) – An IP Address that Domain Name currently resolves to.
port (int) – The port an endpoint is connected to.
latency (float) – The time in milliseconds it takes for the connection to be created from the Workspace to this IpAddress at this Port.
is_accessible (bool) – Whether it is possible to create a connection from the Workspace to this IpAddress at this Port.
-
class
azure.mgmt.databricks.models.
ErrorDetail
(*, code: str, message: str, target: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Error details.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.databricks.models.
ErrorInfo
(*, code: str, message: str, details: Optional[List[_models.ErrorDetail]] = None, innererror: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
The code and message for an error.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
code (str) – A machine readable error code. Required.
message (str) – A human readable error message. Required.
details (list[ErrorDetail]) – error details.
innererror (str) – Inner error details if they exist.
-
class
azure.mgmt.databricks.models.
ErrorResponse
(*, error: _models.ErrorInfo, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Contains details when the response code indicates an error.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.databricks.models.
GroupIdInformation
(*, properties: _models.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.
properties (GroupIdInformationProperties) – The group id properties. Required.
- Keyword Arguments
properties (GroupIdInformationProperties) – The group id properties. Required.
-
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:
azure.mgmt.databricks._serialization.Model
The properties for a group information object.
- Variables
- Keyword Arguments
-
class
azure.mgmt.databricks.models.
IdentityData
(*, type: Union[str, _models.IdentityType], **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Identity for the 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
principal_id (str) – The principal ID of resource identity.
tenant_id (str) – The tenant ID of resource.
type (str or IdentityType) – The identity type. Required. Known values are: “None” and “SystemAssigned”.
- Keyword Arguments
type (str or IdentityType) – The identity type. Required. Known values are: “None” and “SystemAssigned”.
-
class
azure.mgmt.databricks.models.
IdentityType
(value)[source]¶ -
The identity type.
-
NONE
= 'None'¶
-
SYSTEM_ASSIGNED
= 'SystemAssigned'¶
-
-
class
azure.mgmt.databricks.models.
KeySource
(value)[source]¶ -
The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault.
-
DEFAULT
= 'Default'¶
-
MICROSOFT_KEYVAULT
= 'Microsoft.Keyvault'¶
-
-
class
azure.mgmt.databricks.models.
ManagedDiskEncryption
(*, key_source: Union[str, _models.EncryptionKeySource], key_vault_properties: _models.ManagedDiskEncryptionKeyVaultProperties, rotation_to_latest_key_version_enabled: Optional[bool] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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.
- Variables
key_source (str or EncryptionKeySource) – The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Required. “Microsoft.Keyvault”
key_vault_properties (ManagedDiskEncryptionKeyVaultProperties) – Key Vault input properties for encryption. Required.
rotation_to_latest_key_version_enabled (bool) – Indicate whether the latest key version should be automatically used for Managed Disk Encryption.
- Keyword Arguments
key_source (str or EncryptionKeySource) – The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault. Required. “Microsoft.Keyvault”
key_vault_properties (ManagedDiskEncryptionKeyVaultProperties) – Key Vault input properties for encryption. Required.
rotation_to_latest_key_version_enabled (bool) – Indicate whether the latest key version should be automatically used for Managed Disk Encryption.
-
class
azure.mgmt.databricks.models.
ManagedDiskEncryptionKeyVaultProperties
(*, key_vault_uri: str, key_name: str, key_version: str, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Key Vault input properties for encryption.
All required parameters must be populated in order to send to Azure.
- Variables
- Keyword Arguments
-
class
azure.mgmt.databricks.models.
ManagedIdentityConfiguration
(**kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
The Managed Identity details for storage account.
Variables are only populated by the server, and will be ignored when sending a request.
-
class
azure.mgmt.databricks.models.
Operation
(*, name: Optional[str] = None, display: Optional[_models.OperationDisplay] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
REST API operation.
- Variables
name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that represents the operation.
- Keyword Arguments
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:
azure.mgmt.databricks._serialization.Model
The object that represents the operation.
- Variables
- Keyword Arguments
-
class
azure.mgmt.databricks.models.
OperationListResult
(*, value: Optional[List[_models.Operation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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.
- Variables
- Keyword Arguments
-
class
azure.mgmt.databricks.models.
OutboundEnvironmentEndpoint
(*, category: Optional[str] = None, endpoints: Optional[List[_models.EndpointDependency]] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Egress endpoints which Workspace connects to for common purposes.
- Variables
category (str) – The category of endpoints accessed by the Workspace, e.g. azure-storage, azure-mysql, etc.
endpoints (list[EndpointDependency]) – The endpoints that Workspace connect to.
- Keyword Arguments
category (str) – The category of endpoints accessed by the Workspace, e.g. azure-storage, azure-mysql, etc.
endpoints (list[EndpointDependency]) – The endpoints that Workspace connect to.
-
class
azure.mgmt.databricks.models.
PeeringProvisioningState
(value)[source]¶ -
The current provisioning state.
-
DELETING
= 'Deleting'¶
-
FAILED
= 'Failed'¶
-
SUCCEEDED
= 'Succeeded'¶
-
UPDATING
= 'Updating'¶
-
-
class
azure.mgmt.databricks.models.
PeeringState
(value)[source]¶ -
The status of the virtual network peering.
-
CONNECTED
= 'Connected'¶
-
DISCONNECTED
= 'Disconnected'¶
-
INITIATED
= 'Initiated'¶
-
-
class
azure.mgmt.databricks.models.
PrivateEndpoint
(**kwargs)[source]¶ Bases:
azure.mgmt.databricks._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.
-
class
azure.mgmt.databricks.models.
PrivateEndpointConnection
(*, properties: _models.PrivateEndpointConnectionProperties, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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
- Keyword Arguments
properties (PrivateEndpointConnectionProperties) – The private endpoint connection properties. Required.
-
class
azure.mgmt.databricks.models.
PrivateEndpointConnectionProperties
(*, private_link_service_connection_state: _models.PrivateLinkServiceConnectionState, private_endpoint: Optional[_models.PrivateEndpoint] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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.
- Variables
private_endpoint (PrivateEndpoint) – Private endpoint.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – Private endpoint connection state. Required.
provisioning_state (str or PrivateEndpointConnectionProvisioningState) – Provisioning state of the private endpoint connection. Known values are: “Succeeded”, “Creating”, “Updating”, “Deleting”, and “Failed”.
- Keyword Arguments
private_endpoint (PrivateEndpoint) – Private endpoint.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – Private endpoint connection state. Required.
-
class
azure.mgmt.databricks.models.
PrivateEndpointConnectionProvisioningState
(value)[source]¶ -
The current provisioning state.
-
CREATING
= 'Creating'¶
-
DELETING
= 'Deleting'¶
-
FAILED
= 'Failed'¶
-
SUCCEEDED
= 'Succeeded'¶
-
UPDATING
= 'Updating'¶
-
-
class
azure.mgmt.databricks.models.
PrivateEndpointConnectionsList
(*, value: Optional[List[_models.PrivateEndpointConnection]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
List of private link connections.
- Variables
value (list[PrivateEndpointConnection]) – The list of returned private endpoint connection.
next_link (str) – The URL to get the next set of endpoint connections.
- Keyword Arguments
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[_models.GroupIdInformation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
The available private link resources for a workspace.
- Variables
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.
- Keyword Arguments
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: Union[str, _models.PrivateLinkServiceConnectionStatus], description: Optional[str] = None, action_required: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
The current state of a private endpoint connection.
All required parameters must be populated in order to send to Azure.
- Variables
status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “Disconnected”.
description (str) – The description for the current state of a private endpoint connection.
action_required (str) – Actions required for a private endpoint connection.
- Keyword Arguments
status (str or PrivateLinkServiceConnectionStatus) – The status of a private endpoint connection. Required. Known values are: “Pending”, “Approved”, “Rejected”, and “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]¶ -
The status of a private endpoint connection.
-
APPROVED
= 'Approved'¶
-
DISCONNECTED
= 'Disconnected'¶
-
PENDING
= 'Pending'¶
-
REJECTED
= 'Rejected'¶
-
-
class
azure.mgmt.databricks.models.
ProvisioningState
(value)[source]¶ -
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]¶ -
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]¶ -
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:
azure.mgmt.databricks._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:
azure.mgmt.databricks._serialization.Model
SKU for the resource.
All required parameters must be populated in order to send to Azure.
-
class
azure.mgmt.databricks.models.
SystemData
(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Metadata pertaining to creation and last modification of the resource.
- Variables
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “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. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).
- Keyword Arguments
created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “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. Known values are: “User”, “Application”, “ManagedIdentity”, and “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.
location (str) – The geo-location where the resource lives. Required.
- Keyword Arguments
-
class
azure.mgmt.databricks.models.
VirtualNetworkPeering
(*, remote_virtual_network: _models.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[_models.VirtualNetworkPeeringPropertiesFormatDatabricksVirtualNetwork] = None, databricks_address_space: Optional[_models.AddressSpace] = None, remote_address_space: Optional[_models.AddressSpace] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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.
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) – 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). Required.
remote_address_space (AddressSpace) – The reference to the remote virtual network address space.
peering_state (str or PeeringState) – The status of the virtual network peering. Known values are: “Initiated”, “Connected”, and “Disconnected”.
provisioning_state (str or PeeringProvisioningState) – The provisioning state of the virtual network peering resource. Known values are: “Succeeded”, “Updating”, “Deleting”, and “Failed”.
- Keyword Arguments
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) – 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). Required.
remote_address_space (AddressSpace) – The reference to the remote virtual network address space.
-
class
azure.mgmt.databricks.models.
VirtualNetworkPeeringList
(*, value: Optional[List[_models.VirtualNetworkPeering]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Gets all virtual network peerings under a workspace.
- Variables
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.
- Keyword Arguments
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:
azure.mgmt.databricks._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).
-
class
azure.mgmt.databricks.models.
VirtualNetworkPeeringPropertiesFormatRemoteVirtualNetwork
(*, id: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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).
-
class
azure.mgmt.databricks.models.
Workspace
(*, location: str, managed_resource_group_id: str, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.Sku] = None, parameters: Optional[_models.WorkspaceCustomParameters] = None, ui_definition_uri: Optional[str] = None, authorizations: Optional[List[_models.WorkspaceProviderAuthorization]] = None, created_by: Optional[_models.CreatedBy] = None, updated_by: Optional[_models.CreatedBy] = None, storage_account_identity: Optional[_models.ManagedIdentityConfiguration] = None, managed_disk_identity: Optional[_models.ManagedIdentityConfiguration] = None, disk_encryption_set_id: Optional[str] = None, encryption: Optional[_models.WorkspacePropertiesEncryption] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, required_nsg_rules: Optional[Union[str, _models.RequiredNsgRules]] = 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.
location (str) – The geo-location where the resource lives. Required.
sku (Sku) – The SKU of the resource.
system_data (SystemData) – The system metadata relating to this resource.
managed_resource_group_id (str) – The managed resource group Id. Required.
parameters (WorkspaceCustomParameters) – The workspace’s custom parameters.
provisioning_state (str or ProvisioningState) – The workspace provisioning state. Known values are: “Accepted”, “Running”, “Ready”, “Creating”, “Created”, “Deleting”, “Deleted”, “Canceled”, “Failed”, “Succeeded”, and “Updating”.
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.
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’.
storage_account_identity (ManagedIdentityConfiguration) – The details of Managed Identity of Storage Account.
managed_disk_identity (ManagedIdentityConfiguration) – The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption.
disk_encryption_set_id (str) – The resource Id of the managed disk encryption set.
encryption (WorkspacePropertiesEncryption) – Encryption properties for databricks workspace.
private_endpoint_connections (list[PrivateEndpointConnection]) – Private endpoint connections created on the 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. Known values are: “Enabled” and “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. Known values are: “AllRules”, “NoAzureDatabricksRules”, and “NoAzureServiceRules”.
- Keyword Arguments
location (str) – The geo-location where the resource lives. Required.
sku (Sku) – The SKU of the resource.
managed_resource_group_id (str) – The managed resource group Id. Required.
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.
managed_disk_identity (ManagedIdentityConfiguration) – The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption.
disk_encryption_set_id (str) – The resource Id of the managed disk encryption set.
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. Known values are: “Enabled” and “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. Known values are: “AllRules”, “NoAzureDatabricksRules”, and “NoAzureServiceRules”.
-
class
azure.mgmt.databricks.models.
WorkspaceCustomBooleanParameter
(*, value: bool, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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. Known values are: “Bool”, “Object”, and “String”.
value (bool) – The value which should be used for this field. Required.
- Keyword Arguments
value (bool) – The value which should be used for this field. Required.
-
class
azure.mgmt.databricks.models.
WorkspaceCustomObjectParameter
(*, value: collections.abc.MutableMapping[str, Any], **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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. Known values are: “Bool”, “Object”, and “String”.
value (JSON) – The value which should be used for this field. Required.
- Keyword Arguments
value (JSON) – The value which should be used for this field. Required.
-
class
azure.mgmt.databricks.models.
WorkspaceCustomParameters
(*, aml_workspace_id: Optional[_models.WorkspaceCustomStringParameter] = None, custom_virtual_network_id: Optional[_models.WorkspaceCustomStringParameter] = None, custom_public_subnet_name: Optional[_models.WorkspaceCustomStringParameter] = None, custom_private_subnet_name: Optional[_models.WorkspaceCustomStringParameter] = None, enable_no_public_ip: Optional[_models.WorkspaceCustomBooleanParameter] = None, load_balancer_backend_pool_name: Optional[_models.WorkspaceCustomStringParameter] = None, load_balancer_id: Optional[_models.WorkspaceCustomStringParameter] = None, nat_gateway_name: Optional[_models.WorkspaceCustomStringParameter] = None, public_ip_name: Optional[_models.WorkspaceCustomStringParameter] = None, prepare_encryption: Optional[_models.WorkspaceCustomBooleanParameter] = None, encryption: Optional[_models.WorkspaceEncryptionParameter] = None, require_infrastructure_encryption: Optional[_models.WorkspaceCustomBooleanParameter] = None, storage_account_name: Optional[_models.WorkspaceCustomStringParameter] = None, storage_account_sku_name: Optional[_models.WorkspaceCustomStringParameter] = None, vnet_address_prefix: Optional[_models.WorkspaceCustomStringParameter] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Custom Parameters used for Cluster Creation.
Variables are only populated by the server, and will be ignored when sending a request.
- Variables
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.
resource_tags (WorkspaceCustomObjectParameter) – Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level.
- Keyword Arguments
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.
-
class
azure.mgmt.databricks.models.
WorkspaceCustomStringParameter
(*, value: str, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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. Known values are: “Bool”, “Object”, and “String”.
value (str) – The value which should be used for this field. Required.
- Keyword Arguments
value (str) – The value which should be used for this field. Required.
-
class
azure.mgmt.databricks.models.
WorkspaceEncryptionParameter
(*, value: Optional[_models.Encryption] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._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. Known values are: “Bool”, “Object”, and “String”.
value (Encryption) – The value which should be used for this field.
- Keyword Arguments
value (Encryption) – The value which should be used for this field.
-
class
azure.mgmt.databricks.models.
WorkspaceListResult
(*, value: Optional[List[_models.Workspace]] = None, next_link: Optional[str] = None, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
List of workspaces.
-
class
azure.mgmt.databricks.models.
WorkspacePropertiesEncryption
(*, entities: _models.EncryptionEntitiesDefinition, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
Encryption properties for databricks workspace.
All required parameters must be populated in order to send to Azure.
- Variables
entities (EncryptionEntitiesDefinition) – Encryption entities definition for the workspace. Required.
- Keyword Arguments
entities (EncryptionEntitiesDefinition) – Encryption entities definition for the workspace. Required.
-
class
azure.mgmt.databricks.models.
WorkspaceProviderAuthorization
(*, principal_id: str, role_definition_id: str, **kwargs)[source]¶ Bases:
azure.mgmt.databricks._serialization.Model
The workspace provider authorization.
All required parameters must be populated in order to send to Azure.
- Variables
principal_id (str) – The provider’s principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. Required.
role_definition_id (str) – 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. Required.
- Keyword Arguments
principal_id (str) – The provider’s principal identifier. This is the identity that the provider will use to call ARM to manage the workspace resources. Required.
role_definition_id (str) – 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. Required.