pulumi-azure 6.29.0a1760595961__py3-none-any.whl → 6.29.0a1762410795__py3-none-any.whl

pulumi_azure/apimanagement/api_tag_description.py

@@ -173,6 +173,15 @@ class ApiTagDescription(pulumi.CustomResource):
         """
         Manages an API Tag Description within an API Management Service.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ApiManagement` - 2022-08-01
+
         ## Import
 
         API Management API Schema's can be imported using the `resource id`, e.g.
@@ -197,6 +206,15 @@ class ApiTagDescription(pulumi.CustomResource):
         """
         Manages an API Tag Description within an API Management Service.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ApiManagement` - 2022-08-01
+
         ## Import
 
         API Management API Schema's can be imported using the `resource id`, e.g.

pulumi_azure/apimanagement/redis_cache.py

@@ -238,6 +238,15 @@ class RedisCache(pulumi.CustomResource):
         """
         Manages a API Management Redis Cache.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ApiManagement` - 2022-08-01
+
         ## Import
 
         API Management Redis Caches can be imported using the `resource id`, e.g.
@@ -264,6 +273,15 @@ class RedisCache(pulumi.CustomResource):
         """
         Manages a API Management Redis Cache.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ApiManagement` - 2022-08-01
+
         ## Import
 
         API Management Redis Caches can be imported using the `resource id`, e.g.

pulumi_azure/appplatform/spring_cloud_app_redis_association.py

@@ -206,6 +206,8 @@ class SpringCloudAppRedisAssociation(pulumi.CustomResource):
 
         !> **Note:** Azure Spring Apps is now deprecated and will be retired on 2028-05-31 - as such the `appplatform.SpringCloudAppRedisAssociation` resource is deprecated and will be removed in a future major version of the AzureRM Provider. See https://aka.ms/asaretirement for more information.
 
+        ## Example Usage
+
         ## Import
 
         Spring Cloud Application Redis Association can be imported using the `resource id`, e.g.
@@ -233,6 +235,8 @@ class SpringCloudAppRedisAssociation(pulumi.CustomResource):
 
         !> **Note:** Azure Spring Apps is now deprecated and will be retired on 2028-05-31 - as such the `appplatform.SpringCloudAppRedisAssociation` resource is deprecated and will be removed in a future major version of the AzureRM Provider. See https://aka.ms/asaretirement for more information.
 
+        ## Example Usage
+
         ## Import
 
         Spring Cloud Application Redis Association can be imported using the `resource id`, e.g.

pulumi_azure/appplatform/spring_cloud_connection.py

@@ -250,6 +250,15 @@ class SpringCloudConnection(pulumi.CustomResource):
 
         !> **Note:** Azure Spring Apps is now deprecated and will be retired on 2028-05-31 - as such the `appplatform.SpringCloudConnection` resource is deprecated and will be removed in a future major version of the AzureRM Provider. See https://aka.ms/asaretirement for more information.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceLinker` - 2024-04-01, 2022-05-01
+
         ## Import
 
         Service Connector for spring cloud can be imported using the `resource id`, e.g.
@@ -276,6 +285,15 @@ class SpringCloudConnection(pulumi.CustomResource):
 
         !> **Note:** Azure Spring Apps is now deprecated and will be retired on 2028-05-31 - as such the `appplatform.SpringCloudConnection` resource is deprecated and will be removed in a future major version of the AzureRM Provider. See https://aka.ms/asaretirement for more information.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceLinker` - 2024-04-01, 2022-05-01
+
         ## Import
 
         Service Connector for spring cloud can be imported using the `resource id`, e.g.

pulumi_azure/appservice/app_connection.py

@@ -256,6 +256,15 @@ class AppConnection(pulumi.CustomResource):
         """
         Manages a service connector for function app.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceLinker` - 2024-04-01, 2022-05-01
+
         ## Import
 
         Service Connector for app service can be imported using the `resource id`, e.g.
@@ -282,6 +291,15 @@ class AppConnection(pulumi.CustomResource):
         """
         Manages a service connector for function app.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceLinker` - 2024-04-01, 2022-05-01
+
         ## Import
 
         Service Connector for app service can be imported using the `resource id`, e.g.

pulumi_azure/appservice/connection.py

