pulumi-databricks 1.77.0a1760247900__tar.gz → 1.77.0a1760375482__tar.gz

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pulumi_databricks
-Version: 1.77.0a1760247900
+Version: 1.77.0a1760375482
 Summary: A Pulumi package for creating and managing databricks cloud resources.
 License: Apache-2.0
 Project-URL: Homepage, https://www.pulumi.com

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/account_federation_policy.py

@@ -248,6 +248,8 @@ class AccountFederationPolicy(pulumi.CustomResource):
         * which IdP, or issuer, your Databricks account should accept tokens from
         * how to determine which Databricks user, or subject, a token is issued for
 
+        ## Example Usage
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.
@@ -289,6 +291,8 @@ class AccountFederationPolicy(pulumi.CustomResource):
         * which IdP, or issuer, your Databricks account should accept tokens from
         * how to determine which Databricks user, or subject, a token is issued for
 
+        ## Example Usage
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/account_network_policy.py

@@ -153,6 +153,8 @@ class AccountNetworkPolicy(pulumi.CustomResource):
 
         > **Note** This resource can only be used with an account-level provider!
 
+        ## Example Usage
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.
@@ -198,6 +200,8 @@ class AccountNetworkPolicy(pulumi.CustomResource):
 
         > **Note** This resource can only be used with an account-level provider!
 
+        ## Example Usage
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/alert_v2.py

@@ -503,6 +503,9 @@ class AlertV2(pulumi.CustomResource):
 
         ## Example Usage
 
+        ### Basic Alert Example
+        This example creates a basic alert that monitors a query and sends notifications to a user when the value exceeds a threshold:
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.
@@ -554,6 +557,9 @@ class AlertV2(pulumi.CustomResource):
 
         ## Example Usage
 
+        ### Basic Alert Example
+        This example creates a basic alert that monitors a query and sends notifications to a user when the value exceeds a threshold:
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/app.py

@@ -488,6 +488,17 @@ class App(pulumi.CustomResource):
 
         > This resource can only be used with a workspace-level provider!
 
