---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# azure_databricks_workspace{% #azure_databricks_workspace %}

## `authorizations`{% #authorizations %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `properties.authorizations`**Description**: The workspace provider authorizations.

- `principal_id`**Type**: `STRING`**Provider name**: `principalId`**Description**: 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`**Type**: `STRING`**Provider name**: `roleDefinitionId`**Description**: 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.

## `created_by`{% #created_by %}

**Type**: `STRUCT`**Provider name**: `properties.createdBy`**Description**: Indicates the Object ID, PUID and Application ID of entity that created the workspace.

- `application_id`**Type**: `STRING`**Provider name**: `applicationId`**Description**: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.
- `oid`**Type**: `STRING`**Provider name**: `oid`**Description**: The Object ID that created the workspace.
- `puid`**Type**: `STRING`**Provider name**: `puid`**Description**: The Personal Object ID corresponding to the object ID above

## `created_date_time`{% #created_date_time %}

**Type**: `STRING`**Provider name**: `properties.createdDateTime`**Description**: Specifies the date and time when the workspace is created.

## `disk_encryption_set_id`{% #disk_encryption_set_id %}

**Type**: `STRING`**Provider name**: `properties.diskEncryptionSetId`**Description**: The resource Id of the managed disk encryption set.

## `encryption`{% #encryption %}

**Type**: `STRUCT`**Provider name**: `properties.encryption`**Description**: Encryption properties for databricks workspace

- `entities`**Type**: `STRUCT`**Provider name**: `entities`**Description**: Encryption entities definition for the workspace.
  - `managed_disk`**Type**: `STRUCT`**Provider name**: `managedDisk`**Description**: Encryption properties for the databricks managed disks.
    - `key_source`**Type**: `STRING`**Provider name**: `keySource`**Description**: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault
    - `key_vault_properties`**Type**: `STRUCT`**Provider name**: `keyVaultProperties`**Description**: Key Vault input properties for encryption.
      - `key_name`**Type**: `STRING`**Provider name**: `keyName`**Description**: The name of KeyVault key.
      - `key_vault_uri`**Type**: `STRING`**Provider name**: `keyVaultUri`**Description**: The URI of KeyVault.
      - `key_version`**Type**: `STRING`**Provider name**: `keyVersion`**Description**: The version of KeyVault key.
    - `rotation_to_latest_key_version_enabled`**Type**: `BOOLEAN`**Provider name**: `rotationToLatestKeyVersionEnabled`**Description**: Indicate whether the latest key version should be automatically used for Managed Disk Encryption.
  - `managed_services`**Type**: `STRUCT`**Provider name**: `managedServices`**Description**: Encryption properties for the databricks managed services.
    - `key_source`**Type**: `STRING`**Provider name**: `keySource`**Description**: The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Keyvault
    - `key_vault_properties`**Type**: `STRUCT`**Provider name**: `keyVaultProperties`**Description**: Key Vault input properties for encryption.
      - `key_name`**Type**: `STRING`**Provider name**: `keyName`**Description**: The name of KeyVault key.
      - `key_vault_uri`**Type**: `STRING`**Provider name**: `keyVaultUri`**Description**: The Uri of KeyVault.
      - `key_version`**Type**: `STRING`**Provider name**: `keyVersion`**Description**: The version of KeyVault key.

## `id`{% #id %}

**Type**: `STRING`**Provider name**: `id`**Description**: Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

## `location`{% #location %}

**Type**: `STRING`**Provider name**: `location`**Description**: The geo-location where the resource lives

## `managed_disk_identity`{% #managed_disk_identity %}

**Type**: `STRUCT`**Provider name**: `properties.managedDiskIdentity`**Description**: The details of Managed Identity of Disk Encryption Set used for Managed Disk Encryption

- `principal_id`**Type**: `STRING`**Provider name**: `principalId`**Description**: The objectId of the Managed Identity that is linked to the Managed Storage account.
- `tenant_id`**Type**: `STRING`**Provider name**: `tenantId`**Description**: The tenant Id where the Managed Identity is created.
- `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of Identity created. It can be either SystemAssigned or UserAssigned.

## `managed_resource_group_id`{% #managed_resource_group_id %}

**Type**: `STRING`**Provider name**: `properties.managedResourceGroupId`**Description**: The managed resource group Id.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: The name of the resource

## `parameters`{% #parameters %}

**Type**: `STRUCT`**Provider name**: `properties.parameters`**Description**: The workspace's custom parameters.