@@ -256,6 +256,15 @@ class Connection(pulumi.CustomResource):
         """
         Manages a service connector for app service.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceLinker` - 2024-04-01, 2022-05-01
+
         ## Import
 
         Service Connector for app service can be imported using the `resource id`, e.g.
@@ -282,6 +291,15 @@ class Connection(pulumi.CustomResource):
         """
         Manages a service connector for app service.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ServiceLinker` - 2024-04-01, 2022-05-01
+
         ## Import
 
         Service Connector for app service can be imported using the `resource id`, e.g.

pulumi_azure/appservice/function_app.py

@@ -971,6 +971,10 @@ class FunctionApp(pulumi.CustomResource):
 
         > **Note:** Version `~3` or `~4` is required for Linux Function Apps.
 
+        ### Python In A Consumption Plan)
+
+        > **Note:** The Python runtime is only supported on a Linux based hosting plan.  See [the documentation for additional information](https://docs.microsoft.com/azure/azure-functions/functions-reference-python).
+
         ## Import
 
         Function Apps can be imported using the `resource id`, e.g.
@@ -1130,6 +1134,10 @@ class FunctionApp(pulumi.CustomResource):
 
         > **Note:** Version `~3` or `~4` is required for Linux Function Apps.
 
+        ### Python In A Consumption Plan)
+
+        > **Note:** The Python runtime is only supported on a Linux based hosting plan.  See [the documentation for additional information](https://docs.microsoft.com/azure/azure-functions/functions-reference-python).
+
         ## Import
 
         Function Apps can be imported using the `resource id`, e.g.

pulumi_azure/appservice/web_app_active_slot.py

@@ -153,6 +153,15 @@ class WebAppActiveSlot(pulumi.CustomResource):
         example_web_app_active_slot = azure.appservice.WebAppActiveSlot("example", slot_id=example_windows_web_app_slot.id)
         ```
 
+        ### Linux Web App
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Web` - 2023-12-01
+
         ## Import
 
         a Web App Active Slot can be imported using the `resource id`, e.g.
@@ -205,6 +214,15 @@ class WebAppActiveSlot(pulumi.CustomResource):
         example_web_app_active_slot = azure.appservice.WebAppActiveSlot("example", slot_id=example_windows_web_app_slot.id)
         ```
 
+        ### Linux Web App
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.Web` - 2023-12-01
+
         ## Import
 
         a Web App Active Slot can be imported using the `resource id`, e.g.

pulumi_azure/containerapp/custom_domain.py

@@ -205,6 +205,8 @@ class CustomDomain(pulumi.CustomResource):
         """
         Manages a Container App Custom Domain.
 
+        ## Example Usage
+
         ### Managed Certificate
 
         ```python
@@ -254,6 +256,8 @@ class CustomDomain(pulumi.CustomResource):
         """
         Manages a Container App Custom Domain.
 
+        ## Example Usage
+
         ### Managed Certificate
 
         ```python

pulumi_azure/containerservice/get_registry_cache_rule.py

@@ -109,6 +109,15 @@ def get_registry_cache_rule(container_registry_id: Optional[_builtins.str] = Non
     """
     Use this data source to access information about an existing Container Registry Cache Rule.
 
+    ## Example Usage
+
+    ## API Providers
+
+    <!-- This section is generated, changes will be overwritten -->
+    This data source uses the following Azure API Providers:
+
+    * `Microsoft.ContainerRegistry` - 2023-07-01
+
 
     :param _builtins.str container_registry_id: The ID of the container registry where the cache rule should apply. Changing this forces a new resource to be created.
     :param _builtins.str name: Specifies the name of the Container Registry Cache Rule. Only Alphanumeric characters allowed. Changing this forces a new resource to be created.
