pulumi-azure-native 2.41.0a1715664832__py3-none-any.whl → 2.42.0__py3-none-any.whl

pulumi_azure_native/documentdb/v20240515/get_mongo_db_resource_mongo_role_definition.py

@@ -0,0 +1,162 @@
+# 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 pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetMongoDBResourceMongoRoleDefinitionResult',
+    'AwaitableGetMongoDBResourceMongoRoleDefinitionResult',
+    'get_mongo_db_resource_mongo_role_definition',
+    'get_mongo_db_resource_mongo_role_definition_output',
+]
+
+@pulumi.output_type
+class GetMongoDBResourceMongoRoleDefinitionResult:
+    """
+    An Azure Cosmos DB Mongo Role Definition.
+    """
+    def __init__(__self__, database_name=None, id=None, name=None, privileges=None, role_name=None, roles=None, type=None):
+        if database_name and not isinstance(database_name, str):
+            raise TypeError("Expected argument 'database_name' to be a str")
+        pulumi.set(__self__, "database_name", database_name)
+        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 privileges and not isinstance(privileges, list):
+            raise TypeError("Expected argument 'privileges' to be a list")
+        pulumi.set(__self__, "privileges", privileges)
+        if role_name and not isinstance(role_name, str):
+            raise TypeError("Expected argument 'role_name' to be a str")
+        pulumi.set(__self__, "role_name", role_name)
+        if roles and not isinstance(roles, list):
+            raise TypeError("Expected argument 'roles' to be a list")
+        pulumi.set(__self__, "roles", roles)
+        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="databaseName")
+    def database_name(self) -> Optional[str]:
+        """
+        The database name for which access is being granted for this Role Definition.
+        """
+        return pulumi.get(self, "database_name")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The unique resource identifier of the database account.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the database account.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def privileges(self) -> Optional[Sequence['outputs.PrivilegeResponse']]:
+        """
+        A set of privileges contained by the Role Definition. This will allow application of this Role Definition on the entire database account or any underlying Database / Collection. Scopes higher than Database are not enforceable as privilege.
+        """
+        return pulumi.get(self, "privileges")
+
+    @property
+    @pulumi.getter(name="roleName")
+    def role_name(self) -> Optional[str]:
+        """
+        A user-friendly name for the Role Definition. Must be unique for the database account.
+        """
+        return pulumi.get(self, "role_name")
+
+    @property
+    @pulumi.getter
+    def roles(self) -> Optional[Sequence['outputs.RoleResponse']]:
+        """
+        The set of roles inherited by this Role Definition.
+        """
+        return pulumi.get(self, "roles")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of Azure resource.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetMongoDBResourceMongoRoleDefinitionResult(GetMongoDBResourceMongoRoleDefinitionResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetMongoDBResourceMongoRoleDefinitionResult(
+            database_name=self.database_name,
+            id=self.id,
+            name=self.name,
+            privileges=self.privileges,
+            role_name=self.role_name,
+            roles=self.roles,
+            type=self.type)
+
+
+def get_mongo_db_resource_mongo_role_definition(account_name: Optional[str] = None,
+                                                mongo_role_definition_id: Optional[str] = None,
+                                                resource_group_name: Optional[str] = None,
+                                                opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetMongoDBResourceMongoRoleDefinitionResult:
+    """
+    Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str mongo_role_definition_id: The ID for the Role Definition {dbName.roleName}.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    __args__ = dict()
+    __args__['accountName'] = account_name
+    __args__['mongoRoleDefinitionId'] = mongo_role_definition_id
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:documentdb/v20240515:getMongoDBResourceMongoRoleDefinition', __args__, opts=opts, typ=GetMongoDBResourceMongoRoleDefinitionResult).value
+
+    return AwaitableGetMongoDBResourceMongoRoleDefinitionResult(
+        database_name=pulumi.get(__ret__, 'database_name'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        privileges=pulumi.get(__ret__, 'privileges'),
+        role_name=pulumi.get(__ret__, 'role_name'),
+        roles=pulumi.get(__ret__, 'roles'),
+        type=pulumi.get(__ret__, 'type'))
+
+
+@_utilities.lift_output_func(get_mongo_db_resource_mongo_role_definition)
+def get_mongo_db_resource_mongo_role_definition_output(account_name: Optional[pulumi.Input[str]] = None,
+                                                       mongo_role_definition_id: Optional[pulumi.Input[str]] = None,
+                                                       resource_group_name: Optional[pulumi.Input[str]] = None,
+                                                       opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetMongoDBResourceMongoRoleDefinitionResult]:
+    """
+    Retrieves the properties of an existing Azure Cosmos DB Mongo Role Definition with the given Id.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str mongo_role_definition_id: The ID for the Role Definition {dbName.roleName}.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    ...

pulumi_azure_native/documentdb/v20240515/get_mongo_db_resource_mongo_user_definition.py

@@ -0,0 +1,188 @@
+# 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 pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetMongoDBResourceMongoUserDefinitionResult',
+    'AwaitableGetMongoDBResourceMongoUserDefinitionResult',
+    'get_mongo_db_resource_mongo_user_definition',
+    'get_mongo_db_resource_mongo_user_definition_output',
+]
+
+@pulumi.output_type
+class GetMongoDBResourceMongoUserDefinitionResult:
+    """
+    An Azure Cosmos DB User Definition
+    """
+    def __init__(__self__, custom_data=None, database_name=None, id=None, mechanisms=None, name=None, password=None, roles=None, type=None, user_name=None):
+        if custom_data and not isinstance(custom_data, str):
+            raise TypeError("Expected argument 'custom_data' to be a str")
+        pulumi.set(__self__, "custom_data", custom_data)
+        if database_name and not isinstance(database_name, str):
+            raise TypeError("Expected argument 'database_name' to be a str")
+        pulumi.set(__self__, "database_name", database_name)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if mechanisms and not isinstance(mechanisms, str):
+            raise TypeError("Expected argument 'mechanisms' to be a str")
+        pulumi.set(__self__, "mechanisms", mechanisms)
+        if name and not isinstance(name, str):
+            raise TypeError("Expected argument 'name' to be a str")
+        pulumi.set(__self__, "name", name)
+        if password and not isinstance(password, str):
+            raise TypeError("Expected argument 'password' to be a str")
+        pulumi.set(__self__, "password", password)
+        if roles and not isinstance(roles, list):
+            raise TypeError("Expected argument 'roles' to be a list")
+        pulumi.set(__self__, "roles", roles)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+        if user_name and not isinstance(user_name, str):
+            raise TypeError("Expected argument 'user_name' to be a str")
+        pulumi.set(__self__, "user_name", user_name)
+
+    @property
+    @pulumi.getter(name="customData")
+    def custom_data(self) -> Optional[str]:
+        """
+        A custom definition for the USer Definition.
+        """
+        return pulumi.get(self, "custom_data")
+
+    @property
+    @pulumi.getter(name="databaseName")
+    def database_name(self) -> Optional[str]:
+        """
+        The database name for which access is being granted for this User Definition.
+        """
+        return pulumi.get(self, "database_name")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The unique resource identifier of the database account.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def mechanisms(self) -> Optional[str]:
+        """
+        The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256.
+        """
+        return pulumi.get(self, "mechanisms")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the database account.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def password(self) -> Optional[str]:
+        """
+        The password for User Definition. Response does not contain user password.
+        """
+        return pulumi.get(self, "password")
+
+    @property
+    @pulumi.getter
+    def roles(self) -> Optional[Sequence['outputs.RoleResponse']]:
+        """
+        The set of roles inherited by the User Definition.
+        """
+        return pulumi.get(self, "roles")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of Azure resource.
+        """
+        return pulumi.get(self, "type")
+
+    @property
+    @pulumi.getter(name="userName")
+    def user_name(self) -> Optional[str]:
+        """
+        The user name for User Definition.
+        """
+        return pulumi.get(self, "user_name")
+
+
+class AwaitableGetMongoDBResourceMongoUserDefinitionResult(GetMongoDBResourceMongoUserDefinitionResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetMongoDBResourceMongoUserDefinitionResult(
+            custom_data=self.custom_data,
+            database_name=self.database_name,
+            id=self.id,
+            mechanisms=self.mechanisms,
+            name=self.name,
+            password=self.password,
+            roles=self.roles,
+            type=self.type,
+            user_name=self.user_name)
+
+
+def get_mongo_db_resource_mongo_user_definition(account_name: Optional[str] = None,
+                                                mongo_user_definition_id: Optional[str] = None,
+                                                resource_group_name: Optional[str] = None,
+                                                opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetMongoDBResourceMongoUserDefinitionResult:
+    """
+    Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str mongo_user_definition_id: The ID for the User Definition {dbName.userName}.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    __args__ = dict()
+    __args__['accountName'] = account_name
+    __args__['mongoUserDefinitionId'] = mongo_user_definition_id
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:documentdb/v20240515:getMongoDBResourceMongoUserDefinition', __args__, opts=opts, typ=GetMongoDBResourceMongoUserDefinitionResult).value
+
+    return AwaitableGetMongoDBResourceMongoUserDefinitionResult(
+        custom_data=pulumi.get(__ret__, 'custom_data'),
+        database_name=pulumi.get(__ret__, 'database_name'),
+        id=pulumi.get(__ret__, 'id'),
+        mechanisms=pulumi.get(__ret__, 'mechanisms'),
+        name=pulumi.get(__ret__, 'name'),
+        password=pulumi.get(__ret__, 'password'),
+        roles=pulumi.get(__ret__, 'roles'),
+        type=pulumi.get(__ret__, 'type'),
+        user_name=pulumi.get(__ret__, 'user_name'))
+
+
+@_utilities.lift_output_func(get_mongo_db_resource_mongo_user_definition)
+def get_mongo_db_resource_mongo_user_definition_output(account_name: Optional[pulumi.Input[str]] = None,
+                                                       mongo_user_definition_id: Optional[pulumi.Input[str]] = None,
+                                                       resource_group_name: Optional[pulumi.Input[str]] = None,
+                                                       opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetMongoDBResourceMongoUserDefinitionResult]:
+    """
+    Retrieves the properties of an existing Azure Cosmos DB Mongo User Definition with the given Id.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str mongo_user_definition_id: The ID for the User Definition {dbName.userName}.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    ...

pulumi_azure_native/documentdb/v20240515/get_notebook_workspace.py

@@ -0,0 +1,135 @@
+# 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 pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+
+__all__ = [
+    'GetNotebookWorkspaceResult',
+    'AwaitableGetNotebookWorkspaceResult',
+    'get_notebook_workspace',
+    'get_notebook_workspace_output',
+]
+
+@pulumi.output_type
+class GetNotebookWorkspaceResult:
+    """
+    A notebook workspace resource
+    """
+    def __init__(__self__, id=None, name=None, notebook_server_endpoint=None, status=None, type=None):
+        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 notebook_server_endpoint and not isinstance(notebook_server_endpoint, str):
+            raise TypeError("Expected argument 'notebook_server_endpoint' to be a str")
+        pulumi.set(__self__, "notebook_server_endpoint", notebook_server_endpoint)
+        if status and not isinstance(status, str):
+            raise TypeError("Expected argument 'status' to be a str")
+        pulumi.set(__self__, "status", status)
+        if type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        The unique resource identifier of the database account.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the database account.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="notebookServerEndpoint")
+    def notebook_server_endpoint(self) -> str:
+        """
+        Specifies the endpoint of Notebook server.
+        """
+        return pulumi.get(self, "notebook_server_endpoint")
+
+    @property
+    @pulumi.getter
+    def status(self) -> str:
+        """
+        Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.
+        """
+        return pulumi.get(self, "status")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of Azure resource.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetNotebookWorkspaceResult(GetNotebookWorkspaceResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetNotebookWorkspaceResult(
+            id=self.id,
+            name=self.name,
+            notebook_server_endpoint=self.notebook_server_endpoint,
+            status=self.status,
+            type=self.type)
+
+
+def get_notebook_workspace(account_name: Optional[str] = None,
+                           notebook_workspace_name: Optional[str] = None,
+                           resource_group_name: Optional[str] = None,
+                           opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetNotebookWorkspaceResult:
+    """
+    Gets the notebook workspace for a Cosmos DB account.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str notebook_workspace_name: The name of the notebook workspace resource.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    __args__ = dict()
+    __args__['accountName'] = account_name
+    __args__['notebookWorkspaceName'] = notebook_workspace_name
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:documentdb/v20240515:getNotebookWorkspace', __args__, opts=opts, typ=GetNotebookWorkspaceResult).value
+
+    return AwaitableGetNotebookWorkspaceResult(
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        notebook_server_endpoint=pulumi.get(__ret__, 'notebook_server_endpoint'),
+        status=pulumi.get(__ret__, 'status'),
+        type=pulumi.get(__ret__, 'type'))
+
+
+@_utilities.lift_output_func(get_notebook_workspace)
+def get_notebook_workspace_output(account_name: Optional[pulumi.Input[str]] = None,
+                                  notebook_workspace_name: Optional[pulumi.Input[str]] = None,
+                                  resource_group_name: Optional[pulumi.Input[str]] = None,
+                                  opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetNotebookWorkspaceResult]:
+    """
+    Gets the notebook workspace for a Cosmos DB account.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str notebook_workspace_name: The name of the notebook workspace resource.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    ...

pulumi_azure_native/documentdb/v20240515/get_private_endpoint_connection.py

@@ -0,0 +1,162 @@
+# 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 pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+from ... import _utilities
+from . import outputs
+
+__all__ = [
+    'GetPrivateEndpointConnectionResult',
+    'AwaitableGetPrivateEndpointConnectionResult',
+    'get_private_endpoint_connection',
+    'get_private_endpoint_connection_output',
+]
+
+@pulumi.output_type
+class GetPrivateEndpointConnectionResult:
+    """
+    A private endpoint connection
+    """
+    def __init__(__self__, group_id=None, id=None, name=None, private_endpoint=None, private_link_service_connection_state=None, provisioning_state=None, type=None):
+        if group_id and not isinstance(group_id, str):
+            raise TypeError("Expected argument 'group_id' to be a str")
+        pulumi.set(__self__, "group_id", group_id)
+        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 private_endpoint and not isinstance(private_endpoint, dict):
+            raise TypeError("Expected argument 'private_endpoint' to be a dict")
+        pulumi.set(__self__, "private_endpoint", private_endpoint)
+        if private_link_service_connection_state and not isinstance(private_link_service_connection_state, dict):
+            raise TypeError("Expected argument 'private_link_service_connection_state' to be a dict")
+        pulumi.set(__self__, "private_link_service_connection_state", private_link_service_connection_state)
+        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 type and not isinstance(type, str):
+            raise TypeError("Expected argument 'type' to be a str")
+        pulumi.set(__self__, "type", type)
+
+    @property
+    @pulumi.getter(name="groupId")
+    def group_id(self) -> Optional[str]:
+        """
+        Group id of the private endpoint.
+        """
+        return pulumi.get(self, "group_id")
+
+    @property
+    @pulumi.getter
+    def id(self) -> str:
+        """
+        Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the resource
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter(name="privateEndpoint")
+    def private_endpoint(self) -> Optional['outputs.PrivateEndpointPropertyResponse']:
+        """
+        Private endpoint which the connection belongs to.
+        """
+        return pulumi.get(self, "private_endpoint")
+
+    @property
+    @pulumi.getter(name="privateLinkServiceConnectionState")
+    def private_link_service_connection_state(self) -> Optional['outputs.PrivateLinkServiceConnectionStatePropertyResponse']:
+        """
+        Connection State of the Private Endpoint Connection.
+        """
+        return pulumi.get(self, "private_link_service_connection_state")
+
+    @property
+    @pulumi.getter(name="provisioningState")
+    def provisioning_state(self) -> Optional[str]:
+        """
+        Provisioning state of the private endpoint.
+        """
+        return pulumi.get(self, "provisioning_state")
+
+    @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")
+
+
+class AwaitableGetPrivateEndpointConnectionResult(GetPrivateEndpointConnectionResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetPrivateEndpointConnectionResult(
+            group_id=self.group_id,
+            id=self.id,
+            name=self.name,
+            private_endpoint=self.private_endpoint,
+            private_link_service_connection_state=self.private_link_service_connection_state,
+            provisioning_state=self.provisioning_state,
+            type=self.type)
+
+
+def get_private_endpoint_connection(account_name: Optional[str] = None,
+                                    private_endpoint_connection_name: Optional[str] = None,
+                                    resource_group_name: Optional[str] = None,
+                                    opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetPrivateEndpointConnectionResult:
+    """
+    Gets a private endpoint connection.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str private_endpoint_connection_name: The name of the private endpoint connection.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    __args__ = dict()
+    __args__['accountName'] = account_name
+    __args__['privateEndpointConnectionName'] = private_endpoint_connection_name
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:documentdb/v20240515:getPrivateEndpointConnection', __args__, opts=opts, typ=GetPrivateEndpointConnectionResult).value
+
+    return AwaitableGetPrivateEndpointConnectionResult(
+        group_id=pulumi.get(__ret__, 'group_id'),
+        id=pulumi.get(__ret__, 'id'),
+        name=pulumi.get(__ret__, 'name'),
+        private_endpoint=pulumi.get(__ret__, 'private_endpoint'),
+        private_link_service_connection_state=pulumi.get(__ret__, 'private_link_service_connection_state'),
+        provisioning_state=pulumi.get(__ret__, 'provisioning_state'),
+        type=pulumi.get(__ret__, 'type'))
+
+
+@_utilities.lift_output_func(get_private_endpoint_connection)
+def get_private_endpoint_connection_output(account_name: Optional[pulumi.Input[str]] = None,
+                                           private_endpoint_connection_name: Optional[pulumi.Input[str]] = None,
+                                           resource_group_name: Optional[pulumi.Input[str]] = None,
+                                           opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetPrivateEndpointConnectionResult]:
+    """
+    Gets a private endpoint connection.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str private_endpoint_connection_name: The name of the private endpoint connection.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    ...