- `aml_workspace_id`**Type**: `STRUCT`**Provider name**: `amlWorkspaceId`**Description**: The ID of a Azure Machine Learning workspace to link with Databricks workspace
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `custom_private_subnet_name`**Type**: `STRUCT`**Provider name**: `customPrivateSubnetName`**Description**: The name of the Private Subnet within the Virtual Network
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `custom_public_subnet_name`**Type**: `STRUCT`**Provider name**: `customPublicSubnetName`**Description**: The name of a Public Subnet within the Virtual Network
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `custom_virtual_network_id`**Type**: `STRUCT`**Provider name**: `customVirtualNetworkId`**Description**: The ID of a Virtual Network where this Databricks Cluster should be created
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `enable_no_public_ip`**Type**: `STRUCT`**Provider name**: `enableNoPublicIp`**Description**: Should the Public IP be Disabled?
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `BOOLEAN`**Provider name**: `value`**Description**: The value which should be used for this field.
- `encryption`**Type**: `STRUCT`**Provider name**: `encryption`**Description**: Contains the encryption details for Customer-Managed Key (CMK) enabled workspace.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRUCT`**Provider name**: `value`**Description**: The value which should be used for this field.
    - `key_name`**Type**: `STRING`**Provider name**: `KeyName`**Description**: The name of KeyVault key.
    - `key_source`**Type**: `STRING`**Provider name**: `keySource`**Description**: The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault
    - `keyvaulturi`**Type**: `STRING`**Provider name**: `keyvaulturi`**Description**: The Uri of KeyVault.
    - `keyversion`**Type**: `STRING`**Provider name**: `keyversion`**Description**: The version of KeyVault key.
- `load_balancer_backend_pool_name`**Type**: `STRUCT`**Provider name**: `loadBalancerBackendPoolName`**Description**: Name of the outbound Load Balancer Backend Pool for Secure Cluster Connectivity (No Public IP).
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `load_balancer_id`**Type**: `STRUCT`**Provider name**: `loadBalancerId`**Description**: Resource URI of Outbound Load balancer for Secure Cluster Connectivity (No Public IP) workspace.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `nat_gateway_name`**Type**: `STRUCT`**Provider name**: `natGatewayName`**Description**: Name of the NAT gateway for Secure Cluster Connectivity (No Public IP) workspace subnets.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `prepare_encryption`**Type**: `STRUCT`**Provider name**: `prepareEncryption`**Description**: Prepare the workspace for encryption. Enables the Managed Identity for managed storage account.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `BOOLEAN`**Provider name**: `value`**Description**: The value which should be used for this field.
- `public_ip_name`**Type**: `STRUCT`**Provider name**: `publicIpName`**Description**: Name of the Public IP for No Public IP workspace with managed vNet.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `require_infrastructure_encryption`**Type**: `STRUCT`**Provider name**: `requireInfrastructureEncryption`**Description**: 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.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `BOOLEAN`**Provider name**: `value`**Description**: The value which should be used for this field.
- `resource_tags`**Type**: `STRUCT`**Provider name**: `resourceTags`**Description**: Tags applied to resources under Managed resource group. These can be updated by updating tags at workspace level.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
- `storage_account_name`**Type**: `STRUCT`**Provider name**: `storageAccountName`**Description**: Default DBFS storage account name.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `storage_account_sku_name`**Type**: `STRUCT`**Provider name**: `storageAccountSkuName`**Description**: Storage account SKU name, ex: Standard_GRS, Standard_LRS. Refer [https://aka.ms/storageskus](https://aka.ms/storageskus) for valid inputs.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.
- `vnet_address_prefix`**Type**: `STRUCT`**Provider name**: `vnetAddressPrefix`**Description**: Address prefix for Managed virtual network. Default value for this input is 10.139.
  - `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of variable that this is
  - `value`**Type**: `STRING`**Provider name**: `value`**Description**: The value which should be used for this field.

## `private_endpoint_connections`{% #private_endpoint_connections %}

**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `properties.privateEndpointConnections`**Description**: Private endpoint connections created on the workspace