+        ## Example Usage
+
+        ## Related Resources
+
+        The following resources are used in the same context:
+
+        * SqlEndpoint to manage Databricks SQL [Endpoints](https://docs.databricks.com/sql/admin/sql-endpoints.html).
+        * ModelServing to serve this model on a Databricks serving endpoint.
+        * Secret to manage [secrets](https://docs.databricks.com/security/secrets/index.html#secrets-user-guide) in Databricks workspace.
+        * Job to manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code.
+
         ## Import
 
         This resource can be imported by name:
@@ -529,6 +540,17 @@ class App(pulumi.CustomResource):
 
         > This resource can only be used with a workspace-level provider!
 
+        ## Example Usage
+
+        ## Related Resources
+
+        The following resources are used in the same context:
+
+        * SqlEndpoint to manage Databricks SQL [Endpoints](https://docs.databricks.com/sql/admin/sql-endpoints.html).
+        * ModelServing to serve this model on a Databricks serving endpoint.
+        * Secret to manage [secrets](https://docs.databricks.com/security/secrets/index.html#secrets-user-guide) in Databricks workspace.
+        * Job to manage [Databricks Jobs](https://docs.databricks.com/jobs.html) to run non-interactive code.
+
         ## Import
 
         This resource can be imported by name:

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/apps_settings_custom_template.py

@@ -313,6 +313,14 @@ class AppsSettingsCustomTemplate(pulumi.CustomResource):
             })
         ```
 
+        ### Example with API Scopes
+
+        This example creates a custom template that declares required user API scopes.
+
+        ### Example with Resource Requirements
+
+        This example defines a template that requests specific workspace resources with permissions granted.
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.
@@ -375,6 +383,14 @@ class AppsSettingsCustomTemplate(pulumi.CustomResource):
             })
         ```
 
+        ### Example with API Scopes
+
+        This example creates a custom template that declares required user API scopes.
+
+        ### Example with Resource Requirements
+
+        This example defines a template that requests specific workspace resources with permissions granted.
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/clean_rooms_clean_room.py

@@ -313,6 +313,8 @@ class CleanRoomsCleanRoom(pulumi.CustomResource):
 
         ## Example Usage
 
+        # Example: Clean Room Resource
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.
@@ -354,6 +356,8 @@ class CleanRoomsCleanRoom(pulumi.CustomResource):
 
         ## Example Usage
 
+        # Example: Clean Room Resource
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/database_synced_database_table.py

@@ -325,6 +325,19 @@ class DatabaseSyncedDatabaseTable(pulumi.CustomResource):
 
         ## Example Usage
 
+        ### Creating a Synced Database Table inside a Database Catalog
+
+        This example creates a Synced Database Table inside a Database Catalog.
+
+        ### Creating a Synced Database Table inside a Standard Catalog
+
+        This example creates a Synced Database Table inside a Standard Catalog.
+
+        ### Creating multiple Synced Database Tables and bin packing them into a single pipeline
+
+        This example creates two Synced Database Tables. The first one specifies a new pipeline spec,
+        which generates a new pipeline. The second one utilizes the pipeline ID of the first table.
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.
@@ -379,6 +392,19 @@ class DatabaseSyncedDatabaseTable(pulumi.CustomResource):
 
         ## Example Usage
 
+        ### Creating a Synced Database Table inside a Database Catalog
+
+        This example creates a Synced Database Table inside a Database Catalog.
+
+        ### Creating a Synced Database Table inside a Standard Catalog
+
+        This example creates a Synced Database Table inside a Standard Catalog.
+
+        ### Creating multiple Synced Database Tables and bin packing them into a single pipeline
+
+        This example creates two Synced Database Tables. The first one specifies a new pipeline spec,
+        which generates a new pipeline. The second one utilizes the pipeline ID of the first table.
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/get_account_federation_policy.py

@@ -162,6 +162,10 @@ def get_account_federation_policy(description: Optional[_builtins.str] = None,
 
     > **Note** This data source can only be used with an account-level provider!
 
+    ## Example Usage
+
+    Referring to an account federation policy by id:
+
 
     :param _builtins.str description: (string) - Description of the federation policy
     :param Union['GetAccountFederationPolicyOidcPolicyArgs', 'GetAccountFederationPolicyOidcPolicyArgsDict'] oidc_policy: (OidcFederationPolicy)
@@ -196,6 +200,10 @@ def get_account_federation_policy_output(description: Optional[pulumi.Input[Opti
 
     > **Note** This data source can only be used with an account-level provider!
 
+    ## Example Usage
+
+    Referring to an account federation policy by id:
+
 
     :param _builtins.str description: (string) - Description of the federation policy
     :param Union['GetAccountFederationPolicyOidcPolicyArgs', 'GetAccountFederationPolicyOidcPolicyArgsDict'] oidc_policy: (OidcFederationPolicy)

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/get_account_network_policy.py

@@ -96,6 +96,10 @@ def get_account_network_policy(account_id: Optional[_builtins.str] = None,
 
     > **Note** This data source can only be used with an account-level provider!
 
+    ## Example Usage
+
+    Referring to a network policy by id:
+
 
     :param _builtins.str account_id: (string) - The associated account ID for this Network Policy object
     :param Union['GetAccountNetworkPolicyEgressArgs', 'GetAccountNetworkPolicyEgressArgsDict'] egress: (NetworkPolicyEgress) - The network policies applying for egress traffic
@@ -122,6 +126,10 @@ def get_account_network_policy_output(account_id: Optional[pulumi.Input[Optional
 
     > **Note** This data source can only be used with an account-level provider!
 
+    ## Example Usage
+
+    Referring to a network policy by id:
+
 
     :param _builtins.str account_id: (string) - The associated account ID for this Network Policy object
     :param Union['GetAccountNetworkPolicyEgressArgs', 'GetAccountNetworkPolicyEgressArgsDict'] egress: (NetworkPolicyEgress) - The network policies applying for egress traffic

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/get_alert_v2.py

@@ -271,6 +271,9 @@ def get_alert_v2(custom_description: Optional[_builtins.str] = None,
 
     ## Example Usage
 
+    ### Retrieve Alert by ID
+    This example retrieves a specific alert by its ID:
+
 
     :param _builtins.str custom_description: (string) - Custom description for the alert. support mustache template
     :param _builtins.str custom_summary: (string) - Custom summary for the alert. support mustache template
@@ -346,6 +349,9 @@ def get_alert_v2_output(custom_description: Optional[pulumi.Input[Optional[_buil
 
     ## Example Usage
 
+    ### Retrieve Alert by ID
+    This example retrieves a specific alert by its ID:
+
 
     :param _builtins.str custom_description: (string) - Custom description for the alert. support mustache template
     :param _builtins.str custom_summary: (string) - Custom summary for the alert. support mustache template

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/get_dashboards.py

@@ -78,6 +78,8 @@ def get_dashboards(dashboard_name_contains: Optional[_builtins.str] = None,
 
     > This data source can only be used with a workspace-level provider!
 
+    ## Example Usage
+
 
     :param _builtins.str dashboard_name_contains: A **case-insensitive** substring to filter Dashboards by their name.
     """
@@ -97,6 +99,8 @@ def get_dashboards_output(dashboard_name_contains: Optional[pulumi.Input[Optiona
 
     > This data source can only be used with a workspace-level provider!
 
+    ## Example Usage
+
 
     :param _builtins.str dashboard_name_contains: A **case-insensitive** substring to filter Dashboards by their name.
     """

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/get_service_principal_federation_policy.py

@@ -162,6 +162,10 @@ def get_service_principal_federation_policy(description: Optional[_builtins.str]
 
     > **Note** This data source can only be used with an account-level provider!
 
+    ## Example Usage
+
+    Referring to a service principal federation policy by id:
+
 
     :param _builtins.str description: (string) - Description of the federation policy
     :param Union['GetServicePrincipalFederationPolicyOidcPolicyArgs', 'GetServicePrincipalFederationPolicyOidcPolicyArgsDict'] oidc_policy: (OidcFederationPolicy)
@@ -196,6 +200,10 @@ def get_service_principal_federation_policy_output(description: Optional[pulumi.
 
     > **Note** This data source can only be used with an account-level provider!
 
+    ## Example Usage
+
+    Referring to a service principal federation policy by id:
+
 
     :param _builtins.str description: (string) - Description of the federation policy
     :param Union['GetServicePrincipalFederationPolicyOidcPolicyArgs', 'GetServicePrincipalFederationPolicyOidcPolicyArgsDict'] oidc_policy: (OidcFederationPolicy)

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/pulumi-plugin.json

@@ -1,5 +1,5 @@
 {
   "resource": true,
   "name": "databricks",
-  "version": "1.77.0-alpha.1760247900"
+  "version": "1.77.0-alpha.1760375482"
 }

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks/service_principal_federation_policy.py

@@ -246,6 +246,8 @@ class ServicePrincipalFederationPolicy(pulumi.CustomResource):
         * The identity provider (or issuer) from which the service principal can authenticate.
         * The workload identity (or subject) that is permitted to authenticate as the Databricks service principal.
 
+        ## Example Usage
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.
@@ -285,6 +287,8 @@ class ServicePrincipalFederationPolicy(pulumi.CustomResource):
         * The identity provider (or issuer) from which the service principal can authenticate.
         * The workload identity (or subject) that is permitted to authenticate as the Databricks service principal.
 
+        ## Example Usage
+
         ## Import
 
         As of Pulumi v1.5, resources can be imported through configuration.

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pulumi_databricks.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pulumi_databricks
-Version: 1.77.0a1760247900
+Version: 1.77.0a1760375482
 Summary: A Pulumi package for creating and managing databricks cloud resources.
 License: Apache-2.0
 Project-URL: Homepage, https://www.pulumi.com

{pulumi_databricks-1.77.0a1760247900 → pulumi_databricks-1.77.0a1760375482}/pyproject.toml

@@ -5,7 +5,7 @@
   keywords = ["pulumi", "databricks", "category/infrastructure"]
   readme = "README.md"
   requires-python = ">=3.9"
-  version = "1.77.0a1760247900"
+  version = "1.77.0a1760375482"
   [project.license]
     text = "Apache-2.0"
   [project.urls]