pulumi-azure-native 2.74.0a1732531694__py3-none-any.whl → 2.75.0a1732957898__py3-none-any.whl

pulumi_azure_native/signalrservice/v20241001preview/get_signal_r.py

@@ -0,0 +1,536 @@
+# 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__ = [
+    'GetSignalRResult',
+    'AwaitableGetSignalRResult',
+    'get_signal_r',
+    'get_signal_r_output',
+]
+
+@pulumi.output_type
+class GetSignalRResult:
+    """
+    A class represent a resource.
+    """
+    def __init__(__self__, application_firewall=None, cors=None, disable_aad_auth=None, disable_local_auth=None, external_ip=None, features=None, host_name=None, host_name_prefix=None, id=None, identity=None, kind=None, live_trace_configuration=None, location=None, name=None, network_acls=None, private_endpoint_connections=None, provisioning_state=None, public_network_access=None, public_port=None, region_endpoint_enabled=None, resource_log_configuration=None, resource_stopped=None, server_port=None, serverless=None, shared_private_link_resources=None, sku=None, system_data=None, tags=None, tls=None, type=None, upstream=None, version=None):
+        if application_firewall and not isinstance(application_firewall, dict):
+            raise TypeError("Expected argument 'application_firewall' to be a dict")
+        pulumi.set(__self__, "application_firewall", application_firewall)
+        if cors and not isinstance(cors, dict):
+            raise TypeError("Expected argument 'cors' to be a dict")
+        pulumi.set(__self__, "cors", cors)
+        if disable_aad_auth and not isinstance(disable_aad_auth, bool):
+            raise TypeError("Expected argument 'disable_aad_auth' to be a bool")
+        pulumi.set(__self__, "disable_aad_auth", disable_aad_auth)
+        if disable_local_auth and not isinstance(disable_local_auth, bool):
+            raise TypeError("Expected argument 'disable_local_auth' to be a bool")
+        pulumi.set(__self__, "disable_local_auth", disable_local_auth)
+        if external_ip and not isinstance(external_ip, str):
+            raise TypeError("Expected argument 'external_ip' to be a str")
+        pulumi.set(__self__, "external_ip", external_ip)
+        if features and not isinstance(features, list):
+            raise TypeError("Expected argument 'features' to be a list")
+        pulumi.set(__self__, "features", features)
+        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 host_name_prefix and not isinstance(host_name_prefix, str):
+            raise TypeError("Expected argument 'host_name_prefix' to be a str")
+        pulumi.set(__self__, "host_name_prefix", host_name_prefix)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if identity and not isinstance(identity, dict):
+            raise TypeError("Expected argument 'identity' to be a dict")
+        pulumi.set(__self__, "identity", identity)
+        if kind and not isinstance(kind, str):
+            raise TypeError("Expected argument 'kind' to be a str")
+        pulumi.set(__self__, "kind", kind)
+        if live_trace_configuration and not isinstance(live_trace_configuration, dict):
+            raise TypeError("Expected argument 'live_trace_configuration' to be a dict")
+        pulumi.set(__self__, "live_trace_configuration", live_trace_configuration)
+        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 network_acls and not isinstance(network_acls, dict):
+            raise TypeError("Expected argument 'network_acls' to be a dict")
+        pulumi.set(__self__, "network_acls", network_acls)
+        if private_endpoint_connections and not isinstance(private_endpoint_connections, list):
+            raise TypeError("Expected argument 'private_endpoint_connections' to be a list")
+        pulumi.set(__self__, "private_endpoint_connections", private_endpoint_connections)
+        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 public_network_access and not isinstance(public_network_access, str):
+            raise TypeError("Expected argument 'public_network_access' to be a str")
+        pulumi.set(__self__, "public_network_access", public_network_access)
+        if public_port and not isinstance(public_port, int):
+            raise TypeError("Expected argument 'public_port' to be a int")
+        pulumi.set(__self__, "public_port", public_port)
+        if region_endpoint_enabled and not isinstance(region_endpoint_enabled, str):
+            raise TypeError("Expected argument 'region_endpoint_enabled' to be a str")
+        pulumi.set(__self__, "region_endpoint_enabled", region_endpoint_enabled)
+        if resource_log_configuration and not isinstance(resource_log_configuration, dict):
+            raise TypeError("Expected argument 'resource_log_configuration' to be a dict")
+        pulumi.set(__self__, "resource_log_configuration", resource_log_configuration)
+        if resource_stopped and not isinstance(resource_stopped, str):
+            raise TypeError("Expected argument 'resource_stopped' to be a str")
+        pulumi.set(__self__, "resource_stopped", resource_stopped)
+        if server_port and not isinstance(server_port, int):
+            raise TypeError("Expected argument 'server_port' to be a int")
+        pulumi.set(__self__, "server_port", server_port)
+        if serverless and not isinstance(serverless, dict):
+            raise TypeError("Expected argument 'serverless' to be a dict")
+        pulumi.set(__self__, "serverless", serverless)
+        if shared_private_link_resources and not isinstance(shared_private_link_resources, list):
+            raise TypeError("Expected argument 'shared_private_link_resources' to be a list")
+        pulumi.set(__self__, "shared_private_link_resources", shared_private_link_resources)
+        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 tls and not isinstance(tls, dict):
+            raise TypeError("Expected argument 'tls' to be a dict")
+        pulumi.set(__self__, "tls", tls)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+        if upstream and not isinstance(upstream, dict):
+            raise TypeError("Expected argument 'upstream' to be a dict")
+        pulumi.set(__self__, "upstream", upstream)
+        if version and not isinstance(version, str):
+            raise TypeError("Expected argument 'version' to be a str")
+        pulumi.set(__self__, "version", version)
+
+    @property
+    @pulumi.getter(name="applicationFirewall")
+    def application_firewall(self) -> Optional['outputs.ApplicationFirewallSettingsResponse']:
+        """
+        Application firewall settings for the resource
+        """
+        return pulumi.get(self, "application_firewall")
+
+    @property
+    @pulumi.getter
+    def cors(self) -> Optional['outputs.SignalRCorsSettingsResponse']:
+        """
+        Cross-Origin Resource Sharing (CORS) settings.
+        """
+        return pulumi.get(self, "cors")
+
+    @property
+    @pulumi.getter(name="disableAadAuth")
+    def disable_aad_auth(self) -> Optional[bool]:
+        """
+        DisableLocalAuth
+        Enable or disable aad auth
+        When set as true, connection with AuthType=aad won't work.
+        """
+        return pulumi.get(self, "disable_aad_auth")
+
+    @property
+    @pulumi.getter(name="disableLocalAuth")
+    def disable_local_auth(self) -> Optional[bool]:
+        """
+        DisableLocalAuth
+        Enable or disable local auth with AccessKey
+        When set as true, connection with AccessKey=xxx won't work.
+        """
+        return pulumi.get(self, "disable_local_auth")
+
+    @property
+    @pulumi.getter(name="externalIP")
+    def external_ip(self) -> str:
+        """
+        The publicly accessible IP of the resource.
+        """
+        return pulumi.get(self, "external_ip")
+
+    @property
+    @pulumi.getter
+    def features(self) -> Optional[Sequence['outputs.SignalRFeatureResponse']]:
+        """
+        List of the featureFlags.
+        
+        FeatureFlags that are not included in the parameters for the update operation will not be modified.
+        And the response will only include featureFlags that are explicitly set. 
+        When a featureFlag is not explicitly set, its globally default value will be used
+        But keep in mind, the default value doesn't mean "false". It varies in terms of different FeatureFlags.
+        """
+        return pulumi.get(self, "features")
+
+    @property
+    @pulumi.getter(name="hostName")
+    def host_name(self) -> str:
+        """
+        FQDN of the service instance.
+        """
+        return pulumi.get(self, "host_name")
+
+    @property
+    @pulumi.getter(name="hostNamePrefix")
+    def host_name_prefix(self) -> str:
+        """
+        Deprecated.
+        """
+        return pulumi.get(self, "host_name_prefix")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def identity(self) -> Optional['outputs.ManagedIdentityResponse']:
+        """
+        A class represent managed identities used for request and response
+        """
+        return pulumi.get(self, "identity")
+
+    @property
+    @pulumi.getter
+    def kind(self) -> Optional[str]:
+        """
+        The kind of the service
+        """
+        return pulumi.get(self, "kind")
+
+    @property
+    @pulumi.getter(name="liveTraceConfiguration")
+    def live_trace_configuration(self) -> Optional['outputs.LiveTraceConfigurationResponse']:
+        """
+        Live trace configuration of a Microsoft.SignalRService resource.
+        """
+        return pulumi.get(self, "live_trace_configuration")
+
+    @property
+    @pulumi.getter
+    def location(self) -> str:
+        """
+        The geo-location where the resource lives
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="networkACLs")
+    def network_acls(self) -> Optional['outputs.SignalRNetworkACLsResponse']:
+        """
+        Network ACLs for the resource
+        """
+        return pulumi.get(self, "network_acls")
+
+    @property
+    @pulumi.getter(name="privateEndpointConnections")
+    def private_endpoint_connections(self) -> Sequence['outputs.PrivateEndpointConnectionResponse']:
+        """
+        Private endpoint connections to the resource.
+        """
+        return pulumi.get(self, "private_endpoint_connections")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> str:
+        """
+        Provisioning state of the resource.
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @property
+    @pulumi.getter(name="publicNetworkAccess")
+    def public_network_access(self) -> Optional[str]:
+        """
+        Enable or disable public network access. Default to "Enabled".
+        When it's Enabled, network ACLs still apply.
+        When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
+        """
+        return pulumi.get(self, "public_network_access")
+
+    @property
+    @pulumi.getter(name="publicPort")
+    def public_port(self) -> int:
+        """
+        The publicly accessible port of the resource which is designed for browser/client side usage.
+        """
+        return pulumi.get(self, "public_port")
+
+    @property
+    @pulumi.getter(name="regionEndpointEnabled")
+    def region_endpoint_enabled(self) -> Optional[str]:
+        """
+        Enable or disable the regional endpoint. Default to "Enabled".
+        When it's Disabled, new connections will not be routed to this endpoint, however existing connections will not be affected.
+        This property is replica specific. Disable the regional endpoint without replica is not allowed.
+        """
+        return pulumi.get(self, "region_endpoint_enabled")
+
+    @property
+    @pulumi.getter(name="resourceLogConfiguration")
+    def resource_log_configuration(self) -> Optional['outputs.ResourceLogConfigurationResponse']:
+        """
+        Resource log configuration of a Microsoft.SignalRService resource.
+        """
+        return pulumi.get(self, "resource_log_configuration")
+
+    @property
+    @pulumi.getter(name="resourceStopped")
+    def resource_stopped(self) -> Optional[str]:
+        """
+        Stop or start the resource.  Default to "False".
+        When it's true, the data plane of the resource is shutdown.
+        When it's false, the data plane of the resource is started.
+        """
+        return pulumi.get(self, "resource_stopped")
+
+    @property
+    @pulumi.getter(name="serverPort")
+    def server_port(self) -> int:
+        """
+        The publicly accessible port of the resource which is designed for customer server side usage.
+        """
+        return pulumi.get(self, "server_port")
+
+    @property
+    @pulumi.getter
+    def serverless(self) -> Optional['outputs.ServerlessSettingsResponse']:
+        """
+        Serverless settings.
+        """
+        return pulumi.get(self, "serverless")
+
+    @property
+    @pulumi.getter(name="sharedPrivateLinkResources")
+    def shared_private_link_resources(self) -> Sequence['outputs.SharedPrivateLinkResourceResponse']:
+        """
+        The list of shared private link resources.
+        """
+        return pulumi.get(self, "shared_private_link_resources")
+
+    @property
+    @pulumi.getter
+    def sku(self) -> Optional['outputs.ResourceSkuResponse']:
+        """
+        The billing information of the resource.
+        """
+        return pulumi.get(self, "sku")
+
+    @property
+    @pulumi.getter(name="systemData")
+    def system_data(self) -> 'outputs.SystemDataResponse':
+        """
+        Azure Resource Manager metadata containing createdBy and modifiedBy information.
+        """
+        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 tls(self) -> Optional['outputs.SignalRTlsSettingsResponse']:
+        """
+        TLS settings for the resource
+        """
+        return pulumi.get(self, "tls")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
+        """
+        return pulumi.get(self, "type")
+
+    @property
+    @pulumi.getter
+    def upstream(self) -> Optional['outputs.ServerlessUpstreamSettingsResponse']:
+        """
+        The settings for the Upstream when the service is in server-less mode.
+        """
+        return pulumi.get(self, "upstream")
+
+    @property
+    @pulumi.getter
+    def version(self) -> str:
+        """
+        Version of the resource. Probably you need the same or higher version of client SDKs.
+        """
+        return pulumi.get(self, "version")
+
+
+class AwaitableGetSignalRResult(GetSignalRResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetSignalRResult(
+            application_firewall=self.application_firewall,
+            cors=self.cors,
+            disable_aad_auth=self.disable_aad_auth,
+            disable_local_auth=self.disable_local_auth,
+            external_ip=self.external_ip,
+            features=self.features,
+            host_name=self.host_name,
+            host_name_prefix=self.host_name_prefix,
+            id=self.id,
+            identity=self.identity,
+            kind=self.kind,
+            live_trace_configuration=self.live_trace_configuration,
+            location=self.location,
+            name=self.name,
+            network_acls=self.network_acls,
+            private_endpoint_connections=self.private_endpoint_connections,
+            provisioning_state=self.provisioning_state,
+            public_network_access=self.public_network_access,
+            public_port=self.public_port,
+            region_endpoint_enabled=self.region_endpoint_enabled,
+            resource_log_configuration=self.resource_log_configuration,
+            resource_stopped=self.resource_stopped,
+            server_port=self.server_port,
+            serverless=self.serverless,
+            shared_private_link_resources=self.shared_private_link_resources,
+            sku=self.sku,
+            system_data=self.system_data,
+            tags=self.tags,
+            tls=self.tls,
+            type=self.type,
+            upstream=self.upstream,
+            version=self.version)
+
+
+def get_signal_r(resource_group_name: Optional[str] = None,
+                 resource_name: Optional[str] = None,
+                 opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetSignalRResult:
+    """
+    Get the resource and its properties.
+
+
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str resource_name: The name of the resource.
+    """
+    __args__ = dict()
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['resourceName'] = resource_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:signalrservice/v20241001preview:getSignalR', __args__, opts=opts, typ=GetSignalRResult).value
+
+    return AwaitableGetSignalRResult(
+        application_firewall=pulumi.get(__ret__, 'application_firewall'),
+        cors=pulumi.get(__ret__, 'cors'),
+        disable_aad_auth=pulumi.get(__ret__, 'disable_aad_auth'),
+        disable_local_auth=pulumi.get(__ret__, 'disable_local_auth'),
+        external_ip=pulumi.get(__ret__, 'external_ip'),
+        features=pulumi.get(__ret__, 'features'),
+        host_name=pulumi.get(__ret__, 'host_name'),
+        host_name_prefix=pulumi.get(__ret__, 'host_name_prefix'),
+        id=pulumi.get(__ret__, 'id'),
+        identity=pulumi.get(__ret__, 'identity'),
+        kind=pulumi.get(__ret__, 'kind'),
+        live_trace_configuration=pulumi.get(__ret__, 'live_trace_configuration'),
+        location=pulumi.get(__ret__, 'location'),
+        name=pulumi.get(__ret__, 'name'),
+        network_acls=pulumi.get(__ret__, 'network_acls'),
+        private_endpoint_connections=pulumi.get(__ret__, 'private_endpoint_connections'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        public_network_access=pulumi.get(__ret__, 'public_network_access'),
+        public_port=pulumi.get(__ret__, 'public_port'),
+        region_endpoint_enabled=pulumi.get(__ret__, 'region_endpoint_enabled'),
+        resource_log_configuration=pulumi.get(__ret__, 'resource_log_configuration'),
+        resource_stopped=pulumi.get(__ret__, 'resource_stopped'),
+        server_port=pulumi.get(__ret__, 'server_port'),
+        serverless=pulumi.get(__ret__, 'serverless'),
+        shared_private_link_resources=pulumi.get(__ret__, 'shared_private_link_resources'),
+        sku=pulumi.get(__ret__, 'sku'),
+        system_data=pulumi.get(__ret__, 'system_data'),
+        tags=pulumi.get(__ret__, 'tags'),
+        tls=pulumi.get(__ret__, 'tls'),
+        type=pulumi.get(__ret__, 'type'),
+        upstream=pulumi.get(__ret__, 'upstream'),
+        version=pulumi.get(__ret__, 'version'))
+def get_signal_r_output(resource_group_name: Optional[pulumi.Input[str]] = None,
+                        resource_name: Optional[pulumi.Input[str]] = None,
+                        opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetSignalRResult]:
+    """
+    Get the resource and its properties.
+
+
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    :param str resource_name: The name of the resource.
+    """
+    __args__ = dict()
+    __args__['resourceGroupName'] = resource_group_name
+    __args__['resourceName'] = resource_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('azure-native:signalrservice/v20241001preview:getSignalR', __args__, opts=opts, typ=GetSignalRResult)
+    return __ret__.apply(lambda __response__: GetSignalRResult(
+        application_firewall=pulumi.get(__response__, 'application_firewall'),
+        cors=pulumi.get(__response__, 'cors'),
+        disable_aad_auth=pulumi.get(__response__, 'disable_aad_auth'),
+        disable_local_auth=pulumi.get(__response__, 'disable_local_auth'),
+        external_ip=pulumi.get(__response__, 'external_ip'),
+        features=pulumi.get(__response__, 'features'),
+        host_name=pulumi.get(__response__, 'host_name'),
+        host_name_prefix=pulumi.get(__response__, 'host_name_prefix'),
+        id=pulumi.get(__response__, 'id'),
+        identity=pulumi.get(__response__, 'identity'),
+        kind=pulumi.get(__response__, 'kind'),
+        live_trace_configuration=pulumi.get(__response__, 'live_trace_configuration'),
+        location=pulumi.get(__response__, 'location'),
+        name=pulumi.get(__response__, 'name'),
+        network_acls=pulumi.get(__response__, 'network_acls'),
+        private_endpoint_connections=pulumi.get(__response__, 'private_endpoint_connections'),
+        provisioning_state=pulumi.get(__response__, 'provisioning_state'),
+        public_network_access=pulumi.get(__response__, 'public_network_access'),
+        public_port=pulumi.get(__response__, 'public_port'),
+        region_endpoint_enabled=pulumi.get(__response__, 'region_endpoint_enabled'),
+        resource_log_configuration=pulumi.get(__response__, 'resource_log_configuration'),
+        resource_stopped=pulumi.get(__response__, 'resource_stopped'),
+        server_port=pulumi.get(__response__, 'server_port'),
+        serverless=pulumi.get(__response__, 'serverless'),
+        shared_private_link_resources=pulumi.get(__response__, 'shared_private_link_resources'),
+        sku=pulumi.get(__response__, 'sku'),
+        system_data=pulumi.get(__response__, 'system_data'),
+        tags=pulumi.get(__response__, 'tags'),
+        tls=pulumi.get(__response__, 'tls'),
+        type=pulumi.get(__response__, 'type'),
+        upstream=pulumi.get(__response__, 'upstream'),
+        version=pulumi.get(__response__, 'version')))