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

pulumi_azure_native/documentdb/v20241201preview/mongo_db_resource_mongo_db_collection.py

@@ -0,0 +1,343 @@
+# 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
+from ._enums import *
+from ._inputs import *
+
+__all__ = ['MongoDBResourceMongoDBCollectionArgs', 'MongoDBResourceMongoDBCollection']
+
+@pulumi.input_type
+class MongoDBResourceMongoDBCollectionArgs:
+    def __init__(__self__, *,
+                 account_name: pulumi.Input[str],
+                 database_name: pulumi.Input[str],
+                 resource: pulumi.Input['MongoDBCollectionResourceArgs'],
+                 resource_group_name: pulumi.Input[str],
+                 collection_name: Optional[pulumi.Input[str]] = None,
+                 identity: Optional[pulumi.Input['ManagedServiceIdentityArgs']] = None,
+                 location: Optional[pulumi.Input[str]] = None,
+                 options: Optional[pulumi.Input['CreateUpdateOptionsArgs']] = None,
+                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None):
+        """
+        The set of arguments for constructing a MongoDBResourceMongoDBCollection resource.
+        :param pulumi.Input[str] account_name: Cosmos DB database account name.
+        :param pulumi.Input[str] database_name: Cosmos DB database name.
+        :param pulumi.Input['MongoDBCollectionResourceArgs'] resource: The standard JSON format of a MongoDB collection
+        :param pulumi.Input[str] resource_group_name: The name of the resource group. The name is case insensitive.
+        :param pulumi.Input[str] collection_name: Cosmos DB collection name.
+        :param pulumi.Input['ManagedServiceIdentityArgs'] identity: Identity for the resource.
+        :param pulumi.Input[str] location: The location of the resource group to which the resource belongs.
+        :param pulumi.Input['CreateUpdateOptionsArgs'] options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: 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".
+        """
+        pulumi.set(__self__, "account_name", account_name)
+        pulumi.set(__self__, "database_name", database_name)
+        pulumi.set(__self__, "resource", resource)
+        pulumi.set(__self__, "resource_group_name", resource_group_name)
+        if collection_name is not None:
+            pulumi.set(__self__, "collection_name", collection_name)
+        if identity is not None:
+            pulumi.set(__self__, "identity", identity)
+        if location is not None:
+            pulumi.set(__self__, "location", location)
+        if options is not None:
+            pulumi.set(__self__, "options", options)
+        if tags is not None:
+            pulumi.set(__self__, "tags", tags)
+
+    @property
+    @pulumi.getter(name="accountName")
+    def account_name(self) -> pulumi.Input[str]:
+        """
+        Cosmos DB database account name.
+        """
+        return pulumi.get(self, "account_name")
+
+    @account_name.setter
+    def account_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "account_name", value)
+
+    @property
+    @pulumi.getter(name="databaseName")
+    def database_name(self) -> pulumi.Input[str]:
+        """
+        Cosmos DB database name.
+        """
+        return pulumi.get(self, "database_name")
+
+    @database_name.setter
+    def database_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "database_name", value)
+
+    @property
+    @pulumi.getter
+    def resource(self) -> pulumi.Input['MongoDBCollectionResourceArgs']:
+        """
+        The standard JSON format of a MongoDB collection
+        """
+        return pulumi.get(self, "resource")
+
+    @resource.setter
+    def resource(self, value: pulumi.Input['MongoDBCollectionResourceArgs']):
+        pulumi.set(self, "resource", value)
+
+    @property
+    @pulumi.getter(name="resourceGroupName")
+    def resource_group_name(self) -> pulumi.Input[str]:
+        """
+        The name of the resource group. The name is case insensitive.
+        """
+        return pulumi.get(self, "resource_group_name")
+
+    @resource_group_name.setter
+    def resource_group_name(self, value: pulumi.Input[str]):
+        pulumi.set(self, "resource_group_name", value)
+
+    @property
+    @pulumi.getter(name="collectionName")
+    def collection_name(self) -> Optional[pulumi.Input[str]]:
+        """
+        Cosmos DB collection name.
+        """
+        return pulumi.get(self, "collection_name")
+
+    @collection_name.setter
+    def collection_name(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "collection_name", value)
+
+    @property
+    @pulumi.getter
+    def identity(self) -> Optional[pulumi.Input['ManagedServiceIdentityArgs']]:
+        """
+        Identity for the resource.
+        """
+        return pulumi.get(self, "identity")
+
+    @identity.setter
+    def identity(self, value: Optional[pulumi.Input['ManagedServiceIdentityArgs']]):
+        pulumi.set(self, "identity", value)
+
+    @property
+    @pulumi.getter
+    def location(self) -> Optional[pulumi.Input[str]]:
+        """
+        The location of the resource group to which the resource belongs.
+        """
+        return pulumi.get(self, "location")
+
+    @location.setter
+    def location(self, value: Optional[pulumi.Input[str]]):
+        pulumi.set(self, "location", value)
+
+    @property
+    @pulumi.getter
+    def options(self) -> Optional[pulumi.Input['CreateUpdateOptionsArgs']]:
+        """
+        A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
+        """
+        return pulumi.get(self, "options")
+
+    @options.setter
+    def options(self, value: Optional[pulumi.Input['CreateUpdateOptionsArgs']]):
+        pulumi.set(self, "options", value)
+
+    @property
+    @pulumi.getter
+    def tags(self) -> Optional[pulumi.Input[Mapping[str, pulumi.Input[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")
+
+    @tags.setter
+    def tags(self, value: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]]):
+        pulumi.set(self, "tags", value)
+
+
+class MongoDBResourceMongoDBCollection(pulumi.CustomResource):
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 account_name: Optional[pulumi.Input[str]] = None,
+                 collection_name: Optional[pulumi.Input[str]] = None,
+                 database_name: Optional[pulumi.Input[str]] = None,
+                 identity: Optional[pulumi.Input[Union['ManagedServiceIdentityArgs', 'ManagedServiceIdentityArgsDict']]] = None,
+                 location: Optional[pulumi.Input[str]] = None,
+                 options: Optional[pulumi.Input[Union['CreateUpdateOptionsArgs', 'CreateUpdateOptionsArgsDict']]] = None,
+                 resource: Optional[pulumi.Input[Union['MongoDBCollectionResourceArgs', 'MongoDBCollectionResourceArgsDict']]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 __props__=None):
+        """
+        An Azure Cosmos DB MongoDB collection.
+
+        :param str resource_name: The name of the resource.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        :param pulumi.Input[str] account_name: Cosmos DB database account name.
+        :param pulumi.Input[str] collection_name: Cosmos DB collection name.
+        :param pulumi.Input[str] database_name: Cosmos DB database name.
+        :param pulumi.Input[Union['ManagedServiceIdentityArgs', 'ManagedServiceIdentityArgsDict']] identity: Identity for the resource.
+        :param pulumi.Input[str] location: The location of the resource group to which the resource belongs.
+        :param pulumi.Input[Union['CreateUpdateOptionsArgs', 'CreateUpdateOptionsArgsDict']] options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.
+        :param pulumi.Input[Union['MongoDBCollectionResourceArgs', 'MongoDBCollectionResourceArgsDict']] resource: The standard JSON format of a MongoDB collection
+        :param pulumi.Input[str] resource_group_name: The name of the resource group. The name is case insensitive.
+        :param pulumi.Input[Mapping[str, pulumi.Input[str]]] tags: 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".
+        """
+        ...
+    @overload
+    def __init__(__self__,
+                 resource_name: str,
+                 args: MongoDBResourceMongoDBCollectionArgs,
+                 opts: Optional[pulumi.ResourceOptions] = None):
+        """
+        An Azure Cosmos DB MongoDB collection.
+
+        :param str resource_name: The name of the resource.
+        :param MongoDBResourceMongoDBCollectionArgs args: The arguments to use to populate this resource's properties.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        ...
+    def __init__(__self__, resource_name: str, *args, **kwargs):
+        resource_args, opts = _utilities.get_resource_args_opts(MongoDBResourceMongoDBCollectionArgs, pulumi.ResourceOptions, *args, **kwargs)
+        if resource_args is not None:
+            __self__._internal_init(resource_name, opts, **resource_args.__dict__)
+        else:
+            __self__._internal_init(resource_name, *args, **kwargs)
+
+    def _internal_init(__self__,
+                 resource_name: str,
+                 opts: Optional[pulumi.ResourceOptions] = None,
+                 account_name: Optional[pulumi.Input[str]] = None,
+                 collection_name: Optional[pulumi.Input[str]] = None,
+                 database_name: Optional[pulumi.Input[str]] = None,
+                 identity: Optional[pulumi.Input[Union['ManagedServiceIdentityArgs', 'ManagedServiceIdentityArgsDict']]] = None,
+                 location: Optional[pulumi.Input[str]] = None,
+                 options: Optional[pulumi.Input[Union['CreateUpdateOptionsArgs', 'CreateUpdateOptionsArgsDict']]] = None,
+                 resource: Optional[pulumi.Input[Union['MongoDBCollectionResourceArgs', 'MongoDBCollectionResourceArgsDict']]] = None,
+                 resource_group_name: Optional[pulumi.Input[str]] = None,
+                 tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
+                 __props__=None):
+        opts = pulumi.ResourceOptions.merge(_utilities.get_resource_opts_defaults(), opts)
+        if not isinstance(opts, pulumi.ResourceOptions):
+            raise TypeError('Expected resource options to be a ResourceOptions instance')
+        if opts.id is None:
+            if __props__ is not None:
+                raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
+            __props__ = MongoDBResourceMongoDBCollectionArgs.__new__(MongoDBResourceMongoDBCollectionArgs)
+
+            if account_name is None and not opts.urn:
+                raise TypeError("Missing required property 'account_name'")
+            __props__.__dict__["account_name"] = account_name
+            __props__.__dict__["collection_name"] = collection_name
+            if database_name is None and not opts.urn:
+                raise TypeError("Missing required property 'database_name'")
+            __props__.__dict__["database_name"] = database_name
+            __props__.__dict__["identity"] = identity
+            __props__.__dict__["location"] = location
+            __props__.__dict__["options"] = options
+            if resource is None and not opts.urn:
+                raise TypeError("Missing required property 'resource'")
+            __props__.__dict__["resource"] = resource
+            if resource_group_name is None and not opts.urn:
+                raise TypeError("Missing required property 'resource_group_name'")
+            __props__.__dict__["resource_group_name"] = resource_group_name
+            __props__.__dict__["tags"] = tags
+            __props__.__dict__["name"] = None
+            __props__.__dict__["type"] = None
+        alias_opts = pulumi.ResourceOptions(aliases=[pulumi.Alias(type_="azure-native:documentdb:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20150401:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20150408:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20151106:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20160319:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20160331:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20190801:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20191212:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20200301:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20200401:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20200601preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20200901:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20210115:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20210301preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20210315:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20210401preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20210415:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20210515:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20210615:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20210701preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20211015:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20211015preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20211115preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20220215preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20220515:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20220515preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20220815:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20220815preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20221115:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20221115preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20230301preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20230315:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20230315preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20230415:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20230915:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20230915preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20231115:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20231115preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20240215preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20240515:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20240515preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20240815:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20240901preview:MongoDBResourceMongoDBCollection"), pulumi.Alias(type_="azure-native:documentdb/v20241115:MongoDBResourceMongoDBCollection")])
+        opts = pulumi.ResourceOptions.merge(opts, alias_opts)
+        super(MongoDBResourceMongoDBCollection, __self__).__init__(
+            'azure-native:documentdb/v20241201preview:MongoDBResourceMongoDBCollection',
+            resource_name,
+            __props__,
+            opts)
+
+    @staticmethod
+    def get(resource_name: str,
+            id: pulumi.Input[str],
+            opts: Optional[pulumi.ResourceOptions] = None) -> 'MongoDBResourceMongoDBCollection':
+        """
+        Get an existing MongoDBResourceMongoDBCollection resource's state with the given name, id, and optional extra
+        properties used to qualify the lookup.
+
+        :param str resource_name: The unique name of the resulting resource.
+        :param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
+        :param pulumi.ResourceOptions opts: Options for the resource.
+        """
+        opts = pulumi.ResourceOptions.merge(opts, pulumi.ResourceOptions(id=id))
+
+        __props__ = MongoDBResourceMongoDBCollectionArgs.__new__(MongoDBResourceMongoDBCollectionArgs)
+
+        __props__.__dict__["identity"] = None
+        __props__.__dict__["location"] = None
+        __props__.__dict__["name"] = None
+        __props__.__dict__["options"] = None
+        __props__.__dict__["resource"] = None
+        __props__.__dict__["tags"] = None
+        __props__.__dict__["type"] = None
+        return MongoDBResourceMongoDBCollection(resource_name, opts=opts, __props__=__props__)
+
+    @property
+    @pulumi.getter
+    def identity(self) -> pulumi.Output[Optional['outputs.ManagedServiceIdentityResponse']]:
+        """
+        Identity for the resource.
+        """
+        return pulumi.get(self, "identity")
+
+    @property
+    @pulumi.getter
+    def location(self) -> pulumi.Output[Optional[str]]:
+        """
+        The location of the resource group to which the resource belongs.
+        """
+        return pulumi.get(self, "location")
+
+    @property
+    @pulumi.getter
+    def name(self) -> pulumi.Output[str]:
+        """
+        The name of the ARM resource.
+        """
+        return pulumi.get(self, "name")
+
+    @property
+    @pulumi.getter
+    def options(self) -> pulumi.Output[Optional['outputs.MongoDBCollectionGetPropertiesResponseOptions']]:
+        return pulumi.get(self, "options")
+
+    @property
+    @pulumi.getter
+    def resource(self) -> pulumi.Output[Optional['outputs.MongoDBCollectionGetPropertiesResponseResource']]:
+        return pulumi.get(self, "resource")
+
+    @property
+    @pulumi.getter
+    def tags(self) -> pulumi.Output[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) -> pulumi.Output[str]:
+        """
+        The type of Azure resource.
+        """
+        return pulumi.get(self, "type")
+