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

pulumi_azure_native/cdn/v20240601preview/get_afd_custom_domain.py

@@ -0,0 +1,281 @@
+# 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__ = [
+    'GetAFDCustomDomainResult',
+    'AwaitableGetAFDCustomDomainResult',
+    'get_afd_custom_domain',
+    'get_afd_custom_domain_output',
+]
+
+@pulumi.output_type
+class GetAFDCustomDomainResult:
+    """
+    Friendly domain name mapping to the endpoint hostname that the customer provides for branding purposes, e.g. www.contoso.com.
+    """
+    def __init__(__self__, azure_dns_zone=None, deployment_status=None, domain_validation_state=None, extended_properties=None, host_name=None, id=None, mtls_settings=None, name=None, pre_validated_custom_domain_resource_id=None, profile_name=None, provisioning_state=None, referenced_route_paths=None, system_data=None, tls_settings=None, type=None, validation_properties=None):
+        if azure_dns_zone and not isinstance(azure_dns_zone, dict):
+            raise TypeError("Expected argument 'azure_dns_zone' to be a dict")
+        pulumi.set(__self__, "azure_dns_zone", azure_dns_zone)
+        if deployment_status and not isinstance(deployment_status, str):
+            raise TypeError("Expected argument 'deployment_status' to be a str")
+        pulumi.set(__self__, "deployment_status", deployment_status)
+        if domain_validation_state and not isinstance(domain_validation_state, str):
+            raise TypeError("Expected argument 'domain_validation_state' to be a str")
+        pulumi.set(__self__, "domain_validation_state", domain_validation_state)
+        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 host_name and not isinstance(host_name, str):
+            raise TypeError("Expected argument 'host_name' to be a str")
+        pulumi.set(__self__, "host_name", host_name)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if mtls_settings and not isinstance(mtls_settings, dict):
+            raise TypeError("Expected argument 'mtls_settings' to be a dict")
+        pulumi.set(__self__, "mtls_settings", mtls_settings)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if pre_validated_custom_domain_resource_id and not isinstance(pre_validated_custom_domain_resource_id, dict):
+            raise TypeError("Expected argument 'pre_validated_custom_domain_resource_id' to be a dict")
+        pulumi.set(__self__, "pre_validated_custom_domain_resource_id", pre_validated_custom_domain_resource_id)
+        if profile_name and not isinstance(profile_name, str):
+            raise TypeError("Expected argument 'profile_name' to be a str")
+        pulumi.set(__self__, "profile_name", profile_name)
+        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 referenced_route_paths and not isinstance(referenced_route_paths, list):
+            raise TypeError("Expected argument 'referenced_route_paths' to be a list")
+        pulumi.set(__self__, "referenced_route_paths", referenced_route_paths)
+        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 tls_settings and not isinstance(tls_settings, dict):
+            raise TypeError("Expected argument 'tls_settings' to be a dict")
+        pulumi.set(__self__, "tls_settings", tls_settings)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+        if validation_properties and not isinstance(validation_properties, dict):
+            raise TypeError("Expected argument 'validation_properties' to be a dict")
+        pulumi.set(__self__, "validation_properties", validation_properties)
+
+    @property
+    @pulumi.getter(name="azureDnsZone")
+    def azure_dns_zone(self) -> Optional['outputs.ResourceReferenceResponse']:
+        """
+        Resource reference to the Azure DNS zone
+        """
+        return pulumi.get(self, "azure_dns_zone")
+
+    @property
+    @pulumi.getter(name="deploymentStatus")
+    def deployment_status(self) -> str:
+        return pulumi.get(self, "deployment_status")
+
+    @property
+    @pulumi.getter(name="domainValidationState")
+    def domain_validation_state(self) -> str:
+        """
+        Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step. DCV stands for DomainControlValidation.
+        """
+        return pulumi.get(self, "domain_validation_state")
+
+    @property
+    @pulumi.getter(name="extendedProperties")
+    def extended_properties(self) -> Optional[Mapping[str, str]]:
+        """
+        Key-Value pair representing migration properties for domains.
+        """
+        return pulumi.get(self, "extended_properties")
+
+    @property
+    @pulumi.getter(name="hostName")
+    def host_name(self) -> str:
+        """
+        The host name of the domain. Must be a domain name.
+        """
+        return pulumi.get(self, "host_name")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Resource ID.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter(name="mtlsSettings")
+    def mtls_settings(self) -> Optional['outputs.AFDDomainMtlsParametersResponse']:
+        """
+        The configuration specifying how to enable mutual TLS for the domain, including specifying allowed FQDN and which server certificate(s) to use.
+        """
+        return pulumi.get(self, "mtls_settings")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        Resource name.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="preValidatedCustomDomainResourceId")
+    def pre_validated_custom_domain_resource_id(self) -> Optional['outputs.ResourceReferenceResponse']:
+        """
+        Resource reference to the Azure resource where custom domain ownership was prevalidated
+        """
+        return pulumi.get(self, "pre_validated_custom_domain_resource_id")
+
+    @property
+    @pulumi.getter(name="profileName")
+    def profile_name(self) -> str:
+        """
+        The name of the profile which holds the domain.
+        """
+        return pulumi.get(self, "profile_name")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> str:
+        """
+        Provisioning status
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @property
+    @pulumi.getter(name="referencedRoutePaths")
+    def referenced_route_paths(self) -> Sequence['outputs.AFDDomainReferencedRoutePathResponse']:
+        """
+        The JSON object list that contains the overall picture of how routes are used for the shared custom domain across different profiles.
+        """
+        return pulumi.get(self, "referenced_route_paths")
+
+    @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="tlsSettings")
+    def tls_settings(self) -> Optional['outputs.AFDDomainHttpsParametersResponse']:
+        """
+        The configuration specifying how to enable HTTPS for the domain - using AzureFrontDoor managed certificate or user's own certificate. If not specified, enabling ssl uses AzureFrontDoor managed certificate by default.
+        """
+        return pulumi.get(self, "tls_settings")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        Resource type.
+        """
+        return pulumi.get(self, "type")
+
+    @property
+    @pulumi.getter(name="validationProperties")
+    def validation_properties(self) -> 'outputs.DomainValidationPropertiesResponse':
+        """
+        Values the customer needs to validate domain ownership
+        """
+        return pulumi.get(self, "validation_properties")
+
+
+class AwaitableGetAFDCustomDomainResult(GetAFDCustomDomainResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetAFDCustomDomainResult(
+            azure_dns_zone=self.azure_dns_zone,
+            deployment_status=self.deployment_status,
+            domain_validation_state=self.domain_validation_state,
+            extended_properties=self.extended_properties,
+            host_name=self.host_name,
+            id=self.id,
+            mtls_settings=self.mtls_settings,
+            name=self.name,
+            pre_validated_custom_domain_resource_id=self.pre_validated_custom_domain_resource_id,
+            profile_name=self.profile_name,
+            provisioning_state=self.provisioning_state,
+            referenced_route_paths=self.referenced_route_paths,
+            system_data=self.system_data,
+            tls_settings=self.tls_settings,
+            type=self.type,
+            validation_properties=self.validation_properties)
+
+
+def get_afd_custom_domain(custom_domain_name: Optional[str] = None,
+                          profile_name: Optional[str] = None,
+                          resource_group_name: Optional[str] = None,
+                          opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAFDCustomDomainResult:
+    """
+    Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
+
+
+    :param str custom_domain_name: Name of the domain under the profile which is unique globally.
+    :param str profile_name: Name of the Azure Front Door Standard or Azure Front Door Premium 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__['customDomainName'] = custom_domain_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:getAFDCustomDomain', __args__, opts=opts, typ=GetAFDCustomDomainResult).value
+
+    return AwaitableGetAFDCustomDomainResult(
+        azure_dns_zone=pulumi.get(__ret__, 'azure_dns_zone'),
+        deployment_status=pulumi.get(__ret__, 'deployment_status'),
+        domain_validation_state=pulumi.get(__ret__, 'domain_validation_state'),
+        extended_properties=pulumi.get(__ret__, 'extended_properties'),
+        host_name=pulumi.get(__ret__, 'host_name'),
+        id=pulumi.get(__ret__, 'id'),
+        mtls_settings=pulumi.get(__ret__, 'mtls_settings'),
+        name=pulumi.get(__ret__, 'name'),
+        pre_validated_custom_domain_resource_id=pulumi.get(__ret__, 'pre_validated_custom_domain_resource_id'),
+        profile_name=pulumi.get(__ret__, 'profile_name'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        referenced_route_paths=pulumi.get(__ret__, 'referenced_route_paths'),
+        system_data=pulumi.get(__ret__, 'system_data'),
+        tls_settings=pulumi.get(__ret__, 'tls_settings'),
+        type=pulumi.get(__ret__, 'type'),
+        validation_properties=pulumi.get(__ret__, 'validation_properties'))
+
+
+@_utilities.lift_output_func(get_afd_custom_domain)
+def get_afd_custom_domain_output(custom_domain_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[GetAFDCustomDomainResult]:
+    """
+    Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.
+
+
+    :param str custom_domain_name: Name of the domain under the profile which is unique globally.
+    :param str profile_name: Name of the Azure Front Door Standard or Azure Front Door Premium 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_afd_endpoint.py

@@ -0,0 +1,229 @@
+# 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__ = [
+    'GetAFDEndpointResult',
+    'AwaitableGetAFDEndpointResult',
+    'get_afd_endpoint',
+    'get_afd_endpoint_output',
+]
+
+@pulumi.output_type
+class GetAFDEndpointResult:
+    """
+    Azure Front Door endpoint is the entity within a Azure Front Door profile containing configuration information such as origin, protocol, content caching and delivery behavior. The AzureFrontDoor endpoint uses the URL format <endpointname>.azureedge.net.
+    """
+    def __init__(__self__, auto_generated_domain_name_label_scope=None, deployment_status=None, enabled_state=None, host_name=None, id=None, location=None, name=None, profile_name=None, provisioning_state=None, system_data=None, tags=None, type=None):
+        if auto_generated_domain_name_label_scope and not isinstance(auto_generated_domain_name_label_scope, str):
+            raise TypeError("Expected argument 'auto_generated_domain_name_label_scope' to be a str")
+        pulumi.set(__self__, "auto_generated_domain_name_label_scope", auto_generated_domain_name_label_scope)
+        if deployment_status and not isinstance(deployment_status, str):
+            raise TypeError("Expected argument 'deployment_status' to be a str")
+        pulumi.set(__self__, "deployment_status", deployment_status)
+        if enabled_state and not isinstance(enabled_state, str):
+            raise TypeError("Expected argument 'enabled_state' to be a str")
+        pulumi.set(__self__, "enabled_state", enabled_state)
+        if host_name and not isinstance(host_name, str):
+            raise TypeError("Expected argument 'host_name' to be a str")
+        pulumi.set(__self__, "host_name", host_name)
+        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 name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if profile_name and not isinstance(profile_name, str):
+            raise TypeError("Expected argument 'profile_name' to be a str")
+        pulumi.set(__self__, "profile_name", profile_name)
+        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 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="autoGeneratedDomainNameLabelScope")
+    def auto_generated_domain_name_label_scope(self) -> Optional[str]:
+        """
+        Indicates the endpoint name reuse scope. The default value is TenantReuse.
+        """
+        return pulumi.get(self, "auto_generated_domain_name_label_scope")
+
+    @property
+    @pulumi.getter(name="deploymentStatus")
+    def deployment_status(self) -> str:
+        return pulumi.get(self, "deployment_status")
+
+    @property
+    @pulumi.getter(name="enabledState")
+    def enabled_state(self) -> Optional[str]:
+        """
+        Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'
+        """
+        return pulumi.get(self, "enabled_state")
+
+    @property
+    @pulumi.getter(name="hostName")
+    def host_name(self) -> str:
+        """
+        The host name of the endpoint structured as {endpointName}.{DNSZone}, e.g. contoso.azureedge.net
+        """
+        return pulumi.get(self, "host_name")
+
+    @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
+    def name(self) -> str:
+        """
+        Resource name.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="profileName")
+    def profile_name(self) -> str:
+        """
+        The name of the profile which holds the endpoint.
+        """
+        return pulumi.get(self, "profile_name")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> str:
+        """
+        Provisioning status
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @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 AwaitableGetAFDEndpointResult(GetAFDEndpointResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetAFDEndpointResult(
+            auto_generated_domain_name_label_scope=self.auto_generated_domain_name_label_scope,
+            deployment_status=self.deployment_status,
+            enabled_state=self.enabled_state,
+            host_name=self.host_name,
+            id=self.id,
+            location=self.location,
+            name=self.name,
+            profile_name=self.profile_name,
+            provisioning_state=self.provisioning_state,
+            system_data=self.system_data,
+            tags=self.tags,
+            type=self.type)
+
+
+def get_afd_endpoint(endpoint_name: Optional[str] = None,
+                     profile_name: Optional[str] = None,
+                     resource_group_name: Optional[str] = None,
+                     opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetAFDEndpointResult:
+    """
+    Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
+
+
+    :param str endpoint_name: Name of the endpoint under the profile which is unique globally.
+    :param str profile_name: Name of the Azure Front Door Standard or Azure Front Door Premium 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__['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:getAFDEndpoint', __args__, opts=opts, typ=GetAFDEndpointResult).value
+
+    return AwaitableGetAFDEndpointResult(
+        auto_generated_domain_name_label_scope=pulumi.get(__ret__, 'auto_generated_domain_name_label_scope'),
+        deployment_status=pulumi.get(__ret__, 'deployment_status'),
+        enabled_state=pulumi.get(__ret__, 'enabled_state'),
+        host_name=pulumi.get(__ret__, 'host_name'),
+        id=pulumi.get(__ret__, 'id'),
+        location=pulumi.get(__ret__, 'location'),
+        name=pulumi.get(__ret__, 'name'),
+        profile_name=pulumi.get(__ret__, 'profile_name'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        system_data=pulumi.get(__ret__, 'system_data'),
+        tags=pulumi.get(__ret__, 'tags'),
+        type=pulumi.get(__ret__, 'type'))
+
+
+@_utilities.lift_output_func(get_afd_endpoint)
+def get_afd_endpoint_output(endpoint_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[GetAFDEndpointResult]:
+    """
+    Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.
+
+
+    :param str endpoint_name: Name of the endpoint under the profile which is unique globally.
+    :param str profile_name: Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group.
+    :param str resource_group_name: Name of the Resource group within the Azure subscription.
+    """
+    ...