- `group_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `properties.groupIds`**Description**: GroupIds from the private link service resource.
- `id`**Type**: `STRING`**Provider name**: `id`**Description**: The resource identifier.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: The resource name.
- `private_endpoint`**Type**: `STRUCT`**Provider name**: `properties.privateEndpoint`**Description**: Private endpoint
  - `id`**Type**: `STRING`**Provider name**: `id`**Description**: The resource identifier.
- `private_link_service_connection_state`**Type**: `STRUCT`**Provider name**: `properties.privateLinkServiceConnectionState`**Description**: Private endpoint connection state
  - `actions_required`**Type**: `STRING`**Provider name**: `actionsRequired`**Description**: Actions required for a private endpoint connection
  - `description`**Type**: `STRING`**Provider name**: `description`**Description**: The description for the current state of a private endpoint connection
  - `status`**Type**: `STRING`**Provider name**: `status`**Description**: The status of a private endpoint connection
- `provisioning_state`**Type**: `STRING`**Provider name**: `properties.provisioningState`**Description**: Provisioning state of the private endpoint connection.
- `type`**Type**: `STRING`**Provider name**: `type`**Description**: The resource type.

## `provisioning_state`{% #provisioning_state %}

**Type**: `STRING`**Provider name**: `properties.provisioningState`**Description**: The workspace provisioning state.

## `public_network_access`{% #public_network_access %}

**Type**: `STRING`**Provider name**: `properties.publicNetworkAccess`**Description**: The network access type for accessing workspace. Set value to disabled to access workspace only via private link.

## `required_nsg_rules`{% #required_nsg_rules %}

**Type**: `STRING`**Provider name**: `properties.requiredNsgRules`**Description**: 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.

## `resource_group`{% #resource_group %}

**Type**: `STRING`

## `sku`{% #sku %}

**Type**: `STRUCT`**Provider name**: `sku`**Description**: The SKU of the resource.

- `name`**Type**: `STRING`**Provider name**: `name`**Description**: The SKU name.
- `tier`**Type**: `STRING`**Provider name**: `tier`**Description**: The SKU tier.

## `storage_account_identity`{% #storage_account_identity %}

**Type**: `STRUCT`**Provider name**: `properties.storageAccountIdentity`**Description**: The details of Managed Identity of Storage Account

- `principal_id`**Type**: `STRING`**Provider name**: `principalId`**Description**: The objectId of the Managed Identity that is linked to the Managed Storage account.
- `tenant_id`**Type**: `STRING`**Provider name**: `tenantId`**Description**: The tenant Id where the Managed Identity is created.
- `type`**Type**: `STRING`**Provider name**: `type`**Description**: The type of Identity created. It can be either SystemAssigned or UserAssigned.

## `subscription_id`{% #subscription_id %}

**Type**: `STRING`

## `subscription_name`{% #subscription_name %}

**Type**: `STRING`

## `system_data`{% #system_data %}

**Type**: `STRUCT`**Provider name**: `systemData`**Description**: The system metadata relating to this resource

- `created_at`**Type**: `STRING`**Provider name**: `createdAt`**Description**: The timestamp of resource creation (UTC).
- `created_by`**Type**: `STRING`**Provider name**: `createdBy`**Description**: The identity that created the resource.
- `created_by_type`**Type**: `STRING`**Provider name**: `createdByType`**Description**: The type of identity that created the resource.
- `last_modified_at`**Type**: `STRING`**Provider name**: `lastModifiedAt`**Description**: The timestamp of resource last modification (UTC)
- `last_modified_by`**Type**: `STRING`**Provider name**: `lastModifiedBy`**Description**: The identity that last modified the resource.
- `last_modified_by_type`**Type**: `STRING`**Provider name**: `lastModifiedByType`**Description**: The type of identity that last modified the resource.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `type`{% #type %}

**Type**: `STRING`**Provider name**: `type`**Description**: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.

## `ui_definition_uri`{% #ui_definition_uri %}

**Type**: `STRING`**Provider name**: `properties.uiDefinitionUri`**Description**: The blob URI where the UI definition file is located.

## `updated_by`{% #updated_by %}

**Type**: `STRUCT`**Provider name**: `properties.updatedBy`**Description**: Indicates the Object ID, PUID and Application ID of entity that last updated the workspace.

- `application_id`**Type**: `STRING`**Provider name**: `applicationId`**Description**: The application ID of the application that initiated the creation of the workspace. For example, Azure Portal.
- `oid`**Type**: `STRING`**Provider name**: `oid`**Description**: The Object ID that created the workspace.
- `puid`**Type**: `STRING`**Provider name**: `puid`**Description**: The Personal Object ID corresponding to the object ID above

## `workspace_id`{% #workspace_id %}

**Type**: `STRING`**Provider name**: `properties.workspaceId`**Description**: The unique identifier of the databricks workspace in databricks control plane.

## `workspace_url`{% #workspace_url %}

**Type**: `STRING`**Provider name**: `properties.workspaceUrl`**Description**: The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'