pulumi-azure-native 2.55.0a1723193023__py3-none-any.whl → 2.56.0__py3-none-any.whl

pulumi_azure_native/cdn/v20240601preview/get_origin_group.py

@@ -0,0 +1,211 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetOriginGroupResult',
+    'AwaitableGetOriginGroupResult',
+    'get_origin_group',
+    'get_origin_group_output',
+]
+
+@pulumi.output_type
+class GetOriginGroupResult:
+    """
+    Origin group comprising of origins is used for load balancing to origins when the content cannot be served from CDN.
+    """
+    def __init__(__self__, health_probe_settings=None, id=None, name=None, origins=None, provisioning_state=None, resource_state=None, response_based_origin_error_detection_settings=None, system_data=None, traffic_restoration_time_to_healed_or_new_endpoints_in_minutes=None, type=None):
+        if health_probe_settings and not isinstance(health_probe_settings, dict):
+            raise TypeError("Expected argument 'health_probe_settings' to be a dict")
+        pulumi.set(__self__, "health_probe_settings", health_probe_settings)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if origins and not isinstance(origins, list):
+            raise TypeError("Expected argument 'origins' to be a list")
+        pulumi.set(__self__, "origins", origins)
+        if provisioning_state and not isinstance(provisioning_state, str):
+            raise TypeError("Expected argument 'provisioning_state' to be a str")
+        pulumi.set(__self__, "provisioning_state", provisioning_state)
+        if resource_state and not isinstance(resource_state, str):
+            raise TypeError("Expected argument 'resource_state' to be a str")
+        pulumi.set(__self__, "resource_state", resource_state)
+        if response_based_origin_error_detection_settings and not isinstance(response_based_origin_error_detection_settings, dict):
+            raise TypeError("Expected argument 'response_based_origin_error_detection_settings' to be a dict")
+        pulumi.set(__self__, "response_based_origin_error_detection_settings", response_based_origin_error_detection_settings)
+        if system_data and not isinstance(system_data, dict):
+            raise TypeError("Expected argument 'system_data' to be a dict")
+        pulumi.set(__self__, "system_data", system_data)
+        if traffic_restoration_time_to_healed_or_new_endpoints_in_minutes and not isinstance(traffic_restoration_time_to_healed_or_new_endpoints_in_minutes, int):
+            raise TypeError("Expected argument 'traffic_restoration_time_to_healed_or_new_endpoints_in_minutes' to be a int")
+        pulumi.set(__self__, "traffic_restoration_time_to_healed_or_new_endpoints_in_minutes", traffic_restoration_time_to_healed_or_new_endpoints_in_minutes)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter(name="healthProbeSettings")
+    def health_probe_settings(self) -> Optional['outputs.HealthProbeParametersResponse']:
+        """
+        Health probe settings to the origin that is used to determine the health of the origin.
+        """
+        return pulumi.get(self, "health_probe_settings")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Resource ID.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        Resource name.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def origins(self) -> Sequence['outputs.ResourceReferenceResponse']:
+        """
+        The source of the content being delivered via CDN within given origin group.
+        """
+        return pulumi.get(self, "origins")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> str:
+        """
+        Provisioning status of the origin group.
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @property
+    @pulumi.getter(name="resourceState")
+    def resource_state(self) -> str:
+        """
+        Resource status of the origin group.
+        """
+        return pulumi.get(self, "resource_state")
+
+    @property
+    @pulumi.getter(name="responseBasedOriginErrorDetectionSettings")
+    def response_based_origin_error_detection_settings(self) -> Optional['outputs.ResponseBasedOriginErrorDetectionParametersResponse']:
+        """
+        The JSON object that contains the properties to determine origin health using real requests/responses. This property is currently not supported.
+        """
+        return pulumi.get(self, "response_based_origin_error_detection_settings")
+
+    @property
+    @pulumi.getter(name="systemData")
+    def system_data(self) -> 'outputs.SystemDataResponse':
+        """
+        Read only system data
+        """
+        return pulumi.get(self, "system_data")
+
+    @property
+    @pulumi.getter(name="trafficRestorationTimeToHealedOrNewEndpointsInMinutes")
+    def traffic_restoration_time_to_healed_or_new_endpoints_in_minutes(self) -> Optional[int]:
+        """
+        Time in minutes to shift the traffic to the endpoint gradually when an unhealthy endpoint comes healthy or a new endpoint is added. Default is 10 mins. This property is currently not supported.
+        """
+        return pulumi.get(self, "traffic_restoration_time_to_healed_or_new_endpoints_in_minutes")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        Resource type.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetOriginGroupResult(GetOriginGroupResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetOriginGroupResult(
+            health_probe_settings=self.health_probe_settings,
+            id=self.id,
+            name=self.name,
+            origins=self.origins,
+            provisioning_state=self.provisioning_state,
+            resource_state=self.resource_state,
+            response_based_origin_error_detection_settings=self.response_based_origin_error_detection_settings,
+            system_data=self.system_data,
+            traffic_restoration_time_to_healed_or_new_endpoints_in_minutes=self.traffic_restoration_time_to_healed_or_new_endpoints_in_minutes,
+            type=self.type)
+
+
+def get_origin_group(endpoint_name: Optional[str] = None,
+                     origin_group_name: Optional[str] = None,
+                     profile_name: Optional[str] = None,
+                     resource_group_name: Optional[str] = None,
+                     opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetOriginGroupResult:
+    """
+    Gets an existing origin group within an endpoint.
+
+
+    :param str endpoint_name: Name of the endpoint under the profile which is unique globally.
+    :param str origin_group_name: Name of the origin group which is unique within the endpoint.
+    :param str profile_name: Name of the CDN profile which is unique within the resource group.
+    :param str resource_group_name: Name of the Resource group within the Azure subscription.
+    """
+    __args__ = dict()
+    __args__['endpointName'] = endpoint_name
+    __args__['originGroupName'] = origin_group_name
+    __args__['profileName'] = profile_name
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:cdn/v20240601preview:getOriginGroup', __args__, opts=opts, typ=GetOriginGroupResult).value
+
+    return AwaitableGetOriginGroupResult(
+        health_probe_settings=pulumi.get(__ret__, 'health_probe_settings'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        origins=pulumi.get(__ret__, 'origins'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        resource_state=pulumi.get(__ret__, 'resource_state'),
+        response_based_origin_error_detection_settings=pulumi.get(__ret__, 'response_based_origin_error_detection_settings'),
+        system_data=pulumi.get(__ret__, 'system_data'),
+        traffic_restoration_time_to_healed_or_new_endpoints_in_minutes=pulumi.get(__ret__, 'traffic_restoration_time_to_healed_or_new_endpoints_in_minutes'),
+        type=pulumi.get(__ret__, 'type'))
+
+
+@_utilities.lift_output_func(get_origin_group)
+def get_origin_group_output(endpoint_name: Optional[pulumi.Input[str]] = None,
+                            origin_group_name: Optional[pulumi.Input[str]] = None,
+                            profile_name: Optional[pulumi.Input[str]] = None,
+                            resource_group_name: Optional[pulumi.Input[str]] = None,
+                            opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetOriginGroupResult]:
+    """
+    Gets an existing origin group within an endpoint.
+
+
+    :param str endpoint_name: Name of the endpoint under the profile which is unique globally.
+    :param str origin_group_name: Name of the origin group which is unique within the endpoint.
+    :param str profile_name: Name of the CDN profile which is unique within the resource group.
+    :param str resource_group_name: Name of the Resource group within the Azure subscription.
+    """
+    ...

pulumi_azure_native/cdn/v20240601preview/get_policy.py

@@ -0,0 +1,276 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import copy
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetPolicyResult',
+    'AwaitableGetPolicyResult',
+    'get_policy',
+    'get_policy_output',
+]
+
+@pulumi.output_type
+class GetPolicyResult:
+    """
+    Defines web application firewall policy for Azure CDN.
+    """
+    def __init__(__self__, custom_rules=None, endpoint_links=None, etag=None, extended_properties=None, id=None, location=None, managed_rules=None, name=None, policy_settings=None, provisioning_state=None, rate_limit_rules=None, resource_state=None, sku=None, system_data=None, tags=None, type=None):
+        if custom_rules and not isinstance(custom_rules, dict):
+            raise TypeError("Expected argument 'custom_rules' to be a dict")
+        pulumi.set(__self__, "custom_rules", custom_rules)
+        if endpoint_links and not isinstance(endpoint_links, list):
+            raise TypeError("Expected argument 'endpoint_links' to be a list")
+        pulumi.set(__self__, "endpoint_links", endpoint_links)
+        if etag and not isinstance(etag, str):
+            raise TypeError("Expected argument 'etag' to be a str")
+        pulumi.set(__self__, "etag", etag)
+        if extended_properties and not isinstance(extended_properties, dict):
+            raise TypeError("Expected argument 'extended_properties' to be a dict")
+        pulumi.set(__self__, "extended_properties", extended_properties)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if location and not isinstance(location, str):
+            raise TypeError("Expected argument 'location' to be a str")
+        pulumi.set(__self__, "location", location)
+        if managed_rules and not isinstance(managed_rules, dict):
+            raise TypeError("Expected argument 'managed_rules' to be a dict")
+        pulumi.set(__self__, "managed_rules", managed_rules)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if policy_settings and not isinstance(policy_settings, dict):
+            raise TypeError("Expected argument 'policy_settings' to be a dict")
+        pulumi.set(__self__, "policy_settings", policy_settings)
+        if provisioning_state and not isinstance(provisioning_state, str):
+            raise TypeError("Expected argument 'provisioning_state' to be a str")
+        pulumi.set(__self__, "provisioning_state", provisioning_state)
+        if rate_limit_rules and not isinstance(rate_limit_rules, dict):
+            raise TypeError("Expected argument 'rate_limit_rules' to be a dict")
+        pulumi.set(__self__, "rate_limit_rules", rate_limit_rules)
+        if resource_state and not isinstance(resource_state, str):
+            raise TypeError("Expected argument 'resource_state' to be a str")
+        pulumi.set(__self__, "resource_state", resource_state)
+        if sku and not isinstance(sku, dict):
+            raise TypeError("Expected argument 'sku' to be a dict")
+        pulumi.set(__self__, "sku", sku)
+        if system_data and not isinstance(system_data, dict):
+            raise TypeError("Expected argument 'system_data' to be a dict")
+        pulumi.set(__self__, "system_data", system_data)
+        if tags and not isinstance(tags, dict):
+            raise TypeError("Expected argument 'tags' to be a dict")
+        pulumi.set(__self__, "tags", tags)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter(name="customRules")
+    def custom_rules(self) -> Optional['outputs.CustomRuleListResponse']:
+        """
+        Describes custom rules inside the policy.
+        """
+        return pulumi.get(self, "custom_rules")
+
+    @property
+    @pulumi.getter(name="endpointLinks")
+    def endpoint_links(self) -> Sequence['outputs.CdnEndpointResponse']:
+        """
+        Describes Azure CDN endpoints associated with this Web Application Firewall policy.
+        """
+        return pulumi.get(self, "endpoint_links")
+
+    @property
+    @pulumi.getter
+    def etag(self) -> Optional[str]:
+        """
+        Gets a unique read-only string that changes whenever the resource is updated.
+        """
+        return pulumi.get(self, "etag")
+
+    @property
+    @pulumi.getter(name="extendedProperties")
+    def extended_properties(self) -> Optional[Mapping[str, str]]:
+        """
+        Key-Value pair representing additional properties for Web Application Firewall policy.
+        """
+        return pulumi.get(self, "extended_properties")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Resource ID.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def location(self) -> str:
+        """
+        Resource location.
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter(name="managedRules")
+    def managed_rules(self) -> Optional['outputs.ManagedRuleSetListResponse']:
+        """
+        Describes managed rules inside the policy.
+        """
+        return pulumi.get(self, "managed_rules")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        Resource name.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="policySettings")
+    def policy_settings(self) -> Optional['outputs.PolicySettingsResponse']:
+        """
+        Describes  policySettings for policy
+        """
+        return pulumi.get(self, "policy_settings")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> str:
+        """
+        Provisioning state of the WebApplicationFirewallPolicy.
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @property
+    @pulumi.getter(name="rateLimitRules")
+    def rate_limit_rules(self) -> Optional['outputs.RateLimitRuleListResponse']:
+        """
+        Describes rate limit rules inside the policy.
+        """
+        return pulumi.get(self, "rate_limit_rules")
+
+    @property
+    @pulumi.getter(name="resourceState")
+    def resource_state(self) -> str:
+        return pulumi.get(self, "resource_state")
+
+    @property
+    @pulumi.getter
+    def sku(self) -> 'outputs.SkuResponse':
+        """
+        The pricing tier (defines a CDN provider, feature list and rate) of the CdnWebApplicationFirewallPolicy.
+        """
+        return pulumi.get(self, "sku")
+
+    @property
+    @pulumi.getter(name="systemData")
+    def system_data(self) -> 'outputs.SystemDataResponse':
+        """
+        Read only system data
+        """
+        return pulumi.get(self, "system_data")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Optional[Mapping[str, str]]:
+        """
+        Resource tags.
+        """
+        return pulumi.get(self, "tags")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        Resource type.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetPolicyResult(GetPolicyResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetPolicyResult(
+            custom_rules=self.custom_rules,
+            endpoint_links=self.endpoint_links,
+            etag=self.etag,
+            extended_properties=self.extended_properties,
+            id=self.id,
+            location=self.location,
+            managed_rules=self.managed_rules,
+            name=self.name,
+            policy_settings=self.policy_settings,
+            provisioning_state=self.provisioning_state,
+            rate_limit_rules=self.rate_limit_rules,
+            resource_state=self.resource_state,
+            sku=self.sku,
+            system_data=self.system_data,
+            tags=self.tags,
+            type=self.type)
+
+
+def get_policy(policy_name: Optional[str] = None,
+               resource_group_name: Optional[str] = None,
+               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetPolicyResult:
+    """
+    Retrieve protection policy with specified name within a resource group.
+
+
+    :param str policy_name: The name of the CdnWebApplicationFirewallPolicy.
+    :param str resource_group_name: Name of the Resource group within the Azure subscription.
+    """
+    __args__ = dict()
+    __args__['policyName'] = policy_name
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:cdn/v20240601preview:getPolicy', __args__, opts=opts, typ=GetPolicyResult).value
+
+    return AwaitableGetPolicyResult(
+        custom_rules=pulumi.get(__ret__, 'custom_rules'),
+        endpoint_links=pulumi.get(__ret__, 'endpoint_links'),
+        etag=pulumi.get(__ret__, 'etag'),
+        extended_properties=pulumi.get(__ret__, 'extended_properties'),
+        id=pulumi.get(__ret__, 'id'),
+        location=pulumi.get(__ret__, 'location'),
+        managed_rules=pulumi.get(__ret__, 'managed_rules'),
+        name=pulumi.get(__ret__, 'name'),
+        policy_settings=pulumi.get(__ret__, 'policy_settings'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        rate_limit_rules=pulumi.get(__ret__, 'rate_limit_rules'),
+        resource_state=pulumi.get(__ret__, 'resource_state'),
+        sku=pulumi.get(__ret__, 'sku'),
+        system_data=pulumi.get(__ret__, 'system_data'),
+        tags=pulumi.get(__ret__, 'tags'),
+        type=pulumi.get(__ret__, 'type'))
+
+
+@_utilities.lift_output_func(get_policy)
+def get_policy_output(policy_name: Optional[pulumi.Input[str]] = None,
+                      resource_group_name: Optional[pulumi.Input[str]] = None,
+                      opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetPolicyResult]:
+    """
+    Retrieve protection policy with specified name within a resource group.
+
+
+    :param str policy_name: The name of the CdnWebApplicationFirewallPolicy.
+    :param str resource_group_name: Name of the Resource group within the Azure subscription.
+    """
+    ...