pulumi-azure-native 2.72.0a1731506636__py3-none-any.whl → 2.73.0__py3-none-any.whl

pulumi_azure_native/documentdb/v20241201preview/get_mongo_db_resource_mongo_db_collection.py

@@ -0,0 +1,191 @@
+# 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__ = [
+    'GetMongoDBResourceMongoDBCollectionResult',
+    'AwaitableGetMongoDBResourceMongoDBCollectionResult',
+    'get_mongo_db_resource_mongo_db_collection',
+    'get_mongo_db_resource_mongo_db_collection_output',
+]
+
+@pulumi.output_type
+class GetMongoDBResourceMongoDBCollectionResult:
+    """
+    An Azure Cosmos DB MongoDB collection.
+    """
+    def __init__(__self__, id=None, identity=None, location=None, name=None, options=None, resource=None, tags=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 identity and not isinstance(identity, dict):
+            raise TypeError("Expected argument 'identity' to be a dict")
+        pulumi.set(__self__, "identity", identity)
+        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 options and not isinstance(options, dict):
+            raise TypeError("Expected argument 'options' to be a dict")
+        pulumi.set(__self__, "options", options)
+        if resource and not isinstance(resource, dict):
+            raise TypeError("Expected argument 'resource' to be a dict")
+        pulumi.set(__self__, "resource", resource)
+        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
+    def id(self) -> str:
+        """
+        The unique resource identifier of the ARM resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def identity(self) -> Optional['outputs.ManagedServiceIdentityResponse']:
+        """
+        Identity for the resource.
+        """
+        return pulumi.get(self, "identity")
+
+    @property
+    @pulumi.getter
+    def location(self) -> Optional[str]:
+        """
+        The location of the resource group to which the resource belongs.
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the ARM resource.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def options(self) -> Optional['outputs.MongoDBCollectionGetPropertiesResponseOptions']:
+        return pulumi.get(self, "options")
+
+    @property
+    @pulumi.getter
+    def resource(self) -> Optional['outputs.MongoDBCollectionGetPropertiesResponseResource']:
+        return pulumi.get(self, "resource")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Optional[Mapping[str, str]]:
+        """
+        Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
+        """
+        return pulumi.get(self, "tags")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of Azure resource.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetMongoDBResourceMongoDBCollectionResult(GetMongoDBResourceMongoDBCollectionResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetMongoDBResourceMongoDBCollectionResult(
+            id=self.id,
+            identity=self.identity,
+            location=self.location,
+            name=self.name,
+            options=self.options,
+            resource=self.resource,
+            tags=self.tags,
+            type=self.type)
+
+
+def get_mongo_db_resource_mongo_db_collection(account_name: Optional[str] = None,
+                                              collection_name: Optional[str] = None,
+                                              database_name: Optional[str] = None,
+                                              resource_group_name: Optional[str] = None,
+                                              opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetMongoDBResourceMongoDBCollectionResult:
+    """
+    Gets the MongoDB collection under an existing Azure Cosmos DB database account.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str collection_name: Cosmos DB collection name.
+    :param str database_name: Cosmos DB database name.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    __args__ = dict()
+    __args__['accountName'] = account_name
+    __args__['collectionName'] = collection_name
+    __args__['databaseName'] = database_name
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:documentdb/v20241201preview:getMongoDBResourceMongoDBCollection', __args__, opts=opts, typ=GetMongoDBResourceMongoDBCollectionResult).value
+
+    return AwaitableGetMongoDBResourceMongoDBCollectionResult(
+        id=pulumi.get(__ret__, 'id'),
+        identity=pulumi.get(__ret__, 'identity'),
+        location=pulumi.get(__ret__, 'location'),
+        name=pulumi.get(__ret__, 'name'),
+        options=pulumi.get(__ret__, 'options'),
+        resource=pulumi.get(__ret__, 'resource'),
+        tags=pulumi.get(__ret__, 'tags'),
+        type=pulumi.get(__ret__, 'type'))
+def get_mongo_db_resource_mongo_db_collection_output(account_name: Optional[pulumi.Input[str]] = None,
+                                                     collection_name: Optional[pulumi.Input[str]] = None,
+                                                     database_name: Optional[pulumi.Input[str]] = None,
+                                                     resource_group_name: Optional[pulumi.Input[str]] = None,
+                                                     opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetMongoDBResourceMongoDBCollectionResult]:
+    """
+    Gets the MongoDB collection under an existing Azure Cosmos DB database account.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str collection_name: Cosmos DB collection name.
+    :param str database_name: Cosmos DB database name.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    __args__ = dict()
+    __args__['accountName'] = account_name
+    __args__['collectionName'] = collection_name
+    __args__['databaseName'] = database_name
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('azure-native:documentdb/v20241201preview:getMongoDBResourceMongoDBCollection', __args__, opts=opts, typ=GetMongoDBResourceMongoDBCollectionResult)
+    return __ret__.apply(lambda __response__: GetMongoDBResourceMongoDBCollectionResult(
+        id=pulumi.get(__response__, 'id'),
+        identity=pulumi.get(__response__, 'identity'),
+        location=pulumi.get(__response__, 'location'),
+        name=pulumi.get(__response__, 'name'),
+        options=pulumi.get(__response__, 'options'),
+        resource=pulumi.get(__response__, 'resource'),
+        tags=pulumi.get(__response__, 'tags'),
+        type=pulumi.get(__response__, 'type')))

pulumi_azure_native/documentdb/v20241201preview/get_mongo_db_resource_mongo_db_database.py

@@ -0,0 +1,185 @@
+# 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__ = [
+    'GetMongoDBResourceMongoDBDatabaseResult',
+    'AwaitableGetMongoDBResourceMongoDBDatabaseResult',
+    'get_mongo_db_resource_mongo_db_database',
+    'get_mongo_db_resource_mongo_db_database_output',
+]
+
+@pulumi.output_type
+class GetMongoDBResourceMongoDBDatabaseResult:
+    """
+    An Azure Cosmos DB MongoDB database.
+    """
+    def __init__(__self__, id=None, identity=None, location=None, name=None, options=None, resource=None, tags=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 identity and not isinstance(identity, dict):
+            raise TypeError("Expected argument 'identity' to be a dict")
+        pulumi.set(__self__, "identity", identity)
+        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 options and not isinstance(options, dict):
+            raise TypeError("Expected argument 'options' to be a dict")
+        pulumi.set(__self__, "options", options)
+        if resource and not isinstance(resource, dict):
+            raise TypeError("Expected argument 'resource' to be a dict")
+        pulumi.set(__self__, "resource", resource)
+        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
+    def id(self) -> str:
+        """
+        The unique resource identifier of the ARM resource.
+        """
+        return pulumi.get(self, "id")
+
+    @property
+    @pulumi.getter
+    def identity(self) -> Optional['outputs.ManagedServiceIdentityResponse']:
+        """
+        Identity for the resource.
+        """
+        return pulumi.get(self, "identity")
+
+    @property
+    @pulumi.getter
+    def location(self) -> Optional[str]:
+        """
+        The location of the resource group to which the resource belongs.
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter
+    def name(self) -> str:
+        """
+        The name of the ARM resource.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def options(self) -> Optional['outputs.MongoDBDatabaseGetPropertiesResponseOptions']:
+        return pulumi.get(self, "options")
+
+    @property
+    @pulumi.getter
+    def resource(self) -> Optional['outputs.MongoDBDatabaseGetPropertiesResponseResource']:
+        return pulumi.get(self, "resource")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Optional[Mapping[str, str]]:
+        """
+        Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with "defaultExperience": "Cassandra". Current "defaultExperience" values also include "Table", "Graph", "DocumentDB", and "MongoDB".
+        """
+        return pulumi.get(self, "tags")
+
+    @property
+    @pulumi.getter
+    def type(self) -> str:
+        """
+        The type of Azure resource.
+        """
+        return pulumi.get(self, "type")
+
+
+class AwaitableGetMongoDBResourceMongoDBDatabaseResult(GetMongoDBResourceMongoDBDatabaseResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetMongoDBResourceMongoDBDatabaseResult(
+            id=self.id,
+            identity=self.identity,
+            location=self.location,
+            name=self.name,
+            options=self.options,
+            resource=self.resource,
+            tags=self.tags,
+            type=self.type)
+
+
+def get_mongo_db_resource_mongo_db_database(account_name: Optional[str] = None,
+                                            database_name: Optional[str] = None,
+                                            resource_group_name: Optional[str] = None,
+                                            opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetMongoDBResourceMongoDBDatabaseResult:
+    """
+    Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str database_name: Cosmos DB database name.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    __args__ = dict()
+    __args__['accountName'] = account_name
+    __args__['databaseName'] = database_name
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('azure-native:documentdb/v20241201preview:getMongoDBResourceMongoDBDatabase', __args__, opts=opts, typ=GetMongoDBResourceMongoDBDatabaseResult).value
+
+    return AwaitableGetMongoDBResourceMongoDBDatabaseResult(
+        id=pulumi.get(__ret__, 'id'),
+        identity=pulumi.get(__ret__, 'identity'),
+        location=pulumi.get(__ret__, 'location'),
+        name=pulumi.get(__ret__, 'name'),
+        options=pulumi.get(__ret__, 'options'),
+        resource=pulumi.get(__ret__, 'resource'),
+        tags=pulumi.get(__ret__, 'tags'),
+        type=pulumi.get(__ret__, 'type'))
+def get_mongo_db_resource_mongo_db_database_output(account_name: Optional[pulumi.Input[str]] = None,
+                                                   database_name: Optional[pulumi.Input[str]] = None,
+                                                   resource_group_name: Optional[pulumi.Input[str]] = None,
+                                                   opts: Optional[pulumi.InvokeOptions] = None) -> pulumi.Output[GetMongoDBResourceMongoDBDatabaseResult]:
+    """
+    Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.
+
+
+    :param str account_name: Cosmos DB database account name.
+    :param str database_name: Cosmos DB database name.
+    :param str resource_group_name: The name of the resource group. The name is case insensitive.
+    """
+    __args__ = dict()
+    __args__['accountName'] = account_name
+    __args__['databaseName'] = database_name
+    __args__['resourceGroupName'] = resource_group_name
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('azure-native:documentdb/v20241201preview:getMongoDBResourceMongoDBDatabase', __args__, opts=opts, typ=GetMongoDBResourceMongoDBDatabaseResult)
+    return __ret__.apply(lambda __response__: GetMongoDBResourceMongoDBDatabaseResult(
+        id=pulumi.get(__response__, 'id'),
+        identity=pulumi.get(__response__, 'identity'),
+        location=pulumi.get(__response__, 'location'),
+        name=pulumi.get(__response__, 'name'),
+        options=pulumi.get(__response__, 'options'),
+        resource=pulumi.get(__response__, 'resource'),
+        tags=pulumi.get(__response__, 'tags'),
+        type=pulumi.get(__response__, 'type')))

pulumi_azure_native/documentdb/v20241201preview/get_mongo_db_resource_mongo_role_definition.py

@@ -0,0 +1,177 @@
+# 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__ = [
+    '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/v20241201preview: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'))
+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.
+    """
+    __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_output('azure-native:documentdb/v20241201preview:getMongoDBResourceMongoRoleDefinition', __args__, opts=opts, typ=GetMongoDBResourceMongoRoleDefinitionResult)
+    return __ret__.apply(lambda __response__: GetMongoDBResourceMongoRoleDefinitionResult(
+        database_name=pulumi.get(__response__, 'database_name'),
+        id=pulumi.get(__response__, 'id'),
+        name=pulumi.get(__response__, 'name'),
+        privileges=pulumi.get(__response__, 'privileges'),
+        role_name=pulumi.get(__response__, 'role_name'),
+        roles=pulumi.get(__response__, 'roles'),
+        type=pulumi.get(__response__, 'type')))