@@ -132,6 +141,15 @@ def get_registry_cache_rule_output(container_registry_id: Optional[pulumi.Input[
     """
     Use this data source to access information about an existing Container Registry Cache Rule.
 
+    ## Example Usage
+
+    ## API Providers
+
+    <!-- This section is generated, changes will be overwritten -->
+    This data source uses the following Azure API Providers:
+
+    * `Microsoft.ContainerRegistry` - 2023-07-01
+
 
     :param _builtins.str container_registry_id: The ID of the container registry where the cache rule should apply. Changing this forces a new resource to be created.
     :param _builtins.str name: Specifies the name of the Container Registry Cache Rule. Only Alphanumeric characters allowed. Changing this forces a new resource to be created.

pulumi_azure/containerservice/token_password.py

@@ -141,6 +141,15 @@ class TokenPassword(pulumi.CustomResource):
         """
         Manages a Container Registry Token Password associated with a scope map.  For more information on scope maps and their tokens see the [product documentation](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-repository-scoped-permissions).
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ContainerRegistry` - 2023-11-01-preview
+
         ## Import
 
         Container Registry Token Passwords can be imported using the `resource id`, e.g.
@@ -164,6 +173,15 @@ class TokenPassword(pulumi.CustomResource):
         """
         Manages a Container Registry Token Password associated with a scope map.  For more information on scope maps and their tokens see the [product documentation](https://learn.microsoft.com/en-us/azure/container-registry/container-registry-repository-scoped-permissions).
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.ContainerRegistry` - 2023-11-01-preview
+
         ## Import
 
         Container Registry Token Passwords can be imported using the `resource id`, e.g.

pulumi_azure/cosmosdb/sql_function.py

@@ -139,6 +139,8 @@ class SqlFunction(pulumi.CustomResource):
         """
         Manages an SQL User Defined Function.
 
+        ## Example Usage
+
         ## Import
 
         SQL User Defined Functions can be imported using the `resource id`, e.g.
@@ -162,6 +164,8 @@ class SqlFunction(pulumi.CustomResource):
         """
         Manages an SQL User Defined Function.
 
+        ## Example Usage
+
         ## Import
 
         SQL User Defined Functions can be imported using the `resource id`, e.g.

pulumi_azure/cosmosdb/sql_stored_procedure.py

@@ -235,6 +235,8 @@ class SqlStoredProcedure(pulumi.CustomResource):
         """
         Manages a SQL Stored Procedure within a Cosmos DB Account SQL Database.
 
+        ## Example Usage
+
         ## Import
 
         CosmosDB SQL Stored Procedures can be imported using the `resource id`, e.g.
@@ -261,6 +263,8 @@ class SqlStoredProcedure(pulumi.CustomResource):
         """
         Manages a SQL Stored Procedure within a Cosmos DB Account SQL Database.
 
+        ## Example Usage
+
         ## Import
 
         CosmosDB SQL Stored Procedures can be imported using the `resource id`, e.g.

pulumi_azure/cosmosdb/sql_trigger.py

@@ -203,6 +203,8 @@ class SqlTrigger(pulumi.CustomResource):
         """
         Manages an SQL Trigger.
 
+        ## Example Usage
+
         ## Import
 
         SQL Triggers can be imported using the `resource id`, e.g.
@@ -228,6 +230,8 @@ class SqlTrigger(pulumi.CustomResource):
         """
         Manages an SQL Trigger.
 
+        ## Example Usage
+
         ## Import
 
         SQL Triggers can be imported using the `resource id`, e.g.

pulumi_azure/dataprotection/backup_policy_kubernetes_cluster.py

@@ -271,6 +271,15 @@ class BackupPolicyKubernetesCluster(pulumi.CustomResource):
         """
         Manages a Backup Policy to back up Kubernetes Cluster.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.DataProtection` - 2024-04-01
+
         ## Import
 
         Backup Policy Kubernetes Cluster's can be imported using the `resource id`, e.g.
@@ -298,6 +307,15 @@ class BackupPolicyKubernetesCluster(pulumi.CustomResource):
         """
         Manages a Backup Policy to back up Kubernetes Cluster.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.DataProtection` - 2024-04-01
+
         ## Import
 
         Backup Policy Kubernetes Cluster's can be imported using the `resource id`, e.g.

pulumi_azure/dynatrace/monitor.py

@@ -369,6 +369,15 @@ class Monitor(pulumi.CustomResource):
         """
         Manages a Dynatrace monitor.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Dynatrace.Observability` - 2023-04-27
+
         ## Import
 
         Dynatrace monitor can be imported using the `resource id`, e.g.
@@ -399,6 +408,15 @@ class Monitor(pulumi.CustomResource):
         """
         Manages a Dynatrace monitor.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Dynatrace.Observability` - 2023-04-27
+
         ## Import
 
         Dynatrace monitor can be imported using the `resource id`, e.g.

pulumi_azure/dynatrace/tag_rules.py

@@ -175,6 +175,15 @@ class TagRules(pulumi.CustomResource):
         """
         Manages Dynatrace tag rules.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Dynatrace.Observability` - 2023-04-27
+
         ## Import
 
         Dynatrace tag rules can be imported using the `resource id`, e.g.
@@ -199,6 +208,15 @@ class TagRules(pulumi.CustomResource):
         """
         Manages Dynatrace tag rules.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Dynatrace.Observability` - 2023-04-27
+
         ## Import
 
         Dynatrace tag rules can be imported using the `resource id`, e.g.

pulumi_azure/eventhub/queue_authorization_rule.py

@@ -315,6 +315,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.
@@ -342,6 +351,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/eventhub/subscription_rule.py

@@ -259,6 +259,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.
@@ -287,6 +298,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/iot/endpoint_cosmosdb_account.py

@@ -500,6 +500,8 @@ class EndpointCosmosdbAccount(pulumi.CustomResource):
 
         > **Note:** Endpoints can be defined either directly on the `iot.IoTHub` resource, or using the `azurerm_iothub_endpoint_*` resources - but the two ways of defining the endpoints cannot be used together. If both are used against the same IoTHub, spurious changes will occur. Also, defining a `azurerm_iothub_endpoint_*` resource and another endpoint of a different type directly on the `iot.IoTHub` resource is not supported.
 
+        ## Example Usage
+
         ## Import
 
         IoTHub Cosmos DB Account Endpoint can be imported using the `resource id`, e.g.
@@ -543,6 +545,8 @@ class EndpointCosmosdbAccount(pulumi.CustomResource):
 
         > **Note:** Endpoints can be defined either directly on the `iot.IoTHub` resource, or using the `azurerm_iothub_endpoint_*` resources - but the two ways of defining the endpoints cannot be used together. If both are used against the same IoTHub, spurious changes will occur. Also, defining a `azurerm_iothub_endpoint_*` resource and another endpoint of a different type directly on the `iot.IoTHub` resource is not supported.
 
+        ## Example Usage
+
         ## Import
 
         IoTHub Cosmos DB Account Endpoint can be imported using the `resource id`, e.g.

pulumi_azure/iot/endpoint_servicebus_queue.py

@@ -355,6 +355,8 @@ class EndpointServicebusQueue(pulumi.CustomResource):
 
         > **Note:** Endpoints can be defined either directly on the `iot.IoTHub` resource, or using the `azurerm_iothub_endpoint_*` resources - but the two ways of defining the endpoints cannot be used together. If both are used against the same IoTHub, spurious changes will occur. Also, defining a `azurerm_iothub_endpoint_*` resource and another endpoint of a different type directly on the `iot.IoTHub` resource is not supported.
 
+        ## Example Usage
+
         ## Import
 
         IoTHub ServiceBus Queue Endpoint can be imported using the `resource id`, e.g.
@@ -392,6 +394,8 @@ class EndpointServicebusQueue(pulumi.CustomResource):
 
         > **Note:** Endpoints can be defined either directly on the `iot.IoTHub` resource, or using the `azurerm_iothub_endpoint_*` resources - but the two ways of defining the endpoints cannot be used together. If both are used against the same IoTHub, spurious changes will occur. Also, defining a `azurerm_iothub_endpoint_*` resource and another endpoint of a different type directly on the `iot.IoTHub` resource is not supported.
 
+        ## Example Usage
+
         ## Import
 
         IoTHub ServiceBus Queue Endpoint can be imported using the `resource id`, e.g.

pulumi_azure/keyvault/managed_hardware_security_module_key.py

@@ -362,6 +362,15 @@ class ManagedHardwareSecurityModuleKey(pulumi.CustomResource):
 
         > **Note:** The Azure Provider includes a Feature Toggle which will purge a Key Vault Managed Hardware Security Module Key resource on destroy, rather than the default soft-delete. See `purge_soft_deleted_hardware_security_modules_on_destroy` for more information.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.KeyVault` - 2023-07-01
+
         ## Import
 
         Key Vault Managed Hardware Security Module Key can be imported using the `resource id`, e.g.
@@ -395,6 +404,15 @@ class ManagedHardwareSecurityModuleKey(pulumi.CustomResource):
 
         > **Note:** The Azure Provider includes a Feature Toggle which will purge a Key Vault Managed Hardware Security Module Key resource on destroy, rather than the default soft-delete. See `purge_soft_deleted_hardware_security_modules_on_destroy` for more information.
 
+        ## Example Usage
+
+        ## API Providers
+
+        <!-- This section is generated, changes will be overwritten -->
+        This resource uses the following Azure API Providers:
+
+        * `Microsoft.KeyVault` - 2023-07-01
+
         ## Import
 
         Key Vault Managed Hardware Security Module Key can be imported using the `resource id`, e.g.

pulumi_azure/keyvault/managed_hardware_security_module_role_definition.py

@@ -240,6 +240,8 @@ class ManagedHardwareSecurityModuleRoleDefinition(pulumi.CustomResource):
         """
         Manages a Key Vault Managed Hardware Security Module Role Definition. This resource works together with Managed hardware security module resource.
 
+        ## Example Usage
+
         ## Import
 
         Key Vault Managed Hardware Security Module Role Definitions can be imported using the `resource id`, e.g.
@@ -265,6 +267,8 @@ class ManagedHardwareSecurityModuleRoleDefinition(pulumi.CustomResource):
         """
         Manages a Key Vault Managed Hardware Security Module Role Definition. This resource works together with Managed hardware security module resource.
 
+        ## Example Usage
+
         ## Import
 
         Key Vault Managed Hardware Security Module Role Definitions can be imported using the `resource id`, e.g.