pulumi-azure 6.29.0a1760682612__py3-none-any.whl → 6.29.0a1761200654__py3-none-any.whl

pulumi_azure/privatedns/link_service.py

@@ -431,6 +431,15 @@ class LinkService(pulumi.CustomResource):
 
         > **Note:** Private Link is now in [GA](https://docs.microsoft.com/en-gb/azure/private-link/).
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Network` - 2024-05-01
+
         ## Import
 
         Private Link Services can be imported using the `resource id`, e.g.
@@ -466,6 +475,15 @@ class LinkService(pulumi.CustomResource):
 
         > **Note:** Private Link is now in [GA](https://docs.microsoft.com/en-gb/azure/private-link/).
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Network` - 2024-05-01
+
         ## Import
 
         Private Link Services can be imported using the `resource id`, e.g.

pulumi_azure/privatelink/application_security_group_association.py

@@ -106,6 +106,15 @@ class ApplicationSecurityGroupAssociation(pulumi.CustomResource):
         """
         Manages an association between Private Endpoint and Application Security Group.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Network` - 2024-05-01
+
         ## Import
 
         Associations between Private Endpoint and Application Security Group can be imported using the `resource id`, e.g.
@@ -128,6 +137,15 @@ class ApplicationSecurityGroupAssociation(pulumi.CustomResource):
         """
         Manages an association between Private Endpoint and Application Security Group.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Network` - 2024-05-01
+
         ## Import
 
         Associations between Private Endpoint and Application Security Group can be imported using the `resource id`, e.g.

pulumi_azure/privatelink/endpoint.py

@@ -388,6 +388,100 @@ class Endpoint(pulumi.CustomResource):
 
         Azure Private Endpoint is a network interface that connects you privately and securely to a service powered by Azure Private Link. Private Endpoint uses a private IP address from your VNet, effectively bringing the service into your VNet. The service could be an Azure service such as Azure Storage, SQL, etc. or your own Private Link Service.
 
+        ## Example Usage
+
+        Using a Private Link Service Alias with existing resources:
+
+        ```python
+        import pulumi
+        import pulumi_azure as azure
+
+        example = azure.core.get_resource_group(name="example-resources")
+        vnet = azure.network.get_virtual_network(name="example-network",
+            resource_group_name=example.name)
+        subnet = azure.network.get_subnet(name="default",
+            virtual_network_name=vnet.name,
+            resource_group_name=example.name)
+        example_endpoint = azure.privatelink.Endpoint("example",
+            name="example-endpoint",
+            location=example.location,
+            resource_group_name=example.name,
+            subnet_id=subnet.id,
+            private_service_connection={
+                "name": "example-privateserviceconnection",
+                "private_connection_resource_alias": "example-privatelinkservice.d20286c8-4ea5-11eb-9584-8f53157226c6.centralus.azure.privatelinkservice",
+                "is_manual_connection": True,
+                "request_message": "PL",
+            })
+        ```
+
+        Using a Private Endpoint pointing to an *owned* Azure service, with proper DNS configuration:
+
+        ```python
+        import pulumi
+        import pulumi_azure as azure
+
+        example = azure.core.ResourceGroup("example",
+            name="example-rg",
+            location="West Europe")
+        example_account = azure.storage.Account("example",
+            name="exampleaccount",
+            resource_group_name=example.name,
+            location=example.location,
+            account_tier="Standard",
+            account_replication_type="LRS")
+        example_virtual_network = azure.network.VirtualNetwork("example",
+            name="virtnetname",
+            address_spaces=["10.0.0.0/16"],
+            location=example.location,
+            resource_group_name=example.name)
+        example_subnet = azure.network.Subnet("example",
+            name="subnetname",
+            resource_group_name=example.name,
+            virtual_network_name=example_virtual_network.name,
+            address_prefixes=["10.0.2.0/24"])
+        example_zone = azure.privatedns.Zone("example",
+            name="privatelink.blob.core.windows.net",
+            resource_group_name=example.name)
+        example_endpoint = azure.privatelink.Endpoint("example",
+            name="example-endpoint",
+            location=example.location,
+            resource_group_name=example.name,
+            subnet_id=example_subnet.id,
+            private_service_connection={
+                "name": "example-privateserviceconnection",
+                "private_connection_resource_id": example_account.id,
+                "subresource_names": ["blob"],
+                "is_manual_connection": False,
+            },
+            private_dns_zone_group={
+                "name": "example-dns-zone-group",
+                "private_dns_zone_ids": [example_zone.id],
+            })
+        example_zone_virtual_network_link = azure.privatedns.ZoneVirtualNetworkLink("example",
+            name="example-link",
+            resource_group_name=example.name,
+            private_dns_zone_name=example_zone.name,
+            virtual_network_id=example_virtual_network.id)
+        ```
+
+        ## Example HCL Configurations
+
+        * How to conneca `Private Endpoint` to a Application Gateway
+        * How to connect a `Private Endpoint` to a Cosmos MongoDB
+        * How to connect a `Private Endpoint` to a Cosmos PostgreSQL
+        * How to connect a `Private Endpoint` to a PostgreSQL Server
+        * How to connect a `Private Endpoint` to a Private Link Service
+        * How to connect a `Private Endpoint` to a Private DNS Group
+        * How to connect a `Private Endpoint` to a Databricks Workspace
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Network` - 2024-05-01
+
         ## Import
 
         Private Endpoints can be imported using the `resource id`, e.g.
@@ -419,6 +513,100 @@ class Endpoint(pulumi.CustomResource):
 
         Azure Private Endpoint is a network interface that connects you privately and securely to a service powered by Azure Private Link. Private Endpoint uses a private IP address from your VNet, effectively bringing the service into your VNet. The service could be an Azure service such as Azure Storage, SQL, etc. or your own Private Link Service.
 
+        ## Example Usage
+
+        Using a Private Link Service Alias with existing resources:
+
+        ```python
+        import pulumi
+        import pulumi_azure as azure
+
+        example = azure.core.get_resource_group(name="example-resources")
+        vnet = azure.network.get_virtual_network(name="example-network",
+            resource_group_name=example.name)
+        subnet = azure.network.get_subnet(name="default",
+            virtual_network_name=vnet.name,
+            resource_group_name=example.name)
+        example_endpoint = azure.privatelink.Endpoint("example",
+            name="example-endpoint",
+            location=example.location,
+            resource_group_name=example.name,
+            subnet_id=subnet.id,
+            private_service_connection={
+                "name": "example-privateserviceconnection",
+                "private_connection_resource_alias": "example-privatelinkservice.d20286c8-4ea5-11eb-9584-8f53157226c6.centralus.azure.privatelinkservice",
+                "is_manual_connection": True,
+                "request_message": "PL",
+            })
+        ```
+
+        Using a Private Endpoint pointing to an *owned* Azure service, with proper DNS configuration:
+
+        ```python
+        import pulumi
+        import pulumi_azure as azure
+
+        example = azure.core.ResourceGroup("example",
+            name="example-rg",
+            location="West Europe")
+        example_account = azure.storage.Account("example",
+            name="exampleaccount",
+            resource_group_name=example.name,
+            location=example.location,
+            account_tier="Standard",
+            account_replication_type="LRS")
+        example_virtual_network = azure.network.VirtualNetwork("example",
+            name="virtnetname",
+            address_spaces=["10.0.0.0/16"],
+            location=example.location,
+            resource_group_name=example.name)
+        example_subnet = azure.network.Subnet("example",
+            name="subnetname",
+            resource_group_name=example.name,
+            virtual_network_name=example_virtual_network.name,
+            address_prefixes=["10.0.2.0/24"])
+        example_zone = azure.privatedns.Zone("example",
+            name="privatelink.blob.core.windows.net",
+            resource_group_name=example.name)
+        example_endpoint = azure.privatelink.Endpoint("example",
+            name="example-endpoint",
+            location=example.location,
+            resource_group_name=example.name,
+            subnet_id=example_subnet.id,
+            private_service_connection={
+                "name": "example-privateserviceconnection",
+                "private_connection_resource_id": example_account.id,
+                "subresource_names": ["blob"],
+                "is_manual_connection": False,
+            },
+            private_dns_zone_group={
+                "name": "example-dns-zone-group",
+                "private_dns_zone_ids": [example_zone.id],
+            })
+        example_zone_virtual_network_link = azure.privatedns.ZoneVirtualNetworkLink("example",
+            name="example-link",
+            resource_group_name=example.name,
+            private_dns_zone_name=example_zone.name,
+            virtual_network_id=example_virtual_network.id)
+        ```
+
+        ## Example HCL Configurations
+
+        * How to conneca `Private Endpoint` to a Application Gateway
+        * How to connect a `Private Endpoint` to a Cosmos MongoDB
+        * How to connect a `Private Endpoint` to a Cosmos PostgreSQL
+        * How to connect a `Private Endpoint` to a PostgreSQL Server
+        * How to connect a `Private Endpoint` to a Private Link Service
+        * How to connect a `Private Endpoint` to a Private DNS Group
+        * How to connect a `Private Endpoint` to a Databricks Workspace
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Network` - 2024-05-01
+
         ## Import
 
         Private Endpoints can be imported using the `resource id`, e.g.

pulumi_azure/pulumi-plugin.json

@@ -1,5 +1,5 @@
 {
   "resource": true,
   "name": "azure",
-  "version": "6.29.0-alpha.1760682612"
+  "version": "6.29.0-alpha.1761200654"
 }

pulumi_azure/qumulo/file_system.py

@@ -432,6 +432,15 @@ class FileSystem(pulumi.CustomResource):
         """
         Manages an Azure Native Qumulo Scalable File System.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Qumulo.Storage` - 2024-06-19
+
         ## Import
 
         An existing File System can be imported into Pulumi using the `resource id`, e.g.
@@ -464,6 +473,15 @@ class FileSystem(pulumi.CustomResource):
         """
         Manages an Azure Native Qumulo Scalable File System.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Qumulo.Storage` - 2024-06-19
+
         ## Import
 
         An existing File System can be imported into Pulumi using the `resource id`, e.g.

pulumi_azure/redis/cache_access_policy.py

@@ -139,6 +139,15 @@ class CacheAccessPolicy(pulumi.CustomResource):
         """
         Manages a Redis Cache Access Policy
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Cache` - 2024-11-01
+
         ## Import
 
         Redis Cache Access Policy can be imported using the `resource id`, e.g.
@@ -162,6 +171,15 @@ class CacheAccessPolicy(pulumi.CustomResource):
         """
         Manages a Redis Cache Access Policy
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Cache` - 2024-11-01
+
         ## Import
 
         Redis Cache Access Policy can be imported using the `resource id`, e.g.

pulumi_azure/redis/cache_access_policy_assignment.py

@@ -203,6 +203,15 @@ class CacheAccessPolicyAssignment(pulumi.CustomResource):
         """
         Manages a Redis Cache Access Policy Assignment
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Cache` - 2024-11-01
+
         ## Import
 
         Redis Cache Policy Assignment can be imported using the `resource id`, e.g.
@@ -228,6 +237,15 @@ class CacheAccessPolicyAssignment(pulumi.CustomResource):
         """
         Manages a Redis Cache Access Policy Assignment
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Cache` - 2024-11-01
+
         ## Import
 
         Redis Cache Policy Assignment can be imported using the `resource id`, e.g.

pulumi_azure/redis/firewall_rule.py

@@ -203,6 +203,15 @@ class FirewallRule(pulumi.CustomResource):
         """
         Manages a Firewall Rule associated with a Redis Cache.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Cache` - 2024-11-01
+
         ## Import
 
         Redis Firewall Rules can be imported using the `resource id`, e.g.
@@ -228,6 +237,15 @@ class FirewallRule(pulumi.CustomResource):
         """
         Manages a Firewall Rule associated with a Redis Cache.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Cache` - 2024-11-01
+
         ## Import
 
         Redis Firewall Rules can be imported using the `resource id`, e.g.

pulumi_azure/redis/get_enterprise_database.py

@@ -127,6 +127,15 @@ def get_enterprise_database(cluster_id: Optional[_builtins.str] = None,
     """
     Use this data source to access information about an existing Redis Enterprise Database
 
+    ## Example Usage
+
+    ## API Providers
+
+    <!-- This section is generated, changes will be overwritten -->
+    This data source uses the following Azure API Providers:
+
+    * `Microsoft.Cache` - 2024-10-01
+
 
     :param _builtins.str cluster_id: The resource ID of Redis Enterprise Cluster which hosts the Redis Enterprise Database instance.
     :param _builtins.str name: The name of the Redis Enterprise Database.
@@ -151,6 +160,15 @@ def get_enterprise_database_output(cluster_id: Optional[pulumi.Input[_builtins.s
     """
     Use this data source to access information about an existing Redis Enterprise Database
 
+    ## Example Usage
+
+    ## API Providers
+
+    <!-- This section is generated, changes will be overwritten -->
+    This data source uses the following Azure API Providers:
+
+    * `Microsoft.Cache` - 2024-10-01
+
 
     :param _builtins.str cluster_id: The resource ID of Redis Enterprise Cluster which hosts the Redis Enterprise Database instance.
     :param _builtins.str name: The name of the Redis Enterprise Database.

pulumi_azure/redis/linked_server.py

@@ -234,6 +234,15 @@ class LinkedServer(pulumi.CustomResource):
         """
         Manages a Redis Linked Server (ie Geo Location)
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Cache` - 2024-11-01
+
         ## Import
 
         Redis can be imported using the `resource id`, e.g.
@@ -259,6 +268,15 @@ class LinkedServer(pulumi.CustomResource):
         """
         Manages a Redis Linked Server (ie Geo Location)
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Cache` - 2024-11-01
+
         ## Import
 
         Redis can be imported using the `resource id`, e.g.

pulumi_azure/servicebus/queue_authorization_rule.py

@@ -310,6 +310,15 @@ class QueueAuthorizationRule(pulumi.CustomResource):
         """
         Manages an Authorization Rule for a ServiceBus Queue.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceBus` - 2024-01-01
+
         ## Import
 
         ServiceBus Queue Authorization Rules can be imported using the `resource id`, e.g.
@@ -337,6 +346,15 @@ class QueueAuthorizationRule(pulumi.CustomResource):
         """
         Manages an Authorization Rule for a ServiceBus Queue.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceBus` - 2024-01-01
+
         ## Import
 
         ServiceBus Queue Authorization Rules can be imported using the `resource id`, e.g.

pulumi_azure/servicebus/subscription_rule.py

@@ -254,6 +254,17 @@ class SubscriptionRule(pulumi.CustomResource):
 
         ## Example Usage
 
+        ### SQL Filter)
+
+        ### Correlation Filter)
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceBus` - 2024-01-01
+
         ## Import
 
         Service Bus Subscription Rule can be imported using the `resource id`, e.g.
@@ -282,6 +293,17 @@ class SubscriptionRule(pulumi.CustomResource):
 
         ## Example Usage
 
+        ### SQL Filter)
+
+        ### Correlation Filter)
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceBus` - 2024-01-01
+
         ## Import
 
         Service Bus Subscription Rule can be imported using the `resource id`, e.g.

pulumi_azure/signalr/service_network_acl.py

@@ -173,6 +173,15 @@ class ServiceNetworkAcl(pulumi.CustomResource):
         """
         Manages the Network ACL for a SignalR service.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.SignalRService` - 2024-03-01
+
         ## Import
 
         Network ACLs for a SignalR service can be imported using the `resource id`, e.g.
@@ -197,6 +206,15 @@ class ServiceNetworkAcl(pulumi.CustomResource):
         """
         Manages the Network ACL for a SignalR service.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.SignalRService` - 2024-03-01
+
         ## Import
 
         Network ACLs for a SignalR service can be imported using the `resource id`, e.g.

pulumi_azure/stack/hci_logical_network.py

@@ -304,6 +304,15 @@ class HciLogicalNetwork(pulumi.CustomResource):
         """
         Manages an Azure Stack HCI Logical Network.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.AzureStackHCI` - 2024-01-01
+
         ## Import
 
         Azure Stack HCI Logical Networks can be imported using the `resource id`, e.g.
@@ -332,6 +341,15 @@ class HciLogicalNetwork(pulumi.CustomResource):
         """
         Manages an Azure Stack HCI Logical Network.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.AzureStackHCI` - 2024-01-01
+
         ## Import
 
         Azure Stack HCI Logical Networks can be imported using the `resource id`, e.g.

pulumi_azure/stack/hci_network_interface.py

@@ -313,6 +313,15 @@ class HciNetworkInterface(pulumi.CustomResource):
         """
         Manages an Azure Stack HCI Network Interface.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.AzureStackHCI` - 2024-01-01
+
         ## Import
 
         Azure Stack HCI Network Interfaces can be imported using the `resource id`, e.g.
@@ -343,6 +352,15 @@ class HciNetworkInterface(pulumi.CustomResource):
         """
         Manages an Azure Stack HCI Network Interface.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.AzureStackHCI` - 2024-01-01
+
         ## Import
 
         Azure Stack HCI Network Interfaces can be imported using the `resource id`, e.g.

pulumi_azure/streamanalytics/output_cosmosdb.py

@@ -302,6 +302,15 @@ class OutputCosmosdb(pulumi.CustomResource):
         """
         Manages a Stream Analytics Output to CosmosDB.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.StreamAnalytics` - 2021-10-01-preview
+
         ## Import
 
         Stream Analytics Outputs for CosmosDB can be imported using the `resource id`, e.g.
@@ -330,6 +339,15 @@ class OutputCosmosdb(pulumi.CustomResource):
         """
         Manages a Stream Analytics Output to CosmosDB.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.StreamAnalytics` - 2021-10-01-preview
+
         ## Import
 
         Stream Analytics Outputs for CosmosDB can be imported using the `resource id`, e.g.