diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/CHANGELOG.md b/sdk/mongocluster/azure-mgmt-mongocluster/CHANGELOG.md index b87c2afd731d..d27a4f6d8bea 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/CHANGELOG.md +++ b/sdk/mongocluster/azure-mgmt-mongocluster/CHANGELOG.md @@ -1,5 +1,9 @@ # Release History +## 1.3.0b2 (2026-11-07) + +tool can't generate changelog for this release, please update manually. + ## 1.3.0b1 (2026-07-28) ### Features Added diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/_metadata.json b/sdk/mongocluster/azure-mgmt-mongocluster/_metadata.json index e3f4ad72a1d0..c6fea31f59c9 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/_metadata.json +++ b/sdk/mongocluster/azure-mgmt-mongocluster/_metadata.json @@ -3,9 +3,9 @@ "apiVersions": { "Microsoft.DocumentDB": "2026-06-15-preview" }, - "commit": "358882ad707dcc3b0d1de9df6ba4dfba7e85da1a", + "commit": "180f62a563934f8c0fdd37e0b42845bc110340d3", "repository_url": "https://github.com/Azure/azure-rest-api-specs", "typespec_src": "specification/mongocluster/resource-manager/Microsoft.DocumentDB/MongoCluster", - "emitterVersion": "0.63.3", - "httpClientPythonVersion": "^0.34.2" + "emitterVersion": "0.63.10", + "httpClientPythonVersion": "0.39.0" } \ No newline at end of file diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/api.md b/sdk/mongocluster/azure-mgmt-mongocluster/api.md index 955f4a692cec..6032b1f8619e 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/api.md +++ b/sdk/mongocluster/azure-mgmt-mongocluster/api.md @@ -1863,17 +1863,16 @@ namespace azure.mgmt.mongocluster.types key "password": str key "userName": str password: str - user_name: str + userName: str class azure.mgmt.mongocluster.types.AuthConfigProperties(TypedDict, total=False): allowedModes: list[Union[str, AuthenticationMode]] - allowed_modes: list[Union[str, AuthenticationMode]] class azure.mgmt.mongocluster.types.BackupProperties(TypedDict, total=False): key "earliestRestoreTime": str - earliest_restore_time: str + earliestRestoreTime: str class azure.mgmt.mongocluster.types.CheckNameAvailabilityRequest(TypedDict, total=False): @@ -1891,8 +1890,8 @@ namespace azure.mgmt.mongocluster.types class azure.mgmt.mongocluster.types.CustomerManagedKeyEncryptionProperties(TypedDict, total=False): key "keyEncryptionKeyIdentity": ForwardRef('KeyEncryptionKeyIdentity', module='types') key "keyEncryptionKeyUrl": str - key_encryption_key_identity: KeyEncryptionKeyIdentity - key_encryption_key_url: str + keyEncryptionKeyIdentity: KeyEncryptionKeyIdentity + keyEncryptionKeyUrl: str class azure.mgmt.mongocluster.types.DataApiProperties(TypedDict, total=False): @@ -1909,7 +1908,7 @@ namespace azure.mgmt.mongocluster.types class azure.mgmt.mongocluster.types.EncryptionProperties(TypedDict, total=False): key "customerManagedKeyEncryption": ForwardRef('CustomerManagedKeyEncryptionProperties', module='types') - customer_managed_key_encryption: CustomerManagedKeyEncryptionProperties + customerManagedKeyEncryption: CustomerManagedKeyEncryptionProperties class azure.mgmt.mongocluster.types.EntraIdentityProvider(TypedDict, total=False): @@ -1921,7 +1920,7 @@ namespace azure.mgmt.mongocluster.types class azure.mgmt.mongocluster.types.EntraIdentityProviderProperties(TypedDict, total=False): key "principalType": Required[Union[str, EntraPrincipalType]] - principal_type: Union[str, EntraPrincipalType] + principalType: Union[str, EntraPrincipalType] class azure.mgmt.mongocluster.types.FirewallRule(ProxyResource): @@ -1933,7 +1932,7 @@ namespace azure.mgmt.mongocluster.types id: str name: str properties: FirewallRuleProperties - system_data: SystemData + systemData: SystemData type: str @@ -1941,14 +1940,14 @@ namespace azure.mgmt.mongocluster.types key "endIpAddress": Required[str] key "provisioningState": Union[str, ProvisioningState] key "startIpAddress": Required[str] - end_ip_address: str - provisioning_state: Union[str, ProvisioningState] - start_ip_address: str + endIpAddress: str + provisioningState: Union[str, ProvisioningState] + startIpAddress: str class azure.mgmt.mongocluster.types.HighAvailabilityProperties(TypedDict, total=False): key "targetMode": Union[str, HighAvailabilityMode] - target_mode: Union[str, HighAvailabilityMode] + targetMode: Union[str, HighAvailabilityMode] class azure.mgmt.mongocluster.types.IdentityProvider(TypedDict, total=False): @@ -1965,19 +1964,18 @@ namespace azure.mgmt.mongocluster.types class azure.mgmt.mongocluster.types.KeyEncryptionKeyIdentity(TypedDict, total=False): key "identityType": Union[str, KeyEncryptionKeyIdentityType] key "userAssignedIdentityResourceId": str - identity_type: Union[str, KeyEncryptionKeyIdentityType] - user_assigned_identity_resource_id: str + identityType: Union[str, KeyEncryptionKeyIdentityType] + userAssignedIdentityResourceId: str class azure.mgmt.mongocluster.types.ManagedServiceIdentity(TypedDict, total=False): key "principalId": str key "tenantId": str key "type": Required[Union[str, ManagedServiceIdentityType]] - principal_id: str - tenant_id: str + principalId: str + tenantId: str type: Union[str, ManagedServiceIdentityType] userAssignedIdentities: dict[str, UserAssignedIdentity] - user_assigned_identities: dict[str, UserAssignedIdentity] class azure.mgmt.mongocluster.types.MongoCluster(TrackedResource): @@ -1993,7 +1991,7 @@ namespace azure.mgmt.mongocluster.types location: str name: str properties: MongoClusterProperties - system_data: SystemData + systemData: SystemData tags: dict[str, str] type: str @@ -2020,27 +2018,25 @@ namespace azure.mgmt.mongocluster.types key "sharding": ForwardRef('ShardingProperties', module='types') key "storage": ForwardRef('StorageProperties', module='types') administrator: AdministratorProperties - auth_config: AuthConfigProperties + authConfig: AuthConfigProperties backup: BackupProperties - cluster_status: Union[str, MongoClusterStatus] + clusterStatus: Union[str, MongoClusterStatus] compute: ComputeProperties - connection_string: str - create_mode: Union[str, CreateMode] - data_api: DataApiProperties + connectionString: str + createMode: Union[str, CreateMode] + dataApi: DataApiProperties encryption: EncryptionProperties - high_availability: HighAvailabilityProperties - infrastructure_version: str - network_bypass_mode: Union[str, NetworkBypassMode] + highAvailability: HighAvailabilityProperties + infrastructureVersion: str + networkBypassMode: Union[str, NetworkBypassMode] previewFeatures: list[Union[str, PreviewFeature]] - preview_features: list[Union[str, PreviewFeature]] privateEndpointConnections: list[PrivateEndpointConnection] - private_endpoint_connections: list[PrivateEndpointConnection] - provisioning_state: Union[str, ProvisioningState] - public_network_access: Union[str, PublicNetworkAccess] + provisioningState: Union[str, ProvisioningState] + publicNetworkAccess: Union[str, PublicNetworkAccess] replica: ReplicationProperties - replica_parameters: MongoClusterReplicaParameters - restore_parameters: MongoClusterRestoreParameters - server_version: str + replicaParameters: MongoClusterReplicaParameters + restoreParameters: MongoClusterRestoreParameters + serverVersion: str sharding: ShardingProperties storage: StorageProperties @@ -2048,15 +2044,15 @@ namespace azure.mgmt.mongocluster.types class azure.mgmt.mongocluster.types.MongoClusterReplicaParameters(TypedDict, total=False): key "sourceLocation": Required[str] key "sourceResourceId": Required[str] - source_location: str - source_resource_id: str + sourceLocation: str + sourceResourceId: str class azure.mgmt.mongocluster.types.MongoClusterRestoreParameters(TypedDict, total=False): key "pointInTimeUTC": str key "sourceResourceId": str - point_in_time_utc: str - source_resource_id: str + pointInTimeUTC: str + sourceResourceId: str class azure.mgmt.mongocluster.types.MongoClusterUpdate(TypedDict, total=False): @@ -2081,17 +2077,16 @@ namespace azure.mgmt.mongocluster.types key "sharding": ForwardRef('ShardingProperties', module='types') key "storage": ForwardRef('StorageProperties', module='types') administrator: AdministratorProperties - auth_config: AuthConfigProperties + authConfig: AuthConfigProperties backup: BackupProperties compute: ComputeProperties - data_api: DataApiProperties + dataApi: DataApiProperties encryption: EncryptionProperties - high_availability: HighAvailabilityProperties - network_bypass_mode: Union[str, NetworkBypassMode] + highAvailability: HighAvailabilityProperties + networkBypassMode: Union[str, NetworkBypassMode] previewFeatures: list[Union[str, PreviewFeature]] - preview_features: list[Union[str, PreviewFeature]] - public_network_access: Union[str, PublicNetworkAccess] - server_version: str + publicNetworkAccess: Union[str, PublicNetworkAccess] + serverVersion: str sharding: ShardingProperties storage: StorageProperties @@ -2110,7 +2105,7 @@ namespace azure.mgmt.mongocluster.types id: str name: str properties: PrivateEndpointConnectionProperties - system_data: SystemData + systemData: SystemData type: str @@ -2119,10 +2114,9 @@ namespace azure.mgmt.mongocluster.types key "privateLinkServiceConnectionState": Required[PrivateLinkServiceConnectionState] key "provisioningState": Union[str, PrivateEndpointConnectionProvisioningState] groupIds: list[str] - group_ids: list[str] - private_endpoint: PrivateEndpoint - private_link_service_connection_state: PrivateLinkServiceConnectionState - provisioning_state: Union[str, PrivateEndpointConnectionProvisioningState] + privateEndpoint: PrivateEndpoint + privateLinkServiceConnectionState: PrivateLinkServiceConnectionState + provisioningState: Union[str, PrivateEndpointConnectionProvisioningState] class azure.mgmt.mongocluster.types.PrivateEndpointConnectionResource(ProxyResource): @@ -2134,7 +2128,7 @@ namespace azure.mgmt.mongocluster.types id: str name: str properties: PrivateEndpointConnectionProperties - system_data: SystemData + systemData: SystemData type: str @@ -2142,7 +2136,7 @@ namespace azure.mgmt.mongocluster.types key "actionsRequired": str key "description": str key "status": Union[str, PrivateEndpointServiceConnectionStatus] - actions_required: str + actionsRequired: str description: str status: Union[str, PrivateEndpointServiceConnectionStatus] @@ -2151,7 +2145,7 @@ namespace azure.mgmt.mongocluster.types key "mode": Union[str, PromoteMode] key "promoteOption": Required[Union[str, PromoteOption]] mode: Union[str, PromoteMode] - promote_option: Union[str, PromoteOption] + promoteOption: Union[str, PromoteOption] class azure.mgmt.mongocluster.types.ProxyResource(Resource): @@ -2161,7 +2155,7 @@ namespace azure.mgmt.mongocluster.types key "type": str id: str name: str - system_data: SystemData + systemData: SystemData type: str @@ -2169,9 +2163,9 @@ namespace azure.mgmt.mongocluster.types key "replicationState": Union[str, ReplicationState] key "role": Union[str, ReplicationRole] key "sourceResourceId": str - replication_state: Union[str, ReplicationState] + replicationState: Union[str, ReplicationState] role: Union[str, ReplicationRole] - source_resource_id: str + sourceResourceId: str class azure.mgmt.mongocluster.types.Resource(TypedDict, total=False): @@ -2181,19 +2175,19 @@ namespace azure.mgmt.mongocluster.types key "type": str id: str name: str - system_data: SystemData + systemData: SystemData type: str class azure.mgmt.mongocluster.types.ShardingProperties(TypedDict, total=False): key "shardCount": int - shard_count: int + shardCount: int class azure.mgmt.mongocluster.types.StorageProperties(TypedDict, total=False): key "sizeGb": int key "type": Union[str, StorageType] - size_gb: int + sizeGb: int type: Union[str, StorageType] @@ -2204,12 +2198,12 @@ namespace azure.mgmt.mongocluster.types key "lastModifiedAt": str key "lastModifiedBy": str key "lastModifiedByType": Union[str, CreatedByType] - created_at: str - created_by: str - created_by_type: Union[str, CreatedByType] - last_modified_at: str - last_modified_by: str - last_modified_by_type: Union[str, CreatedByType] + createdAt: str + createdBy: str + createdByType: Union[str, CreatedByType] + lastModifiedAt: str + lastModifiedBy: str + lastModifiedByType: Union[str, CreatedByType] class azure.mgmt.mongocluster.types.TrackedResource(Resource): @@ -2221,7 +2215,7 @@ namespace azure.mgmt.mongocluster.types id: str location: str name: str - system_data: SystemData + systemData: SystemData tags: dict[str, str] type: str @@ -2235,22 +2229,22 @@ namespace azure.mgmt.mongocluster.types id: str name: str properties: UserProperties - system_data: SystemData + systemData: SystemData type: str class azure.mgmt.mongocluster.types.UserAssignedIdentity(TypedDict, total=False): key "clientId": str key "principalId": str - client_id: str - principal_id: str + clientId: str + principalId: str class azure.mgmt.mongocluster.types.UserProperties(TypedDict, total=False): key "identityProvider": ForwardRef('IdentityProvider', module='types') key "provisioningState": Union[str, ProvisioningState] - identity_provider: IdentityProvider - provisioning_state: Union[str, ProvisioningState] + identityProvider: IdentityProvider + provisioningState: Union[str, ProvisioningState] roles: list[DatabaseRole] diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/api.metadata.yml b/sdk/mongocluster/azure-mgmt-mongocluster/api.metadata.yml index 8fffd01fddd4..0a1fb9e4f6c2 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/api.metadata.yml +++ b/sdk/mongocluster/azure-mgmt-mongocluster/api.metadata.yml @@ -1,3 +1,4 @@ -apiMdSha256: c794ca83080e97ad800a5db85ae5b9182cf022df8a9a931f5cfdffa542cf059e -parserVersion: 0.3.30 -pythonVersion: 3.13.14 +apiHash: 6785a1cd33c22ac04d3bd66161f454cdf550137c814e22e7febc0e7400464c41 +packageVersion: 1.3.0b2 +parserVersion: 0.3.31 +pythonVersion: 3.13.17 diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/apiview-properties.json b/sdk/mongocluster/azure-mgmt-mongocluster/apiview-properties.json index 4c54c748e8eb..2c21cf670659 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/apiview-properties.json +++ b/sdk/mongocluster/azure-mgmt-mongocluster/apiview-properties.json @@ -125,5 +125,5 @@ "azure.mgmt.mongocluster.operations.UsersOperations.list_by_mongo_cluster": "Microsoft.DocumentDB.Users.listByMongoCluster", "azure.mgmt.mongocluster.aio.operations.UsersOperations.list_by_mongo_cluster": "Microsoft.DocumentDB.Users.listByMongoCluster" }, - "CrossLanguageVersion": "f3be5e65cf0f" + "CrossLanguageVersion": "e9bf45293537" } \ No newline at end of file diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_client.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_client.py index 177ed861f3a0..c70b55b660a8 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_client.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_client.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -39,9 +40,9 @@ from azure.core.credentials import TokenCredential -class MongoClusterMgmtClient: # pylint: disable=too-many-instance-attributes +class MongoClusterMgmtClient: # pylint: disable=too-many-instance-attributes,docstring-keyword-should-match-keyword-only """The Microsoft Azure management API provides create, read, update, and delete functionality for - Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules. + Azure DocumentDB resources including clusters and firewall rules. :ivar operations: Operations operations :vartype operations: azure.mgmt.mongocluster.operations.Operations diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_configuration.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_configuration.py index b716204381d6..82e41046bbcf 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_configuration.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_configuration.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -18,7 +19,7 @@ from azure.core.credentials import TokenCredential -class MongoClusterMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes +class MongoClusterMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,docstring-keyword-should-match-keyword-only """Configuration for MongoClusterMgmtClient. Note that all parameters used to create this instance are saved as instance diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_patch.py index 87676c65a8f0..ea765788358a 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_patch.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_patch.py @@ -8,7 +8,6 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ - __all__: list[str] = [] # Add all objects you want publicly available to users at this package level diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_utils/model_base.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_utils/model_base.py index 0f2c5bdfe70f..35d5fc024978 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_utils/model_base.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_utils/model_base.py @@ -158,7 +158,15 @@ def _is_readonly(p): class SdkJSONEncoder(JSONEncoder): - """A JSON encoder that's capable of serializing datetime objects and bytes.""" + """A JSON encoder that's capable of serializing datetime objects and bytes. + + :param args: Additional positional arguments passed to the base ``JSONEncoder``. + :type args: typing.Any + :keyword exclude_readonly: Whether to exclude readonly properties. Defaults to False. + :paramtype exclude_readonly: bool + :keyword format: The format to use for serialization. Defaults to None. + :paramtype format: typing.Optional[str] + """ def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): super().__init__(*args, **kwargs) @@ -342,6 +350,12 @@ def _deserialize_int_as_str(attr): return int(attr) +def _deserialize_bool_as_str(attr): + if isinstance(attr, bool): + return attr + return attr.lower() == "true" + + _DESERIALIZE_MAPPING = { datetime: _deserialize_datetime, date: _deserialize_date, @@ -369,6 +383,8 @@ def _deserialize_int_as_str(attr): def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): if annotation is int and rf and rf._format == "str": return _deserialize_int_as_str + if annotation is bool and rf and rf._format == "str": + return _deserialize_bool_as_str if annotation is str and rf and rf._format in _ARRAY_ENCODE_MAPPING: return functools.partial(_deserialize_array_encoded, _ARRAY_ENCODE_MAPPING[rf._format]) if rf and rf._format: diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_utils/serialization.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_utils/serialization.py index 75906e2eb77f..ae08f9d89f74 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_utils/serialization.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_utils/serialization.py @@ -480,7 +480,11 @@ def _decode_attribute_map_key(key): class Serializer: # pylint: disable=too-many-public-methods - """Request object model serializer.""" + """Request object model serializer. + + :param classes: Mapping of model names to model types, used to resolve models during serialization. + :type classes: typing.Optional[typing.Mapping[str, type]] + """ basic_types = {str: "str", int: "int", bool: "bool", float: "float"} diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_version.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_version.py index 8b42750446d5..0a49e23debd3 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_version.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "1.3.0b1" +VERSION = "1.3.0b2" diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_client.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_client.py index 2b108734c05b..3e7d278de806 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_client.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_client.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -39,9 +40,9 @@ from azure.core.credentials_async import AsyncTokenCredential -class MongoClusterMgmtClient: # pylint: disable=too-many-instance-attributes +class MongoClusterMgmtClient: # pylint: disable=too-many-instance-attributes,docstring-keyword-should-match-keyword-only """The Microsoft Azure management API provides create, read, update, and delete functionality for - Azure Cosmos DB for MongoDB vCore resources including clusters and firewall rules. + Azure DocumentDB resources including clusters and firewall rules. :ivar operations: Operations operations :vartype operations: azure.mgmt.mongocluster.aio.operations.Operations diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_configuration.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_configuration.py index 3075689d5e27..b8dcdfc78521 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_configuration.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_configuration.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -18,7 +19,7 @@ from azure.core.credentials_async import AsyncTokenCredential -class MongoClusterMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes +class MongoClusterMgmtClientConfiguration: # pylint: disable=too-many-instance-attributes,docstring-keyword-should-match-keyword-only """Configuration for MongoClusterMgmtClient. Note that all parameters used to create this instance are saved as instance diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_patch.py index 87676c65a8f0..ea765788358a 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_patch.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/_patch.py @@ -8,7 +8,6 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ - __all__: list[str] = [] # Add all objects you want publicly available to users at this package level diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_operations.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_operations.py index 353a271488b5..c187fdce66b1 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_operations.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_operations.py @@ -70,7 +70,7 @@ List = list -class Operations: +class Operations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -180,7 +180,7 @@ async def get_next(next_link=None): return AsyncItemPaged(get_next, extract_data) -class MongoClustersOperations: +class MongoClustersOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -199,12 +199,12 @@ def __init__(self, *args, **kwargs) -> None: @distributed_trace_async async def get(self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any) -> _models.MongoCluster: - """Gets information about a mongo cluster. + """Gets information about a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: MongoCluster. The MongoCluster is compatible with MutableMapping :rtype: ~azure.mgmt.mongocluster.models.MongoCluster @@ -365,13 +365,13 @@ async def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.MongoCluster]: - """Create or update a mongo cluster. Update overwrites all properties for the resource. To only - modify some of the properties, use PATCH. + """Create or update a DocumentDB cluster. Update overwrites all properties for the resource. To + only modify some of the properties, use PATCH. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.models.MongoCluster @@ -394,13 +394,13 @@ async def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.MongoCluster]: - """Create or update a mongo cluster. Update overwrites all properties for the resource. To only - modify some of the properties, use PATCH. + """Create or update a DocumentDB cluster. Update overwrites all properties for the resource. To + only modify some of the properties, use PATCH. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.types.MongoCluster @@ -423,13 +423,13 @@ async def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.MongoCluster]: - """Create or update a mongo cluster. Update overwrites all properties for the resource. To only - modify some of the properties, use PATCH. + """Create or update a DocumentDB cluster. Update overwrites all properties for the resource. To + only modify some of the properties, use PATCH. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param resource: Resource create parameters. Required. :type resource: IO[bytes] @@ -464,13 +464,13 @@ async def begin_create_or_update( resource: Union[_models.MongoCluster, _types.MongoCluster, IO[bytes]], **kwargs: Any ) -> AsyncLROPoller[_models.MongoCluster]: - """Create or update a mongo cluster. Update overwrites all properties for the resource. To only - modify some of the properties, use PATCH. + """Create or update a DocumentDB cluster. Update overwrites all properties for the resource. To + only modify some of the properties, use PATCH. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param resource: Resource create parameters. Is either a MongoCluster type or a IO[bytes] type. Required. @@ -618,13 +618,13 @@ async def begin_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.MongoCluster]: - """Updates an existing mongo cluster. The request body can contain one to many of the properties - present in the normal mongo cluster definition. + """Updates an existing DocumentDB cluster. The request body can contain one to many of the + properties present in the normal DocumentDB cluster definition. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param properties: The resource properties to be updated. Required. :type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate @@ -647,13 +647,13 @@ async def begin_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.MongoCluster]: - """Updates an existing mongo cluster. The request body can contain one to many of the properties - present in the normal mongo cluster definition. + """Updates an existing DocumentDB cluster. The request body can contain one to many of the + properties present in the normal DocumentDB cluster definition. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param properties: The resource properties to be updated. Required. :type properties: ~azure.mgmt.mongocluster.types.MongoClusterUpdate @@ -676,13 +676,13 @@ async def begin_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.MongoCluster]: - """Updates an existing mongo cluster. The request body can contain one to many of the properties - present in the normal mongo cluster definition. + """Updates an existing DocumentDB cluster. The request body can contain one to many of the + properties present in the normal DocumentDB cluster definition. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param properties: The resource properties to be updated. Required. :type properties: IO[bytes] @@ -703,13 +703,13 @@ async def begin_update( properties: Union[_models.MongoClusterUpdate, _types.MongoClusterUpdate, IO[bytes]], **kwargs: Any ) -> AsyncLROPoller[_models.MongoCluster]: - """Updates an existing mongo cluster. The request body can contain one to many of the properties - present in the normal mongo cluster definition. + """Updates an existing DocumentDB cluster. The request body can contain one to many of the + properties present in the normal DocumentDB cluster definition. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param properties: The resource properties to be updated. Is either a MongoClusterUpdate type or a IO[bytes] type. Required. @@ -837,12 +837,12 @@ async def _delete_initial( async def begin_delete( self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any ) -> AsyncLROPoller[None]: - """Deletes a mongo cluster. + """Deletes a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An instance of AsyncLROPoller that returns None :rtype: ~azure.core.polling.AsyncLROPoller[None] @@ -894,7 +894,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- @distributed_trace def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> AsyncItemPaged["_models.MongoCluster"]: - """List all the mongo clusters in a given resource group. + """List all the DocumentDB clusters in a given resource group. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. @@ -991,7 +991,7 @@ async def get_next(next_link=None): @distributed_trace def list(self, **kwargs: Any) -> AsyncItemPaged["_models.MongoCluster"]: - """List all the mongo clusters in a given subscription. + """List all the DocumentDB clusters in a given subscription. :return: An iterator like instance of MongoCluster :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.MongoCluster] @@ -1086,13 +1086,13 @@ async def get_next(next_link=None): async def list_connection_strings( self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any ) -> _models.ListConnectionStringsResult: - """List mongo cluster connection strings. This includes the default connection string using + """List DocumentDB cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: ListConnectionStringsResult. The ListConnectionStringsResult is compatible with MutableMapping @@ -1165,7 +1165,7 @@ async def check_name_availability( content_type: str = "application/json", **kwargs: Any ) -> _models.CheckNameAvailabilityResponse: - """Check if mongo cluster name is available for use. + """Check if DocumentDB cluster name is available for use. :param location: The name of the Azure region. Required. :type location: str @@ -1189,7 +1189,7 @@ async def check_name_availability( content_type: str = "application/json", **kwargs: Any ) -> _models.CheckNameAvailabilityResponse: - """Check if mongo cluster name is available for use. + """Check if DocumentDB cluster name is available for use. :param location: The name of the Azure region. Required. :type location: str @@ -1208,7 +1208,7 @@ async def check_name_availability( async def check_name_availability( self, location: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.CheckNameAvailabilityResponse: - """Check if mongo cluster name is available for use. + """Check if DocumentDB cluster name is available for use. :param location: The name of the Azure region. Required. :type location: str @@ -1230,7 +1230,7 @@ async def check_name_availability( body: Union[_models.CheckNameAvailabilityRequest, _types.CheckNameAvailabilityRequest, IO[bytes]], **kwargs: Any ) -> _models.CheckNameAvailabilityResponse: - """Check if mongo cluster name is available for use. + """Check if DocumentDB cluster name is available for use. :param location: The name of the Azure region. Required. :type location: str @@ -1417,12 +1417,12 @@ async def begin_promote( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[None]: - """Promotes a replica mongo cluster to a primary role. + """Promotes a replica DocumentDB cluster to a primary role. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param body: The content of the action request. Required. :type body: ~azure.mgmt.mongocluster.models.PromoteReplicaRequest @@ -1444,12 +1444,12 @@ async def begin_promote( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[None]: - """Promotes a replica mongo cluster to a primary role. + """Promotes a replica DocumentDB cluster to a primary role. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param body: The content of the action request. Required. :type body: ~azure.mgmt.mongocluster.types.PromoteReplicaRequest @@ -1471,12 +1471,12 @@ async def begin_promote( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[None]: - """Promotes a replica mongo cluster to a primary role. + """Promotes a replica DocumentDB cluster to a primary role. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param body: The content of the action request. Required. :type body: IO[bytes] @@ -1520,12 +1520,12 @@ async def begin_promote( body: Union[_models.PromoteReplicaRequest, _types.PromoteReplicaRequest, IO[bytes]], **kwargs: Any ) -> AsyncLROPoller[None]: - """Promotes a replica mongo cluster to a primary role. + """Promotes a replica DocumentDB cluster to a primary role. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param body: The content of the action request. Is either a PromoteReplicaRequest type or a IO[bytes] type. Required. @@ -1583,7 +1583,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore -class FirewallRulesOperations: +class FirewallRulesOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -1604,14 +1604,14 @@ def __init__(self, *args, **kwargs) -> None: async def get( self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any ) -> _models.FirewallRule: - """Gets information about a mongo cluster firewall rule. + """Gets information about a DocumentDB cluster firewall rule. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :return: FirewallRule. The FirewallRule is compatible with MutableMapping :rtype: ~azure.mgmt.mongocluster.models.FirewallRule @@ -1763,14 +1763,14 @@ async def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.FirewallRule]: - """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + """Creates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.models.FirewallRule @@ -1794,14 +1794,14 @@ async def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.FirewallRule]: - """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + """Creates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.types.FirewallRule @@ -1825,14 +1825,14 @@ async def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.FirewallRule]: - """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + """Creates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :param resource: Resource create parameters. Required. :type resource: IO[bytes] @@ -1854,14 +1854,14 @@ async def begin_create_or_update( resource: Union[_models.FirewallRule, _types.FirewallRule, IO[bytes]], **kwargs: Any ) -> AsyncLROPoller[_models.FirewallRule]: - """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + """Creates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :param resource: Resource create parameters. Is either a FirewallRule type or a IO[bytes] type. Required. @@ -1991,14 +1991,14 @@ async def _delete_initial( async def begin_delete( self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any ) -> AsyncLROPoller[None]: - """Deletes a mongo cluster firewall rule. + """Deletes a DocumentDB cluster firewall rule. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :return: An instance of AsyncLROPoller that returns None :rtype: ~azure.core.polling.AsyncLROPoller[None] @@ -2053,12 +2053,12 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- def list_by_mongo_cluster( self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any ) -> AsyncItemPaged["_models.FirewallRule"]: - """List all the firewall rules in a given mongo cluster. + """List all the firewall rules in a given DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of FirewallRule :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.FirewallRule] @@ -2152,7 +2152,7 @@ async def get_next(next_link=None): return AsyncItemPaged(get_next, extract_data) -class PrivateEndpointConnectionsOperations: +class PrivateEndpointConnectionsOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -2178,7 +2178,7 @@ def list_by_mongo_cluster( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of PrivateEndpointConnectionResource :rtype: @@ -2281,7 +2281,7 @@ async def get( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -2442,7 +2442,7 @@ async def begin_create( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -2475,7 +2475,7 @@ async def begin_create( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -2508,7 +2508,7 @@ async def begin_create( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -2539,7 +2539,7 @@ async def begin_create( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -2682,7 +2682,7 @@ async def begin_delete( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -2737,7 +2737,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- return AsyncLROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore -class PrivateLinksOperations: +class PrivateLinksOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -2763,7 +2763,7 @@ def list_by_mongo_cluster( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of PrivateLinkResource :rtype: @@ -2858,7 +2858,7 @@ async def get_next(next_link=None): return AsyncItemPaged(get_next, extract_data) -class ReplicasOperations: +class ReplicasOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -2903,12 +2903,12 @@ def __init__(self, *args, **kwargs) -> None: def list_by_parent( self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any ) -> AsyncItemPaged["_models.Replica"]: - """List all the replicas for the mongo cluster. + """List all the replicas for the DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of Replica :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.Replica] @@ -3002,7 +3002,7 @@ async def get_next(next_link=None): return AsyncItemPaged(get_next, extract_data) -class UsersOperations: +class UsersOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -3045,14 +3045,14 @@ def __init__(self, *args, **kwargs) -> None: async def get( self, resource_group_name: str, mongo_cluster_name: str, user_name: str, **kwargs: Any ) -> _models.User: - """Gets the defintion of a Mongo cluster user. + """Gets the defintion of a DocumentDB cluster user. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :return: User. The User is compatible with MutableMapping :rtype: ~azure.mgmt.mongocluster.models.User @@ -3226,14 +3226,14 @@ async def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.User]: - """Creates a new user or updates an existing user on a mongo cluster. + """Creates a new user or updates an existing user on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.models.User @@ -3257,14 +3257,14 @@ async def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.User]: - """Creates a new user or updates an existing user on a mongo cluster. + """Creates a new user or updates an existing user on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.types.User @@ -3288,14 +3288,14 @@ async def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> AsyncLROPoller[_models.User]: - """Creates a new user or updates an existing user on a mongo cluster. + """Creates a new user or updates an existing user on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :param resource: Resource create parameters. Required. :type resource: IO[bytes] @@ -3340,14 +3340,14 @@ async def begin_create_or_update( resource: Union[_models.User, _types.User, IO[bytes]], **kwargs: Any ) -> AsyncLROPoller[_models.User]: - """Creates a new user or updates an existing user on a mongo cluster. + """Creates a new user or updates an existing user on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :param resource: Resource create parameters. Is either a User type or a IO[bytes] type. Required. @@ -3519,14 +3519,14 @@ async def _delete_initial( async def begin_delete( self, resource_group_name: str, mongo_cluster_name: str, user_name: str, **kwargs: Any ) -> AsyncLROPoller[None]: - """Deletes a mongo cluster user. + """Deletes a DocumentDB cluster user. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :return: An instance of AsyncLROPoller that returns None :rtype: ~azure.core.polling.AsyncLROPoller[None] @@ -3602,12 +3602,12 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- def list_by_mongo_cluster( self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any ) -> AsyncItemPaged["_models.User"]: - """List all the users on a mongo cluster. + """List all the users on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of User :rtype: ~azure.core.async_paging.AsyncItemPaged[~azure.mgmt.mongocluster.models.User] diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_patch.py index 87676c65a8f0..ea765788358a 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_patch.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/aio/operations/_patch.py @@ -8,7 +8,6 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ - __all__: list[str] = [] # Add all objects you want publicly available to users at this package level diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_enums.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_enums.py index 31b946323e83..2397217852cc 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_enums.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_enums.py @@ -11,7 +11,7 @@ class ActionType(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal + """Extensible enum. Indicates the action type. \"Internal\" refers to actions that are for internal only APIs. """ @@ -20,7 +20,7 @@ class ActionType(str, Enum, metaclass=CaseInsensitiveEnumMeta): class AuthenticationMode(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The authentication modes supporting on the Mongo cluster.""" + """The authentication modes supporting on the DocumentDB cluster.""" NATIVE_AUTH = "NativeAuth" """Native mongo authentication mode using username and password with auth mechanism @@ -53,12 +53,12 @@ class CreatedByType(str, Enum, metaclass=CaseInsensitiveEnumMeta): class CreateMode(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The mode that the Mongo Cluster is created with.""" + """The mode that the DocumentDB cluster is created with.""" DEFAULT = "Default" - """Create a new mongo cluster.""" + """Create a new DocumentDB cluster.""" POINT_IN_TIME_RESTORE = "PointInTimeRestore" - """Create a mongo cluster from a restore point-in-time.""" + """Create a DocumentDB cluster from a restore point-in-time.""" GEO_REPLICA = "GeoReplica" """Create a replica cluster in distinct geographic region from the source cluster.""" REPLICA = "Replica" @@ -127,36 +127,36 @@ class ManagedServiceIdentityType(str, Enum, metaclass=CaseInsensitiveEnumMeta): class MongoClusterStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The status of the Mongo cluster resource.""" + """The status of the DocumentDB cluster resource.""" READY = "Ready" - """The mongo cluster resource is ready for use.""" + """The DocumentDB cluster resource is ready for use.""" PROVISIONING = "Provisioning" - """The mongo cluster resource is being provisioned.""" + """The DocumentDB cluster resource is being provisioned.""" UPDATING = "Updating" - """The mongo cluster resource is being updated.""" + """The DocumentDB cluster resource is being updated.""" STARTING = "Starting" - """The mongo cluster resource is being started.""" + """The DocumentDB cluster resource is being started.""" STOPPING = "Stopping" - """The mongo cluster resource is being stopped.""" + """The DocumentDB cluster resource is being stopped.""" STOPPED = "Stopped" - """The mongo cluster resource is stopped.""" + """The DocumentDB cluster resource is stopped.""" DROPPING = "Dropping" - """The mongo cluster resource is being dropped.""" + """The DocumentDB cluster resource is being dropped.""" class NetworkBypassMode(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The network bypass mode for the Mongo cluster.""" + """The network bypass mode for the DocumentDB cluster.""" NONE = "None" """No network bypass is enabled.""" AZURE_COSMOS_DB = "AzureCosmosDB" - """Allows Azure Cosmos DB service to bypass network restrictions.""" + """Allows the Azure Cosmos DB service to bypass network restrictions.""" class Origin(str, Enum, metaclass=CaseInsensitiveEnumMeta): """The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit - logs UX. Default value is "user,system". + logs UX. Default value is \"user,system\". """ USER = "user" @@ -168,7 +168,7 @@ class Origin(str, Enum, metaclass=CaseInsensitiveEnumMeta): class PreviewFeature(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Preview features that can be enabled on a mongo cluster.""" + """Preview features that can be enabled on a DocumentDB cluster.""" GEO_REPLICAS = "GeoReplicas" """Enables geo replicas preview feature. The feature must be set at create-time on new cluster to @@ -239,18 +239,18 @@ class ProvisioningState(str, Enum, metaclass=CaseInsensitiveEnumMeta): class PublicNetworkAccess(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Whether or not public endpoint access is allowed for this Mongo cluster. Value is optional and - default value is 'Enabled'. + """Whether or not public endpoint access is allowed for this DocumentDB cluster. Value is + optional and default value is 'Enabled'. """ ENABLED = "Enabled" - """If set, mongo cluster can be accessed through private and public methods.""" + """If set, DocumentDB cluster can be accessed through private and public methods.""" DISABLED = "Disabled" """If set, the private endpoints are the exclusive access method.""" class ReplicationRole(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Replication role of the mongo cluster.""" + """Replication role of the DocumentDB cluster.""" PRIMARY = "Primary" """The cluster is a primary replica.""" @@ -279,13 +279,12 @@ class ReplicationState(str, Enum, metaclass=CaseInsensitiveEnumMeta): class StorageType(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The type of storage that a mongo cluster can be provisioned with.""" + """The type of storage that a DocumentDB cluster can be provisioned with.""" PREMIUM_SSD = "PremiumSSD" - """Premium SSD for high performance workloads.""" + """Premium SSD storage. Premium SSD v2 is recommended for better performance.""" PREMIUM_SS_DV2 = "PremiumSSDv2" - """Premium SSD v2 for very IO-intensive workloads. This is a preview option and has additional - limitations.""" + """Premium SSD v2 storage. Recommended for better performance.""" class UserRole(str, Enum, metaclass=CaseInsensitiveEnumMeta): diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_models.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_models.py index 7e80cfea7677..86d8aba822d8 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_models.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_models.py @@ -18,7 +18,7 @@ from .. import models as _models -class AdministratorProperties(_Model): +class AdministratorProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The local administrator login properties. :ivar user_name: The administrator user name. @@ -51,8 +51,8 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class AuthConfigProperties(_Model): - """The authentication configuration for the Mongo cluster. +class AuthConfigProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """The authentication configuration for the DocumentDB cluster. :ivar allowed_modes: Allowed authentication modes for data access on the cluster. :vartype allowed_modes: list[str or ~azure.mgmt.mongocluster.models.AuthenticationMode] @@ -93,7 +93,7 @@ class BackupProperties(_Model): """Earliest restore timestamp in UTC ISO8601 format.""" -class CheckNameAvailabilityRequest(_Model): +class CheckNameAvailabilityRequest(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The check availability request body. :ivar name: The name of the resource for which availability needs to be checked. @@ -126,7 +126,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class CheckNameAvailabilityResponse(_Model): +class CheckNameAvailabilityResponse(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The check availability result. :ivar name_available: Indicates if the resource name is available. @@ -170,7 +170,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ComputeProperties(_Model): +class ComputeProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The compute properties of the cluster. This includes the virtual-cores/memory and scaling options applied to servers in the cluster. @@ -202,7 +202,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: class ConnectionString(_Model): - """Connection string for the mongo cluster. + """Connection string for the DocumentDB cluster. :ivar connection_string: Value of the connection string. :vartype connection_string: str @@ -220,7 +220,7 @@ class ConnectionString(_Model): """Name of the connection string.""" -class CustomerManagedKeyEncryptionProperties(_Model): +class CustomerManagedKeyEncryptionProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Customer managed key encryption settings. :ivar key_encryption_key_identity: The identity used to access the key encryption key. @@ -257,7 +257,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class DataApiProperties(_Model): +class DataApiProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Data API properties. :ivar mode: The mode to indicate whether the Mongo Data API is enabled for a cluster. Known @@ -289,7 +289,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class DatabaseRole(_Model): +class DatabaseRole(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Database role definition that is assigned to a user. :ivar db: Database scope that the role is assigned to. Required. @@ -322,8 +322,8 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class EncryptionProperties(_Model): - """The encryption configuration for the mongo cluster. +class EncryptionProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """The encryption configuration for the DocumentDB cluster. :ivar customer_managed_key_encryption: Customer managed key encryption settings. :vartype customer_managed_key_encryption: @@ -353,7 +353,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class IdentityProvider(_Model): +class IdentityProvider(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Defines a user's identity provider definition. You probably want to use the sub-classes and not this class directly. Known sub-classes are: @@ -386,7 +386,9 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class EntraIdentityProvider(IdentityProvider, discriminator="MicrosoftEntraID"): +class EntraIdentityProvider( + IdentityProvider, discriminator="MicrosoftEntraID" +): # pylint: disable=docstring-keyword-should-match-keyword-only """Defines a Microsoft Entra ID Mongo user. :ivar type: The type of identity provider that the user belongs to. Required. Microsoft Entra @@ -422,7 +424,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: self.type = IdentityProviderType.MICROSOFT_ENTRA_ID # type: ignore -class EntraIdentityProviderProperties(_Model): +class EntraIdentityProviderProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Microsoft Entra ID provider properties. :ivar principal_type: The principal type of the user. Required. Known values are: "user" and @@ -497,7 +499,7 @@ class ErrorDetail(_Model): """The error additional info.""" -class ErrorResponse(_Model): +class ErrorResponse(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Error response. :ivar error: The error object. @@ -570,8 +572,8 @@ class ProxyResource(Resource): """ -class FirewallRule(ProxyResource): - """Represents a mongo cluster firewall rule. +class FirewallRule(ProxyResource): # pylint: disable=docstring-keyword-should-match-keyword-only + """Represents a DocumentDB cluster firewall rule. :ivar id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. @@ -611,16 +613,16 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class FirewallRuleProperties(_Model): - """The properties of a mongo cluster firewall rule. +class FirewallRuleProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """The properties of a DocumentDB cluster firewall rule. :ivar provisioning_state: The provisioning state of the firewall rule. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". :vartype provisioning_state: str or ~azure.mgmt.mongocluster.models.ProvisioningState - :ivar start_ip_address: The start IP address of the mongo cluster firewall rule. Must be IPv4 - format. Required. + :ivar start_ip_address: The start IP address of the DocumentDB cluster firewall rule. Must be + IPv4 format. Required. :vartype start_ip_address: str - :ivar end_ip_address: The end IP address of the mongo cluster firewall rule. Must be IPv4 + :ivar end_ip_address: The end IP address of the DocumentDB cluster firewall rule. Must be IPv4 format. Required. :vartype end_ip_address: str """ @@ -633,9 +635,9 @@ class FirewallRuleProperties(_Model): start_ip_address: str = rest_field( name="startIpAddress", visibility=["read", "create", "update", "delete", "query"] ) - """The start IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.""" + """The start IP address of the DocumentDB cluster firewall rule. Must be IPv4 format. Required.""" end_ip_address: str = rest_field(name="endIpAddress", visibility=["read", "create", "update", "delete", "query"]) - """The end IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.""" + """The end IP address of the DocumentDB cluster firewall rule. Must be IPv4 format. Required.""" @overload def __init__( @@ -656,7 +658,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class HighAvailabilityProperties(_Model): +class HighAvailabilityProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The high availability properties of the cluster. :ivar target_mode: The target high availability mode requested for the cluster. Known values @@ -688,7 +690,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class KeyEncryptionKeyIdentity(_Model): +class KeyEncryptionKeyIdentity(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The identity used for key encryption key. :ivar identity_type: The type of identity. Only 'UserAssignedIdentity' is supported. @@ -727,19 +729,20 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: class ListConnectionStringsResult(_Model): - """The connection strings for the given mongo cluster. + """The connection strings for the given DocumentDB cluster. - :ivar connection_strings: An array that contains the connection strings for a mongo cluster. + :ivar connection_strings: An array that contains the connection strings for a DocumentDB + cluster. :vartype connection_strings: list[~azure.mgmt.mongocluster.models.ConnectionString] """ connection_strings: Optional[list["_models.ConnectionString"]] = rest_field( name="connectionStrings", visibility=["read"] ) - """An array that contains the connection strings for a mongo cluster.""" + """An array that contains the connection strings for a DocumentDB cluster.""" -class ManagedServiceIdentity(_Model): +class ManagedServiceIdentity(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Managed service identity (system assigned and/or user assigned identities). :ivar principal_id: The service principal ID of the system assigned identity. This property @@ -791,7 +794,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TrackedResource(Resource): +class TrackedResource(Resource): # pylint: disable=docstring-keyword-should-match-keyword-only """Tracked Resource. :ivar id: Fully qualified resource ID for the resource. Ex - @@ -835,8 +838,8 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class MongoCluster(TrackedResource): - """Represents a mongo cluster resource. +class MongoCluster(TrackedResource): # pylint: disable=docstring-keyword-should-match-keyword-only + """Represents a DocumentDB cluster resource. :ivar id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. @@ -889,50 +892,50 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class MongoClusterProperties(_Model): - """The properties of a mongo cluster. +class MongoClusterProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only + """The properties of a DocumentDB cluster. - :ivar create_mode: The mode to create a mongo cluster. Known values are: "Default", + :ivar create_mode: The mode to create a DocumentDB cluster. Known values are: "Default", "PointInTimeRestore", "GeoReplica", and "Replica". :vartype create_mode: str or ~azure.mgmt.mongocluster.models.CreateMode - :ivar restore_parameters: The parameters to create a point-in-time restore mongo cluster. + :ivar restore_parameters: The parameters to create a point-in-time restore DocumentDB cluster. :vartype restore_parameters: ~azure.mgmt.mongocluster.models.MongoClusterRestoreParameters - :ivar replica_parameters: The parameters to create a replica mongo cluster. + :ivar replica_parameters: The parameters to create a replica DocumentDB cluster. :vartype replica_parameters: ~azure.mgmt.mongocluster.models.MongoClusterReplicaParameters - :ivar administrator: The local administrator properties for the mongo cluster. + :ivar administrator: The local administrator properties for the DocumentDB cluster. :vartype administrator: ~azure.mgmt.mongocluster.models.AdministratorProperties :ivar server_version: The Mongo DB server version. Defaults to the latest available version if not specified. :vartype server_version: str :ivar connection_string: The default mongo connection string for the cluster. :vartype connection_string: str - :ivar provisioning_state: The provisioning state of the mongo cluster. Known values are: + :ivar provisioning_state: The provisioning state of the DocumentDB cluster. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". :vartype provisioning_state: str or ~azure.mgmt.mongocluster.models.ProvisioningState - :ivar cluster_status: The status of the mongo cluster. Known values are: "Ready", + :ivar cluster_status: The status of the DocumentDB cluster. Known values are: "Ready", "Provisioning", "Updating", "Starting", "Stopping", "Stopped", and "Dropping". :vartype cluster_status: str or ~azure.mgmt.mongocluster.models.MongoClusterStatus - :ivar public_network_access: Whether or not public endpoint access is allowed for this mongo - cluster. Known values are: "Enabled" and "Disabled". + :ivar public_network_access: Whether or not public endpoint access is allowed for this + DocumentDB cluster. Known values are: "Enabled" and "Disabled". :vartype public_network_access: str or ~azure.mgmt.mongocluster.models.PublicNetworkAccess - :ivar high_availability: The high availability properties of the mongo cluster. + :ivar high_availability: The high availability properties of the DocumentDB cluster. :vartype high_availability: ~azure.mgmt.mongocluster.models.HighAvailabilityProperties - :ivar storage: The storage properties of the mongo cluster. + :ivar storage: The storage properties of the DocumentDB cluster. :vartype storage: ~azure.mgmt.mongocluster.models.StorageProperties - :ivar sharding: The sharding properties of the mongo cluster. + :ivar sharding: The sharding properties of the DocumentDB cluster. :vartype sharding: ~azure.mgmt.mongocluster.models.ShardingProperties - :ivar compute: The compute properties of the mongo cluster. + :ivar compute: The compute properties of the DocumentDB cluster. :vartype compute: ~azure.mgmt.mongocluster.models.ComputeProperties - :ivar backup: The backup properties of the mongo cluster. + :ivar backup: The backup properties of the DocumentDB cluster. :vartype backup: ~azure.mgmt.mongocluster.models.BackupProperties - :ivar data_api: The Data API properties of the mongo cluster. + :ivar data_api: The Data API properties of the DocumentDB cluster. :vartype data_api: ~azure.mgmt.mongocluster.models.DataApiProperties :ivar private_endpoint_connections: List of private endpoint connections. :vartype private_endpoint_connections: list[~azure.mgmt.mongocluster.models.PrivateEndpointConnection] :ivar preview_features: List of private endpoint connections. :vartype preview_features: list[str or ~azure.mgmt.mongocluster.models.PreviewFeature] - :ivar replica: The replication properties for the mongo cluster. + :ivar replica: The replication properties for the DocumentDB cluster. :vartype replica: ~azure.mgmt.mongocluster.models.ReplicationProperties :ivar infrastructure_version: The infrastructure version the cluster is provisioned on. :vartype infrastructure_version: str @@ -942,7 +945,7 @@ class MongoClusterProperties(_Model): configured. :vartype encryption: ~azure.mgmt.mongocluster.models.EncryptionProperties :ivar network_bypass_mode: The network bypass mode for the cluster. Setting to 'AzureCosmosDB' - allows Azure Cosmos DB service to bypass network restrictions. Known values are: "None" and + allows the Azure Cosmos DB service to bypass network restrictions. Known values are: "None" and "AzureCosmosDB". :vartype network_bypass_mode: str or ~azure.mgmt.mongocluster.models.NetworkBypassMode """ @@ -950,20 +953,20 @@ class MongoClusterProperties(_Model): create_mode: Optional[Union[str, "_models.CreateMode"]] = rest_field( name="createMode", visibility=["read", "create"] ) - """The mode to create a mongo cluster. Known values are: \"Default\", \"PointInTimeRestore\", + """The mode to create a DocumentDB cluster. Known values are: \"Default\", \"PointInTimeRestore\", \"GeoReplica\", and \"Replica\".""" restore_parameters: Optional["_models.MongoClusterRestoreParameters"] = rest_field( name="restoreParameters", visibility=["read", "create"] ) - """The parameters to create a point-in-time restore mongo cluster.""" + """The parameters to create a point-in-time restore DocumentDB cluster.""" replica_parameters: Optional["_models.MongoClusterReplicaParameters"] = rest_field( name="replicaParameters", visibility=["read", "create"] ) - """The parameters to create a replica mongo cluster.""" + """The parameters to create a replica DocumentDB cluster.""" administrator: Optional["_models.AdministratorProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The local administrator properties for the mongo cluster.""" + """The local administrator properties for the DocumentDB cluster.""" server_version: Optional[str] = rest_field( name="serverVersion", visibility=["read", "create", "update", "delete", "query"] ) @@ -973,42 +976,42 @@ class MongoClusterProperties(_Model): provisioning_state: Optional[Union[str, "_models.ProvisioningState"]] = rest_field( name="provisioningState", visibility=["read"] ) - """The provisioning state of the mongo cluster. Known values are: \"Succeeded\", \"Failed\", + """The provisioning state of the DocumentDB cluster. Known values are: \"Succeeded\", \"Failed\", \"Canceled\", \"InProgress\", \"Updating\", and \"Dropping\".""" cluster_status: Optional[Union[str, "_models.MongoClusterStatus"]] = rest_field( name="clusterStatus", visibility=["read"] ) - """The status of the mongo cluster. Known values are: \"Ready\", \"Provisioning\", \"Updating\", - \"Starting\", \"Stopping\", \"Stopped\", and \"Dropping\".""" + """The status of the DocumentDB cluster. Known values are: \"Ready\", \"Provisioning\", + \"Updating\", \"Starting\", \"Stopping\", \"Stopped\", and \"Dropping\".""" public_network_access: Optional[Union[str, "_models.PublicNetworkAccess"]] = rest_field( name="publicNetworkAccess", visibility=["read", "create", "update", "delete", "query"] ) - """Whether or not public endpoint access is allowed for this mongo cluster. Known values are: + """Whether or not public endpoint access is allowed for this DocumentDB cluster. Known values are: \"Enabled\" and \"Disabled\".""" high_availability: Optional["_models.HighAvailabilityProperties"] = rest_field( name="highAvailability", visibility=["read", "create", "update", "delete", "query"] ) - """The high availability properties of the mongo cluster.""" + """The high availability properties of the DocumentDB cluster.""" storage: Optional["_models.StorageProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The storage properties of the mongo cluster.""" + """The storage properties of the DocumentDB cluster.""" sharding: Optional["_models.ShardingProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The sharding properties of the mongo cluster.""" + """The sharding properties of the DocumentDB cluster.""" compute: Optional["_models.ComputeProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The compute properties of the mongo cluster.""" + """The compute properties of the DocumentDB cluster.""" backup: Optional["_models.BackupProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The backup properties of the mongo cluster.""" + """The backup properties of the DocumentDB cluster.""" data_api: Optional["_models.DataApiProperties"] = rest_field( name="dataApi", visibility=["read", "create", "update", "delete", "query"] ) - """The Data API properties of the mongo cluster.""" + """The Data API properties of the DocumentDB cluster.""" private_endpoint_connections: Optional[list["_models.PrivateEndpointConnection"]] = rest_field( name="privateEndpointConnections", visibility=["read"] ) @@ -1018,7 +1021,7 @@ class MongoClusterProperties(_Model): ) """List of private endpoint connections.""" replica: Optional["_models.ReplicationProperties"] = rest_field(visibility=["read"]) - """The replication properties for the mongo cluster.""" + """The replication properties for the DocumentDB cluster.""" infrastructure_version: Optional[str] = rest_field(name="infrastructureVersion", visibility=["read"]) """The infrastructure version the cluster is provisioned on.""" auth_config: Optional["_models.AuthConfigProperties"] = rest_field( @@ -1032,7 +1035,7 @@ class MongoClusterProperties(_Model): network_bypass_mode: Optional[Union[str, "_models.NetworkBypassMode"]] = rest_field( name="networkBypassMode", visibility=["read", "create", "update", "delete", "query"] ) - """The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows Azure Cosmos DB + """The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows the Azure Cosmos DB service to bypass network restrictions. Known values are: \"None\" and \"AzureCosmosDB\".""" @overload @@ -1068,7 +1071,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class MongoClusterReplicaParameters(_Model): +class MongoClusterReplicaParameters(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Parameters used for replica operations. :ivar source_resource_id: The id of the replication source cluster. Required. @@ -1103,10 +1106,10 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class MongoClusterRestoreParameters(_Model): +class MongoClusterRestoreParameters(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Parameters used for restore operations. - :ivar point_in_time_utc: UTC point in time to restore a mongo cluster. + :ivar point_in_time_utc: UTC point in time to restore a DocumentDB cluster. :vartype point_in_time_utc: ~datetime.datetime :ivar source_resource_id: Resource ID to locate the source cluster to restore. :vartype source_resource_id: str @@ -1115,7 +1118,7 @@ class MongoClusterRestoreParameters(_Model): point_in_time_utc: Optional[datetime.datetime] = rest_field( name="pointInTimeUTC", visibility=["read", "create", "update", "delete", "query"], format="rfc3339" ) - """UTC point in time to restore a mongo cluster.""" + """UTC point in time to restore a DocumentDB cluster.""" source_resource_id: Optional[str] = rest_field( name="sourceResourceId", visibility=["read", "create", "update", "delete", "query"] ) @@ -1140,7 +1143,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class MongoClusterUpdate(_Model): +class MongoClusterUpdate(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The type used for update operations of the MongoCluster. :ivar identity: The managed service identities assigned to this resource. @@ -1182,28 +1185,28 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class MongoClusterUpdateProperties(_Model): +class MongoClusterUpdateProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The updatable properties of the MongoCluster. - :ivar administrator: The local administrator properties for the mongo cluster. + :ivar administrator: The local administrator properties for the DocumentDB cluster. :vartype administrator: ~azure.mgmt.mongocluster.models.AdministratorProperties :ivar server_version: The Mongo DB server version. Defaults to the latest available version if not specified. :vartype server_version: str - :ivar public_network_access: Whether or not public endpoint access is allowed for this mongo - cluster. Known values are: "Enabled" and "Disabled". + :ivar public_network_access: Whether or not public endpoint access is allowed for this + DocumentDB cluster. Known values are: "Enabled" and "Disabled". :vartype public_network_access: str or ~azure.mgmt.mongocluster.models.PublicNetworkAccess - :ivar high_availability: The high availability properties of the mongo cluster. + :ivar high_availability: The high availability properties of the DocumentDB cluster. :vartype high_availability: ~azure.mgmt.mongocluster.models.HighAvailabilityProperties - :ivar storage: The storage properties of the mongo cluster. + :ivar storage: The storage properties of the DocumentDB cluster. :vartype storage: ~azure.mgmt.mongocluster.models.StorageProperties - :ivar sharding: The sharding properties of the mongo cluster. + :ivar sharding: The sharding properties of the DocumentDB cluster. :vartype sharding: ~azure.mgmt.mongocluster.models.ShardingProperties - :ivar compute: The compute properties of the mongo cluster. + :ivar compute: The compute properties of the DocumentDB cluster. :vartype compute: ~azure.mgmt.mongocluster.models.ComputeProperties - :ivar backup: The backup properties of the mongo cluster. + :ivar backup: The backup properties of the DocumentDB cluster. :vartype backup: ~azure.mgmt.mongocluster.models.BackupProperties - :ivar data_api: The Data API properties of the mongo cluster. + :ivar data_api: The Data API properties of the DocumentDB cluster. :vartype data_api: ~azure.mgmt.mongocluster.models.DataApiProperties :ivar preview_features: List of private endpoint connections. :vartype preview_features: list[str or ~azure.mgmt.mongocluster.models.PreviewFeature] @@ -1213,7 +1216,7 @@ class MongoClusterUpdateProperties(_Model): configured. :vartype encryption: ~azure.mgmt.mongocluster.models.EncryptionProperties :ivar network_bypass_mode: The network bypass mode for the cluster. Setting to 'AzureCosmosDB' - allows Azure Cosmos DB service to bypass network restrictions. Known values are: "None" and + allows the Azure Cosmos DB service to bypass network restrictions. Known values are: "None" and "AzureCosmosDB". :vartype network_bypass_mode: str or ~azure.mgmt.mongocluster.models.NetworkBypassMode """ @@ -1221,7 +1224,7 @@ class MongoClusterUpdateProperties(_Model): administrator: Optional["_models.AdministratorProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The local administrator properties for the mongo cluster.""" + """The local administrator properties for the DocumentDB cluster.""" server_version: Optional[str] = rest_field( name="serverVersion", visibility=["read", "create", "update", "delete", "query"] ) @@ -1229,32 +1232,32 @@ class MongoClusterUpdateProperties(_Model): public_network_access: Optional[Union[str, "_models.PublicNetworkAccess"]] = rest_field( name="publicNetworkAccess", visibility=["read", "create", "update", "delete", "query"] ) - """Whether or not public endpoint access is allowed for this mongo cluster. Known values are: + """Whether or not public endpoint access is allowed for this DocumentDB cluster. Known values are: \"Enabled\" and \"Disabled\".""" high_availability: Optional["_models.HighAvailabilityProperties"] = rest_field( name="highAvailability", visibility=["read", "create", "update", "delete", "query"] ) - """The high availability properties of the mongo cluster.""" + """The high availability properties of the DocumentDB cluster.""" storage: Optional["_models.StorageProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The storage properties of the mongo cluster.""" + """The storage properties of the DocumentDB cluster.""" sharding: Optional["_models.ShardingProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The sharding properties of the mongo cluster.""" + """The sharding properties of the DocumentDB cluster.""" compute: Optional["_models.ComputeProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The compute properties of the mongo cluster.""" + """The compute properties of the DocumentDB cluster.""" backup: Optional["_models.BackupProperties"] = rest_field( visibility=["read", "create", "update", "delete", "query"] ) - """The backup properties of the mongo cluster.""" + """The backup properties of the DocumentDB cluster.""" data_api: Optional["_models.DataApiProperties"] = rest_field( name="dataApi", visibility=["read", "create", "update", "delete", "query"] ) - """The Data API properties of the mongo cluster.""" + """The Data API properties of the DocumentDB cluster.""" preview_features: Optional[list[Union[str, "_models.PreviewFeature"]]] = rest_field( name="previewFeatures", visibility=["read", "create", "update", "delete", "query"] ) @@ -1270,7 +1273,7 @@ class MongoClusterUpdateProperties(_Model): network_bypass_mode: Optional[Union[str, "_models.NetworkBypassMode"]] = rest_field( name="networkBypassMode", visibility=["read", "create", "update", "delete", "query"] ) - """The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows Azure Cosmos DB + """The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows the Azure Cosmos DB service to bypass network restrictions. Known values are: \"None\" and \"AzureCosmosDB\".""" @overload @@ -1303,7 +1306,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class Operation(_Model): +class Operation(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """REST API Operation. :ivar name: The name of the operation, as per Resource-Based Access Control (RBAC). Examples: @@ -1402,7 +1405,7 @@ class PrivateEndpoint(_Model): """The resource identifier of the private endpoint.""" -class PrivateEndpointConnection(Resource): +class PrivateEndpointConnection(Resource): # pylint: disable=docstring-keyword-should-match-keyword-only """The private endpoint connection resource. :ivar id: Fully qualified resource ID for the resource. Ex - @@ -1443,7 +1446,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class PrivateEndpointConnectionProperties(_Model): +class PrivateEndpointConnectionProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Properties of the private endpoint connection. :ivar group_ids: The group ids for the private endpoint resource. @@ -1496,7 +1499,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class PrivateEndpointConnectionResource(ProxyResource): +class PrivateEndpointConnectionResource(ProxyResource): # pylint: disable=docstring-keyword-should-match-keyword-only """Concrete proxy resource types can be created by aliasing this type using a specific property type. @@ -1538,7 +1541,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class PrivateLinkResource(ProxyResource): +class PrivateLinkResource(ProxyResource): # pylint: disable=docstring-keyword-should-match-keyword-only """Concrete proxy resource types can be created by aliasing this type using a specific property type. @@ -1580,7 +1583,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class PrivateLinkResourceProperties(_Model): +class PrivateLinkResourceProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Properties of a private link resource. :ivar group_id: The private link resource group id. @@ -1618,7 +1621,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class PrivateLinkServiceConnectionState(_Model): +class PrivateLinkServiceConnectionState(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """A collection of information about the state of the connection between service consumer and provider. @@ -1664,7 +1667,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class PromoteReplicaRequest(_Model): +class PromoteReplicaRequest(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Promote replica request properties. :ivar promote_option: The promote option to apply to the operation. Required. Known values are: @@ -1705,8 +1708,8 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class Replica(ProxyResource): - """Represents a mongo cluster replica. +class Replica(ProxyResource): # pylint: disable=docstring-keyword-should-match-keyword-only + """Represents a DocumentDB cluster replica. :ivar id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. @@ -1747,7 +1750,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: class ReplicationProperties(_Model): - """Replica properties of the mongo cluster. + """Replica properties of the DocumentDB cluster. :ivar source_resource_id: The resource id the source cluster for the replica cluster. :vartype source_resource_id: str @@ -1771,7 +1774,7 @@ class ReplicationProperties(_Model): \"Provisioning\", \"Updating\", \"Broken\", and \"Reconfiguring\".""" -class ShardingProperties(_Model): +class ShardingProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The sharding properties of the cluster. This includes the shard count and scaling options for the cluster. @@ -1802,7 +1805,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class StorageProperties(_Model): +class StorageProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """The storage properties of the cluster. This includes the data storage size and scaling applied to servers in the cluster. @@ -1840,7 +1843,7 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class SystemData(_Model): +class SystemData(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Metadata pertaining to creation and last modification of the resource. :ivar created_by: The identity that created the resource. @@ -1907,8 +1910,8 @@ def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class User(ProxyResource): - """Represents a Mongo cluster user. +class User(ProxyResource): # pylint: disable=docstring-keyword-should-match-keyword-only + """Represents a DocumentDB cluster user. :ivar id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. @@ -1963,7 +1966,7 @@ class UserAssignedIdentity(_Model): """The client ID of the assigned identity.""" -class UserProperties(_Model): +class UserProperties(_Model): # pylint: disable=docstring-keyword-should-match-keyword-only """Definition of Mongo user resource on a cluster. :ivar provisioning_state: The provisioning state of the user. Known values are: "Succeeded", diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_patch.py index 87676c65a8f0..ea765788358a 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_patch.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/models/_patch.py @@ -8,7 +8,6 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ - __all__: list[str] = [] # Add all objects you want publicly available to users at this package level diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_operations.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_operations.py index e61862fea36f..8a505f24cf70 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_operations.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_operations.py @@ -724,7 +724,7 @@ def build_users_list_by_mongo_cluster_request( # pylint: disable=name-too-long return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) -class Operations: +class Operations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -834,7 +834,7 @@ def get_next(next_link=None): return ItemPaged(get_next, extract_data) -class MongoClustersOperations: +class MongoClustersOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -853,12 +853,12 @@ def __init__(self, *args, **kwargs) -> None: @distributed_trace def get(self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any) -> _models.MongoCluster: - """Gets information about a mongo cluster. + """Gets information about a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: MongoCluster. The MongoCluster is compatible with MutableMapping :rtype: ~azure.mgmt.mongocluster.models.MongoCluster @@ -1019,13 +1019,13 @@ def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.MongoCluster]: - """Create or update a mongo cluster. Update overwrites all properties for the resource. To only - modify some of the properties, use PATCH. + """Create or update a DocumentDB cluster. Update overwrites all properties for the resource. To + only modify some of the properties, use PATCH. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.models.MongoCluster @@ -1048,13 +1048,13 @@ def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.MongoCluster]: - """Create or update a mongo cluster. Update overwrites all properties for the resource. To only - modify some of the properties, use PATCH. + """Create or update a DocumentDB cluster. Update overwrites all properties for the resource. To + only modify some of the properties, use PATCH. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.types.MongoCluster @@ -1077,13 +1077,13 @@ def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.MongoCluster]: - """Create or update a mongo cluster. Update overwrites all properties for the resource. To only - modify some of the properties, use PATCH. + """Create or update a DocumentDB cluster. Update overwrites all properties for the resource. To + only modify some of the properties, use PATCH. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param resource: Resource create parameters. Required. :type resource: IO[bytes] @@ -1118,13 +1118,13 @@ def begin_create_or_update( resource: Union[_models.MongoCluster, _types.MongoCluster, IO[bytes]], **kwargs: Any ) -> LROPoller[_models.MongoCluster]: - """Create or update a mongo cluster. Update overwrites all properties for the resource. To only - modify some of the properties, use PATCH. + """Create or update a DocumentDB cluster. Update overwrites all properties for the resource. To + only modify some of the properties, use PATCH. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param resource: Resource create parameters. Is either a MongoCluster type or a IO[bytes] type. Required. @@ -1272,13 +1272,13 @@ def begin_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.MongoCluster]: - """Updates an existing mongo cluster. The request body can contain one to many of the properties - present in the normal mongo cluster definition. + """Updates an existing DocumentDB cluster. The request body can contain one to many of the + properties present in the normal DocumentDB cluster definition. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param properties: The resource properties to be updated. Required. :type properties: ~azure.mgmt.mongocluster.models.MongoClusterUpdate @@ -1301,13 +1301,13 @@ def begin_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.MongoCluster]: - """Updates an existing mongo cluster. The request body can contain one to many of the properties - present in the normal mongo cluster definition. + """Updates an existing DocumentDB cluster. The request body can contain one to many of the + properties present in the normal DocumentDB cluster definition. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param properties: The resource properties to be updated. Required. :type properties: ~azure.mgmt.mongocluster.types.MongoClusterUpdate @@ -1330,13 +1330,13 @@ def begin_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.MongoCluster]: - """Updates an existing mongo cluster. The request body can contain one to many of the properties - present in the normal mongo cluster definition. + """Updates an existing DocumentDB cluster. The request body can contain one to many of the + properties present in the normal DocumentDB cluster definition. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param properties: The resource properties to be updated. Required. :type properties: IO[bytes] @@ -1357,13 +1357,13 @@ def begin_update( properties: Union[_models.MongoClusterUpdate, _types.MongoClusterUpdate, IO[bytes]], **kwargs: Any ) -> LROPoller[_models.MongoCluster]: - """Updates an existing mongo cluster. The request body can contain one to many of the properties - present in the normal mongo cluster definition. + """Updates an existing DocumentDB cluster. The request body can contain one to many of the + properties present in the normal DocumentDB cluster definition. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param properties: The resource properties to be updated. Is either a MongoClusterUpdate type or a IO[bytes] type. Required. @@ -1487,12 +1487,12 @@ def _delete_initial(self, resource_group_name: str, mongo_cluster_name: str, **k @distributed_trace def begin_delete(self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any) -> LROPoller[None]: - """Deletes a mongo cluster. + """Deletes a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An instance of LROPoller that returns None :rtype: ~azure.core.polling.LROPoller[None] @@ -1544,7 +1544,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- @distributed_trace def list_by_resource_group(self, resource_group_name: str, **kwargs: Any) -> ItemPaged["_models.MongoCluster"]: - """List all the mongo clusters in a given resource group. + """List all the DocumentDB clusters in a given resource group. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. @@ -1641,7 +1641,7 @@ def get_next(next_link=None): @distributed_trace def list(self, **kwargs: Any) -> ItemPaged["_models.MongoCluster"]: - """List all the mongo clusters in a given subscription. + """List all the DocumentDB clusters in a given subscription. :return: An iterator like instance of MongoCluster :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.MongoCluster] @@ -1736,13 +1736,13 @@ def get_next(next_link=None): def list_connection_strings( self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any ) -> _models.ListConnectionStringsResult: - """List mongo cluster connection strings. This includes the default connection string using + """List DocumentDB cluster connection strings. This includes the default connection string using SCRAM-SHA-256, as well as other connection strings supported by the cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: ListConnectionStringsResult. The ListConnectionStringsResult is compatible with MutableMapping @@ -1815,7 +1815,7 @@ def check_name_availability( content_type: str = "application/json", **kwargs: Any ) -> _models.CheckNameAvailabilityResponse: - """Check if mongo cluster name is available for use. + """Check if DocumentDB cluster name is available for use. :param location: The name of the Azure region. Required. :type location: str @@ -1839,7 +1839,7 @@ def check_name_availability( content_type: str = "application/json", **kwargs: Any ) -> _models.CheckNameAvailabilityResponse: - """Check if mongo cluster name is available for use. + """Check if DocumentDB cluster name is available for use. :param location: The name of the Azure region. Required. :type location: str @@ -1858,7 +1858,7 @@ def check_name_availability( def check_name_availability( self, location: str, body: IO[bytes], *, content_type: str = "application/json", **kwargs: Any ) -> _models.CheckNameAvailabilityResponse: - """Check if mongo cluster name is available for use. + """Check if DocumentDB cluster name is available for use. :param location: The name of the Azure region. Required. :type location: str @@ -1880,7 +1880,7 @@ def check_name_availability( body: Union[_models.CheckNameAvailabilityRequest, _types.CheckNameAvailabilityRequest, IO[bytes]], **kwargs: Any ) -> _models.CheckNameAvailabilityResponse: - """Check if mongo cluster name is available for use. + """Check if DocumentDB cluster name is available for use. :param location: The name of the Azure region. Required. :type location: str @@ -2067,12 +2067,12 @@ def begin_promote( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[None]: - """Promotes a replica mongo cluster to a primary role. + """Promotes a replica DocumentDB cluster to a primary role. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param body: The content of the action request. Required. :type body: ~azure.mgmt.mongocluster.models.PromoteReplicaRequest @@ -2094,12 +2094,12 @@ def begin_promote( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[None]: - """Promotes a replica mongo cluster to a primary role. + """Promotes a replica DocumentDB cluster to a primary role. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param body: The content of the action request. Required. :type body: ~azure.mgmt.mongocluster.types.PromoteReplicaRequest @@ -2121,12 +2121,12 @@ def begin_promote( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[None]: - """Promotes a replica mongo cluster to a primary role. + """Promotes a replica DocumentDB cluster to a primary role. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param body: The content of the action request. Required. :type body: IO[bytes] @@ -2170,12 +2170,12 @@ def begin_promote( body: Union[_models.PromoteReplicaRequest, _types.PromoteReplicaRequest, IO[bytes]], **kwargs: Any ) -> LROPoller[None]: - """Promotes a replica mongo cluster to a primary role. + """Promotes a replica DocumentDB cluster to a primary role. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param body: The content of the action request. Is either a PromoteReplicaRequest type or a IO[bytes] type. Required. @@ -2233,7 +2233,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore -class FirewallRulesOperations: +class FirewallRulesOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -2254,14 +2254,14 @@ def __init__(self, *args, **kwargs) -> None: def get( self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any ) -> _models.FirewallRule: - """Gets information about a mongo cluster firewall rule. + """Gets information about a DocumentDB cluster firewall rule. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :return: FirewallRule. The FirewallRule is compatible with MutableMapping :rtype: ~azure.mgmt.mongocluster.models.FirewallRule @@ -2413,14 +2413,14 @@ def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.FirewallRule]: - """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + """Creates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.models.FirewallRule @@ -2444,14 +2444,14 @@ def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.FirewallRule]: - """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + """Creates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.types.FirewallRule @@ -2475,14 +2475,14 @@ def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.FirewallRule]: - """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + """Creates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :param resource: Resource create parameters. Required. :type resource: IO[bytes] @@ -2504,14 +2504,14 @@ def begin_create_or_update( resource: Union[_models.FirewallRule, _types.FirewallRule, IO[bytes]], **kwargs: Any ) -> LROPoller[_models.FirewallRule]: - """Creates a new firewall rule or updates an existing firewall rule on a mongo cluster. + """Creates a new firewall rule or updates an existing firewall rule on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :param resource: Resource create parameters. Is either a FirewallRule type or a IO[bytes] type. Required. @@ -2641,14 +2641,14 @@ def _delete_initial( def begin_delete( self, resource_group_name: str, mongo_cluster_name: str, firewall_rule_name: str, **kwargs: Any ) -> LROPoller[None]: - """Deletes a mongo cluster firewall rule. + """Deletes a DocumentDB cluster firewall rule. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param firewall_rule_name: The name of the mongo cluster firewall rule. Required. + :param firewall_rule_name: The name of the DocumentDB cluster firewall rule. Required. :type firewall_rule_name: str :return: An instance of LROPoller that returns None :rtype: ~azure.core.polling.LROPoller[None] @@ -2703,12 +2703,12 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- def list_by_mongo_cluster( self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any ) -> ItemPaged["_models.FirewallRule"]: - """List all the firewall rules in a given mongo cluster. + """List all the firewall rules in a given DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of FirewallRule :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.FirewallRule] @@ -2802,7 +2802,7 @@ def get_next(next_link=None): return ItemPaged(get_next, extract_data) -class PrivateEndpointConnectionsOperations: +class PrivateEndpointConnectionsOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -2828,7 +2828,7 @@ def list_by_mongo_cluster( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of PrivateEndpointConnectionResource :rtype: @@ -2931,7 +2931,7 @@ def get( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -3092,7 +3092,7 @@ def begin_create( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -3125,7 +3125,7 @@ def begin_create( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -3158,7 +3158,7 @@ def begin_create( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -3189,7 +3189,7 @@ def begin_create( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -3332,7 +3332,7 @@ def begin_delete( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :param private_endpoint_connection_name: The name of the private endpoint connection associated with the Azure resource. Required. @@ -3387,7 +3387,7 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method) # type: ignore -class PrivateLinksOperations: +class PrivateLinksOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -3413,7 +3413,7 @@ def list_by_mongo_cluster( :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of PrivateLinkResource :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.PrivateLinkResource] @@ -3507,7 +3507,7 @@ def get_next(next_link=None): return ItemPaged(get_next, extract_data) -class ReplicasOperations: +class ReplicasOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -3552,12 +3552,12 @@ def __init__(self, *args, **kwargs) -> None: def list_by_parent( self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any ) -> ItemPaged["_models.Replica"]: - """List all the replicas for the mongo cluster. + """List all the replicas for the DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of Replica :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.Replica] @@ -3651,7 +3651,7 @@ def get_next(next_link=None): return ItemPaged(get_next, extract_data) -class UsersOperations: +class UsersOperations: # pylint: disable=docstring-missing-param """ .. warning:: **DO NOT** instantiate this class directly. @@ -3692,14 +3692,14 @@ def __init__(self, *args, **kwargs) -> None: ], ) def get(self, resource_group_name: str, mongo_cluster_name: str, user_name: str, **kwargs: Any) -> _models.User: - """Gets the defintion of a Mongo cluster user. + """Gets the defintion of a DocumentDB cluster user. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :return: User. The User is compatible with MutableMapping :rtype: ~azure.mgmt.mongocluster.models.User @@ -3873,14 +3873,14 @@ def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.User]: - """Creates a new user or updates an existing user on a mongo cluster. + """Creates a new user or updates an existing user on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.models.User @@ -3903,14 +3903,14 @@ def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.User]: - """Creates a new user or updates an existing user on a mongo cluster. + """Creates a new user or updates an existing user on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :param resource: Resource create parameters. Required. :type resource: ~azure.mgmt.mongocluster.types.User @@ -3933,14 +3933,14 @@ def begin_create_or_update( content_type: str = "application/json", **kwargs: Any ) -> LROPoller[_models.User]: - """Creates a new user or updates an existing user on a mongo cluster. + """Creates a new user or updates an existing user on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :param resource: Resource create parameters. Required. :type resource: IO[bytes] @@ -3984,14 +3984,14 @@ def begin_create_or_update( resource: Union[_models.User, _types.User, IO[bytes]], **kwargs: Any ) -> LROPoller[_models.User]: - """Creates a new user or updates an existing user on a mongo cluster. + """Creates a new user or updates an existing user on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :param resource: Resource create parameters. Is either a User type or a IO[bytes] type. Required. @@ -4162,14 +4162,14 @@ def _delete_initial( def begin_delete( self, resource_group_name: str, mongo_cluster_name: str, user_name: str, **kwargs: Any ) -> LROPoller[None]: - """Deletes a mongo cluster user. + """Deletes a DocumentDB cluster user. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str - :param user_name: The name of the mongo cluster user. Required. + :param user_name: The name of the DocumentDB cluster user. Required. :type user_name: str :return: An instance of LROPoller that returns None :rtype: ~azure.core.polling.LROPoller[None] @@ -4245,12 +4245,12 @@ def get_long_running_output(pipeline_response): # pylint: disable=inconsistent- def list_by_mongo_cluster( self, resource_group_name: str, mongo_cluster_name: str, **kwargs: Any ) -> ItemPaged["_models.User"]: - """List all the users on a mongo cluster. + """List all the users on a DocumentDB cluster. :param resource_group_name: The name of the resource group. The name is case insensitive. Required. :type resource_group_name: str - :param mongo_cluster_name: The name of the mongo cluster. Required. + :param mongo_cluster_name: The name of the DocumentDB cluster. Required. :type mongo_cluster_name: str :return: An iterator like instance of User :rtype: ~azure.core.paging.ItemPaged[~azure.mgmt.mongocluster.models.User] diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_patch.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_patch.py index 87676c65a8f0..ea765788358a 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_patch.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/operations/_patch.py @@ -8,7 +8,6 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ - __all__: list[str] = [] # Add all objects you want publicly available to users at this package level diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/types.py b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/types.py index 3bc548085f5d..8764d9b3f2b8 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/types.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/azure/mgmt/mongocluster/types.py @@ -41,8 +41,8 @@ class AdministratorProperties(TypedDict, total=False): """The local administrator login properties. - :ivar user_name: The administrator user name. - :vartype user_name: str + :ivar userName: The administrator user name. + :vartype userName: str :ivar password: The administrator password. :vartype password: str """ @@ -54,10 +54,10 @@ class AdministratorProperties(TypedDict, total=False): class AuthConfigProperties(TypedDict, total=False): - """The authentication configuration for the Mongo cluster. + """The authentication configuration for the DocumentDB cluster. - :ivar allowed_modes: Allowed authentication modes for data access on the cluster. - :vartype allowed_modes: list[Union[str, "AuthenticationMode"]] + :ivar allowedModes: Allowed authentication modes for data access on the cluster. + :vartype allowedModes: list[Union[str, "AuthenticationMode"]] """ allowedModes: list[Union[str, "AuthenticationMode"]] @@ -68,8 +68,8 @@ class BackupProperties(TypedDict, total=False): """The backup properties of the cluster. This includes the earliest restore time and retention settings. - :ivar earliest_restore_time: Earliest restore timestamp in UTC ISO8601 format. - :vartype earliest_restore_time: str + :ivar earliestRestoreTime: Earliest restore timestamp in UTC ISO8601 format. + :vartype earliestRestoreTime: str """ earliestRestoreTime: str @@ -108,10 +108,10 @@ class ComputeProperties(TypedDict, total=False): class CustomerManagedKeyEncryptionProperties(TypedDict, total=False): """Customer managed key encryption settings. - :ivar key_encryption_key_identity: The identity used to access the key encryption key. - :vartype key_encryption_key_identity: "KeyEncryptionKeyIdentity" - :ivar key_encryption_key_url: The URI of the key vault key used for encryption. - :vartype key_encryption_key_url: str + :ivar keyEncryptionKeyIdentity: The identity used to access the key encryption key. + :vartype keyEncryptionKeyIdentity: "KeyEncryptionKeyIdentity" + :ivar keyEncryptionKeyUrl: The URI of the key vault key used for encryption. + :vartype keyEncryptionKeyUrl: str """ keyEncryptionKeyIdentity: "KeyEncryptionKeyIdentity" @@ -149,10 +149,10 @@ class DatabaseRole(TypedDict, total=False): class EncryptionProperties(TypedDict, total=False): - """The encryption configuration for the mongo cluster. + """The encryption configuration for the DocumentDB cluster. - :ivar customer_managed_key_encryption: Customer managed key encryption settings. - :vartype customer_managed_key_encryption: "CustomerManagedKeyEncryptionProperties" + :ivar customerManagedKeyEncryption: Customer managed key encryption settings. + :vartype customerManagedKeyEncryption: "CustomerManagedKeyEncryptionProperties" """ customerManagedKeyEncryption: "CustomerManagedKeyEncryptionProperties" @@ -178,9 +178,9 @@ class EntraIdentityProvider(TypedDict, total=False): class EntraIdentityProviderProperties(TypedDict, total=False): """Microsoft Entra ID provider properties. - :ivar principal_type: The principal type of the user. Required. Known values are: "user" and + :ivar principalType: The principal type of the user. Required. Known values are: "user" and "servicePrincipal". - :vartype principal_type: Union[str, "EntraPrincipalType"] + :vartype principalType: Union[str, "EntraPrincipalType"] """ principalType: Required[Union[str, "EntraPrincipalType"]] @@ -198,9 +198,9 @@ class Resource(TypedDict, total=False): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + :ivar systemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. - :vartype system_data: "SystemData" + :vartype systemData: "SystemData" """ id: str @@ -226,14 +226,14 @@ class ProxyResource(Resource): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + :ivar systemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. - :vartype system_data: "SystemData" + :vartype systemData: "SystemData" """ class FirewallRule(ProxyResource): - """Represents a mongo cluster firewall rule. + """Represents a DocumentDB cluster firewall rule. :ivar id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. @@ -243,9 +243,9 @@ class FirewallRule(ProxyResource): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + :ivar systemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. - :vartype system_data: "SystemData" + :vartype systemData: "SystemData" :ivar properties: The resource-specific properties for this resource. :vartype properties: "FirewallRuleProperties" """ @@ -255,34 +255,34 @@ class FirewallRule(ProxyResource): class FirewallRuleProperties(TypedDict, total=False): - """The properties of a mongo cluster firewall rule. + """The properties of a DocumentDB cluster firewall rule. - :ivar provisioning_state: The provisioning state of the firewall rule. Known values are: + :ivar provisioningState: The provisioning state of the firewall rule. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". - :vartype provisioning_state: Union[str, "ProvisioningState"] - :ivar start_ip_address: The start IP address of the mongo cluster firewall rule. Must be IPv4 + :vartype provisioningState: Union[str, "ProvisioningState"] + :ivar startIpAddress: The start IP address of the DocumentDB cluster firewall rule. Must be + IPv4 format. Required. + :vartype startIpAddress: str + :ivar endIpAddress: The end IP address of the DocumentDB cluster firewall rule. Must be IPv4 format. Required. - :vartype start_ip_address: str - :ivar end_ip_address: The end IP address of the mongo cluster firewall rule. Must be IPv4 - format. Required. - :vartype end_ip_address: str + :vartype endIpAddress: str """ provisioningState: Union[str, "ProvisioningState"] """The provisioning state of the firewall rule. Known values are: \"Succeeded\", \"Failed\", \"Canceled\", \"InProgress\", \"Updating\", and \"Dropping\".""" startIpAddress: Required[str] - """The start IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.""" + """The start IP address of the DocumentDB cluster firewall rule. Must be IPv4 format. Required.""" endIpAddress: Required[str] - """The end IP address of the mongo cluster firewall rule. Must be IPv4 format. Required.""" + """The end IP address of the DocumentDB cluster firewall rule. Must be IPv4 format. Required.""" class HighAvailabilityProperties(TypedDict, total=False): """The high availability properties of the cluster. - :ivar target_mode: The target high availability mode requested for the cluster. Known values + :ivar targetMode: The target high availability mode requested for the cluster. Known values are: "Disabled", "SameZone", and "ZoneRedundantPreferred". - :vartype target_mode: Union[str, "HighAvailabilityMode"] + :vartype targetMode: Union[str, "HighAvailabilityMode"] """ targetMode: Union[str, "HighAvailabilityMode"] @@ -293,11 +293,11 @@ class HighAvailabilityProperties(TypedDict, total=False): class KeyEncryptionKeyIdentity(TypedDict, total=False): """The identity used for key encryption key. - :ivar identity_type: The type of identity. Only 'UserAssignedIdentity' is supported. + :ivar identityType: The type of identity. Only 'UserAssignedIdentity' is supported. "UserAssignedIdentity" - :vartype identity_type: Union[str, "KeyEncryptionKeyIdentityType"] - :ivar user_assigned_identity_resource_id: The user assigned identity resource id. - :vartype user_assigned_identity_resource_id: str + :vartype identityType: Union[str, "KeyEncryptionKeyIdentityType"] + :ivar userAssignedIdentityResourceId: The user assigned identity resource id. + :vartype userAssignedIdentityResourceId: str """ identityType: Union[str, "KeyEncryptionKeyIdentityType"] @@ -309,17 +309,17 @@ class KeyEncryptionKeyIdentity(TypedDict, total=False): class ManagedServiceIdentity(TypedDict, total=False): """Managed service identity (system assigned and/or user assigned identities). - :ivar principal_id: The service principal ID of the system assigned identity. This property - will only be provided for a system assigned identity. - :vartype principal_id: str - :ivar tenant_id: The tenant ID of the system assigned identity. This property will only be + :ivar principalId: The service principal ID of the system assigned identity. This property will + only be provided for a system assigned identity. + :vartype principalId: str + :ivar tenantId: The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity. - :vartype tenant_id: str + :vartype tenantId: str :ivar type: The type of managed identity assigned to this resource. Required. Known values are: "None", "SystemAssigned", "UserAssigned", and "SystemAssigned,UserAssigned". :vartype type: Union[str, "ManagedServiceIdentityType"] - :ivar user_assigned_identities: The identities assigned to this resource by the user. - :vartype user_assigned_identities: dict[str, "UserAssignedIdentity"] + :ivar userAssignedIdentities: The identities assigned to this resource by the user. + :vartype userAssignedIdentities: dict[str, "UserAssignedIdentity"] """ principalId: str @@ -346,9 +346,9 @@ class TrackedResource(Resource): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + :ivar systemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. - :vartype system_data: "SystemData" + :vartype systemData: "SystemData" :ivar tags: Resource tags. :vartype tags: dict[str, str] :ivar location: The geo-location where the resource lives. Required. @@ -362,7 +362,7 @@ class TrackedResource(Resource): class MongoCluster(TrackedResource): - """Represents a mongo cluster resource. + """Represents a DocumentDB cluster resource. :ivar id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. @@ -372,9 +372,9 @@ class MongoCluster(TrackedResource): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + :ivar systemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. - :vartype system_data: "SystemData" + :vartype systemData: "SystemData" :ivar tags: Resource tags. :vartype tags: dict[str, str] :ivar location: The geo-location where the resource lives. Required. @@ -392,102 +392,102 @@ class MongoCluster(TrackedResource): class MongoClusterProperties(TypedDict, total=False): - """The properties of a mongo cluster. + """The properties of a DocumentDB cluster. - :ivar create_mode: The mode to create a mongo cluster. Known values are: "Default", + :ivar createMode: The mode to create a DocumentDB cluster. Known values are: "Default", "PointInTimeRestore", "GeoReplica", and "Replica". - :vartype create_mode: Union[str, "CreateMode"] - :ivar restore_parameters: The parameters to create a point-in-time restore mongo cluster. - :vartype restore_parameters: "MongoClusterRestoreParameters" - :ivar replica_parameters: The parameters to create a replica mongo cluster. - :vartype replica_parameters: "MongoClusterReplicaParameters" - :ivar administrator: The local administrator properties for the mongo cluster. + :vartype createMode: Union[str, "CreateMode"] + :ivar restoreParameters: The parameters to create a point-in-time restore DocumentDB cluster. + :vartype restoreParameters: "MongoClusterRestoreParameters" + :ivar replicaParameters: The parameters to create a replica DocumentDB cluster. + :vartype replicaParameters: "MongoClusterReplicaParameters" + :ivar administrator: The local administrator properties for the DocumentDB cluster. :vartype administrator: "AdministratorProperties" - :ivar server_version: The Mongo DB server version. Defaults to the latest available version if + :ivar serverVersion: The Mongo DB server version. Defaults to the latest available version if not specified. - :vartype server_version: str - :ivar connection_string: The default mongo connection string for the cluster. - :vartype connection_string: str - :ivar provisioning_state: The provisioning state of the mongo cluster. Known values are: + :vartype serverVersion: str + :ivar connectionString: The default mongo connection string for the cluster. + :vartype connectionString: str + :ivar provisioningState: The provisioning state of the DocumentDB cluster. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". - :vartype provisioning_state: Union[str, "ProvisioningState"] - :ivar cluster_status: The status of the mongo cluster. Known values are: "Ready", + :vartype provisioningState: Union[str, "ProvisioningState"] + :ivar clusterStatus: The status of the DocumentDB cluster. Known values are: "Ready", "Provisioning", "Updating", "Starting", "Stopping", "Stopped", and "Dropping". - :vartype cluster_status: Union[str, "MongoClusterStatus"] - :ivar public_network_access: Whether or not public endpoint access is allowed for this mongo + :vartype clusterStatus: Union[str, "MongoClusterStatus"] + :ivar publicNetworkAccess: Whether or not public endpoint access is allowed for this DocumentDB cluster. Known values are: "Enabled" and "Disabled". - :vartype public_network_access: Union[str, "PublicNetworkAccess"] - :ivar high_availability: The high availability properties of the mongo cluster. - :vartype high_availability: "HighAvailabilityProperties" - :ivar storage: The storage properties of the mongo cluster. + :vartype publicNetworkAccess: Union[str, "PublicNetworkAccess"] + :ivar highAvailability: The high availability properties of the DocumentDB cluster. + :vartype highAvailability: "HighAvailabilityProperties" + :ivar storage: The storage properties of the DocumentDB cluster. :vartype storage: "StorageProperties" - :ivar sharding: The sharding properties of the mongo cluster. + :ivar sharding: The sharding properties of the DocumentDB cluster. :vartype sharding: "ShardingProperties" - :ivar compute: The compute properties of the mongo cluster. + :ivar compute: The compute properties of the DocumentDB cluster. :vartype compute: "ComputeProperties" - :ivar backup: The backup properties of the mongo cluster. + :ivar backup: The backup properties of the DocumentDB cluster. :vartype backup: "BackupProperties" - :ivar data_api: The Data API properties of the mongo cluster. - :vartype data_api: "DataApiProperties" - :ivar private_endpoint_connections: List of private endpoint connections. - :vartype private_endpoint_connections: list["PrivateEndpointConnection"] - :ivar preview_features: List of private endpoint connections. - :vartype preview_features: list[Union[str, "PreviewFeature"]] - :ivar replica: The replication properties for the mongo cluster. + :ivar dataApi: The Data API properties of the DocumentDB cluster. + :vartype dataApi: "DataApiProperties" + :ivar privateEndpointConnections: List of private endpoint connections. + :vartype privateEndpointConnections: list["PrivateEndpointConnection"] + :ivar previewFeatures: List of private endpoint connections. + :vartype previewFeatures: list[Union[str, "PreviewFeature"]] + :ivar replica: The replication properties for the DocumentDB cluster. :vartype replica: "ReplicationProperties" - :ivar infrastructure_version: The infrastructure version the cluster is provisioned on. - :vartype infrastructure_version: str - :ivar auth_config: The authentication configuration for the cluster. - :vartype auth_config: "AuthConfigProperties" + :ivar infrastructureVersion: The infrastructure version the cluster is provisioned on. + :vartype infrastructureVersion: str + :ivar authConfig: The authentication configuration for the cluster. + :vartype authConfig: "AuthConfigProperties" :ivar encryption: The encryption configuration for the cluster. Depends on identity being configured. :vartype encryption: "EncryptionProperties" - :ivar network_bypass_mode: The network bypass mode for the cluster. Setting to 'AzureCosmosDB' - allows Azure Cosmos DB service to bypass network restrictions. Known values are: "None" and + :ivar networkBypassMode: The network bypass mode for the cluster. Setting to 'AzureCosmosDB' + allows the Azure Cosmos DB service to bypass network restrictions. Known values are: "None" and "AzureCosmosDB". - :vartype network_bypass_mode: Union[str, "NetworkBypassMode"] + :vartype networkBypassMode: Union[str, "NetworkBypassMode"] """ createMode: Union[str, "CreateMode"] - """The mode to create a mongo cluster. Known values are: \"Default\", \"PointInTimeRestore\", + """The mode to create a DocumentDB cluster. Known values are: \"Default\", \"PointInTimeRestore\", \"GeoReplica\", and \"Replica\".""" restoreParameters: "MongoClusterRestoreParameters" - """The parameters to create a point-in-time restore mongo cluster.""" + """The parameters to create a point-in-time restore DocumentDB cluster.""" replicaParameters: "MongoClusterReplicaParameters" - """The parameters to create a replica mongo cluster.""" + """The parameters to create a replica DocumentDB cluster.""" administrator: "AdministratorProperties" - """The local administrator properties for the mongo cluster.""" + """The local administrator properties for the DocumentDB cluster.""" serverVersion: str """The Mongo DB server version. Defaults to the latest available version if not specified.""" connectionString: str """The default mongo connection string for the cluster.""" provisioningState: Union[str, "ProvisioningState"] - """The provisioning state of the mongo cluster. Known values are: \"Succeeded\", \"Failed\", + """The provisioning state of the DocumentDB cluster. Known values are: \"Succeeded\", \"Failed\", \"Canceled\", \"InProgress\", \"Updating\", and \"Dropping\".""" clusterStatus: Union[str, "MongoClusterStatus"] - """The status of the mongo cluster. Known values are: \"Ready\", \"Provisioning\", \"Updating\", - \"Starting\", \"Stopping\", \"Stopped\", and \"Dropping\".""" + """The status of the DocumentDB cluster. Known values are: \"Ready\", \"Provisioning\", + \"Updating\", \"Starting\", \"Stopping\", \"Stopped\", and \"Dropping\".""" publicNetworkAccess: Union[str, "PublicNetworkAccess"] - """Whether or not public endpoint access is allowed for this mongo cluster. Known values are: + """Whether or not public endpoint access is allowed for this DocumentDB cluster. Known values are: \"Enabled\" and \"Disabled\".""" highAvailability: "HighAvailabilityProperties" - """The high availability properties of the mongo cluster.""" + """The high availability properties of the DocumentDB cluster.""" storage: "StorageProperties" - """The storage properties of the mongo cluster.""" + """The storage properties of the DocumentDB cluster.""" sharding: "ShardingProperties" - """The sharding properties of the mongo cluster.""" + """The sharding properties of the DocumentDB cluster.""" compute: "ComputeProperties" - """The compute properties of the mongo cluster.""" + """The compute properties of the DocumentDB cluster.""" backup: "BackupProperties" - """The backup properties of the mongo cluster.""" + """The backup properties of the DocumentDB cluster.""" dataApi: "DataApiProperties" - """The Data API properties of the mongo cluster.""" + """The Data API properties of the DocumentDB cluster.""" privateEndpointConnections: list["PrivateEndpointConnection"] """List of private endpoint connections.""" previewFeatures: list[Union[str, "PreviewFeature"]] """List of private endpoint connections.""" replica: "ReplicationProperties" - """The replication properties for the mongo cluster.""" + """The replication properties for the DocumentDB cluster.""" infrastructureVersion: str """The infrastructure version the cluster is provisioned on.""" authConfig: "AuthConfigProperties" @@ -495,17 +495,17 @@ class MongoClusterProperties(TypedDict, total=False): encryption: "EncryptionProperties" """The encryption configuration for the cluster. Depends on identity being configured.""" networkBypassMode: Union[str, "NetworkBypassMode"] - """The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows Azure Cosmos DB + """The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows the Azure Cosmos DB service to bypass network restrictions. Known values are: \"None\" and \"AzureCosmosDB\".""" class MongoClusterReplicaParameters(TypedDict, total=False): """Parameters used for replica operations. - :ivar source_resource_id: The id of the replication source cluster. Required. - :vartype source_resource_id: str - :ivar source_location: The location of the source cluster. Required. - :vartype source_location: str + :ivar sourceResourceId: The id of the replication source cluster. Required. + :vartype sourceResourceId: str + :ivar sourceLocation: The location of the source cluster. Required. + :vartype sourceLocation: str """ sourceResourceId: Required[str] @@ -517,14 +517,14 @@ class MongoClusterReplicaParameters(TypedDict, total=False): class MongoClusterRestoreParameters(TypedDict, total=False): """Parameters used for restore operations. - :ivar point_in_time_utc: UTC point in time to restore a mongo cluster. - :vartype point_in_time_utc: str - :ivar source_resource_id: Resource ID to locate the source cluster to restore. - :vartype source_resource_id: str + :ivar pointInTimeUTC: UTC point in time to restore a DocumentDB cluster. + :vartype pointInTimeUTC: str + :ivar sourceResourceId: Resource ID to locate the source cluster to restore. + :vartype sourceResourceId: str """ pointInTimeUTC: str - """UTC point in time to restore a mongo cluster.""" + """UTC point in time to restore a DocumentDB cluster.""" sourceResourceId: str """Resource ID to locate the source cluster to restore.""" @@ -551,58 +551,58 @@ class MongoClusterUpdate(TypedDict, total=False): class MongoClusterUpdateProperties(TypedDict, total=False): """The updatable properties of the MongoCluster. - :ivar administrator: The local administrator properties for the mongo cluster. + :ivar administrator: The local administrator properties for the DocumentDB cluster. :vartype administrator: "AdministratorProperties" - :ivar server_version: The Mongo DB server version. Defaults to the latest available version if + :ivar serverVersion: The Mongo DB server version. Defaults to the latest available version if not specified. - :vartype server_version: str - :ivar public_network_access: Whether or not public endpoint access is allowed for this mongo + :vartype serverVersion: str + :ivar publicNetworkAccess: Whether or not public endpoint access is allowed for this DocumentDB cluster. Known values are: "Enabled" and "Disabled". - :vartype public_network_access: Union[str, "PublicNetworkAccess"] - :ivar high_availability: The high availability properties of the mongo cluster. - :vartype high_availability: "HighAvailabilityProperties" - :ivar storage: The storage properties of the mongo cluster. + :vartype publicNetworkAccess: Union[str, "PublicNetworkAccess"] + :ivar highAvailability: The high availability properties of the DocumentDB cluster. + :vartype highAvailability: "HighAvailabilityProperties" + :ivar storage: The storage properties of the DocumentDB cluster. :vartype storage: "StorageProperties" - :ivar sharding: The sharding properties of the mongo cluster. + :ivar sharding: The sharding properties of the DocumentDB cluster. :vartype sharding: "ShardingProperties" - :ivar compute: The compute properties of the mongo cluster. + :ivar compute: The compute properties of the DocumentDB cluster. :vartype compute: "ComputeProperties" - :ivar backup: The backup properties of the mongo cluster. + :ivar backup: The backup properties of the DocumentDB cluster. :vartype backup: "BackupProperties" - :ivar data_api: The Data API properties of the mongo cluster. - :vartype data_api: "DataApiProperties" - :ivar preview_features: List of private endpoint connections. - :vartype preview_features: list[Union[str, "PreviewFeature"]] - :ivar auth_config: The authentication configuration for the cluster. - :vartype auth_config: "AuthConfigProperties" + :ivar dataApi: The Data API properties of the DocumentDB cluster. + :vartype dataApi: "DataApiProperties" + :ivar previewFeatures: List of private endpoint connections. + :vartype previewFeatures: list[Union[str, "PreviewFeature"]] + :ivar authConfig: The authentication configuration for the cluster. + :vartype authConfig: "AuthConfigProperties" :ivar encryption: The encryption configuration for the cluster. Depends on identity being configured. :vartype encryption: "EncryptionProperties" - :ivar network_bypass_mode: The network bypass mode for the cluster. Setting to 'AzureCosmosDB' - allows Azure Cosmos DB service to bypass network restrictions. Known values are: "None" and + :ivar networkBypassMode: The network bypass mode for the cluster. Setting to 'AzureCosmosDB' + allows the Azure Cosmos DB service to bypass network restrictions. Known values are: "None" and "AzureCosmosDB". - :vartype network_bypass_mode: Union[str, "NetworkBypassMode"] + :vartype networkBypassMode: Union[str, "NetworkBypassMode"] """ administrator: "AdministratorProperties" - """The local administrator properties for the mongo cluster.""" + """The local administrator properties for the DocumentDB cluster.""" serverVersion: str """The Mongo DB server version. Defaults to the latest available version if not specified.""" publicNetworkAccess: Union[str, "PublicNetworkAccess"] - """Whether or not public endpoint access is allowed for this mongo cluster. Known values are: + """Whether or not public endpoint access is allowed for this DocumentDB cluster. Known values are: \"Enabled\" and \"Disabled\".""" highAvailability: "HighAvailabilityProperties" - """The high availability properties of the mongo cluster.""" + """The high availability properties of the DocumentDB cluster.""" storage: "StorageProperties" - """The storage properties of the mongo cluster.""" + """The storage properties of the DocumentDB cluster.""" sharding: "ShardingProperties" - """The sharding properties of the mongo cluster.""" + """The sharding properties of the DocumentDB cluster.""" compute: "ComputeProperties" - """The compute properties of the mongo cluster.""" + """The compute properties of the DocumentDB cluster.""" backup: "BackupProperties" - """The backup properties of the mongo cluster.""" + """The backup properties of the DocumentDB cluster.""" dataApi: "DataApiProperties" - """The Data API properties of the mongo cluster.""" + """The Data API properties of the DocumentDB cluster.""" previewFeatures: list[Union[str, "PreviewFeature"]] """List of private endpoint connections.""" authConfig: "AuthConfigProperties" @@ -610,7 +610,7 @@ class MongoClusterUpdateProperties(TypedDict, total=False): encryption: "EncryptionProperties" """The encryption configuration for the cluster. Depends on identity being configured.""" networkBypassMode: Union[str, "NetworkBypassMode"] - """The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows Azure Cosmos DB + """The network bypass mode for the cluster. Setting to 'AzureCosmosDB' allows the Azure Cosmos DB service to bypass network restrictions. Known values are: \"None\" and \"AzureCosmosDB\".""" @@ -636,9 +636,9 @@ class PrivateEndpointConnection(Resource): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + :ivar systemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. - :vartype system_data: "SystemData" + :vartype systemData: "SystemData" :ivar properties: The private endpoint connection properties. :vartype properties: "PrivateEndpointConnectionProperties" """ @@ -650,16 +650,16 @@ class PrivateEndpointConnection(Resource): class PrivateEndpointConnectionProperties(TypedDict, total=False): """Properties of the private endpoint connection. - :ivar group_ids: The group ids for the private endpoint resource. - :vartype group_ids: list[str] - :ivar private_endpoint: The private endpoint resource. - :vartype private_endpoint: "PrivateEndpoint" - :ivar private_link_service_connection_state: A collection of information about the state of the + :ivar groupIds: The group ids for the private endpoint resource. + :vartype groupIds: list[str] + :ivar privateEndpoint: The private endpoint resource. + :vartype privateEndpoint: "PrivateEndpoint" + :ivar privateLinkServiceConnectionState: A collection of information about the state of the connection between service consumer and provider. Required. - :vartype private_link_service_connection_state: "PrivateLinkServiceConnectionState" - :ivar provisioning_state: The provisioning state of the private endpoint connection resource. + :vartype privateLinkServiceConnectionState: "PrivateLinkServiceConnectionState" + :ivar provisioningState: The provisioning state of the private endpoint connection resource. Known values are: "Succeeded", "Creating", "Deleting", and "Failed". - :vartype provisioning_state: Union[str, "PrivateEndpointConnectionProvisioningState"] + :vartype provisioningState: Union[str, "PrivateEndpointConnectionProvisioningState"] """ groupIds: list[str] @@ -686,9 +686,9 @@ class PrivateEndpointConnectionResource(ProxyResource): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + :ivar systemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. - :vartype system_data: "SystemData" + :vartype systemData: "SystemData" :ivar properties: The resource-specific properties for this resource. :vartype properties: "PrivateEndpointConnectionProperties" """ @@ -706,9 +706,9 @@ class PrivateLinkServiceConnectionState(TypedDict, total=False): :vartype status: Union[str, "PrivateEndpointServiceConnectionStatus"] :ivar description: The reason for approval/rejection of the connection. :vartype description: str - :ivar actions_required: A message indicating if changes on the service provider require any + :ivar actionsRequired: A message indicating if changes on the service provider require any updates on the consumer. - :vartype actions_required: str + :vartype actionsRequired: str """ status: Union[str, "PrivateEndpointServiceConnectionStatus"] @@ -723,9 +723,9 @@ class PrivateLinkServiceConnectionState(TypedDict, total=False): class PromoteReplicaRequest(TypedDict, total=False): """Promote replica request properties. - :ivar promote_option: The promote option to apply to the operation. Required. Known values are: + :ivar promoteOption: The promote option to apply to the operation. Required. Known values are: "Forced" and "Planned". - :vartype promote_option: Union[str, "PromoteOption"] + :vartype promoteOption: Union[str, "PromoteOption"] :ivar mode: The mode to apply to the promote operation. Value is optional and default value is 'Switchover'. "Switchover" :vartype mode: Union[str, "PromoteMode"] @@ -740,16 +740,16 @@ class PromoteReplicaRequest(TypedDict, total=False): class ReplicationProperties(TypedDict, total=False): - """Replica properties of the mongo cluster. + """Replica properties of the DocumentDB cluster. - :ivar source_resource_id: The resource id the source cluster for the replica cluster. - :vartype source_resource_id: str + :ivar sourceResourceId: The resource id the source cluster for the replica cluster. + :vartype sourceResourceId: str :ivar role: The replication role of the cluster. Known values are: "Primary", "AsyncReplica", and "GeoAsyncReplica". :vartype role: Union[str, "ReplicationRole"] - :ivar replication_state: The replication link state of the replica cluster. Known values are: + :ivar replicationState: The replication link state of the replica cluster. Known values are: "Active", "Catchup", "Provisioning", "Updating", "Broken", and "Reconfiguring". - :vartype replication_state: Union[str, "ReplicationState"] + :vartype replicationState: Union[str, "ReplicationState"] """ sourceResourceId: str @@ -766,8 +766,8 @@ class ShardingProperties(TypedDict, total=False): """The sharding properties of the cluster. This includes the shard count and scaling options for the cluster. - :ivar shard_count: Number of shards to provision on the cluster. - :vartype shard_count: int + :ivar shardCount: Number of shards to provision on the cluster. + :vartype shardCount: int """ shardCount: int @@ -778,8 +778,8 @@ class StorageProperties(TypedDict, total=False): """The storage properties of the cluster. This includes the data storage size and scaling applied to servers in the cluster. - :ivar size_gb: The size of the data disk assigned to each server. - :vartype size_gb: int + :ivar sizeGb: The size of the data disk assigned to each server. + :vartype sizeGb: int :ivar type: The type of storage to provision the cluster servers with. Known values are: "PremiumSSD" and "PremiumSSDv2". :vartype type: Union[str, "StorageType"] @@ -795,20 +795,20 @@ class StorageProperties(TypedDict, total=False): class SystemData(TypedDict, total=False): """Metadata pertaining to creation and last modification of the resource. - :ivar created_by: The identity that created the resource. - :vartype created_by: str - :ivar created_by_type: The type of identity that created the resource. Known values are: - "User", "Application", "ManagedIdentity", and "Key". - :vartype created_by_type: Union[str, "CreatedByType"] - :ivar created_at: The timestamp of resource creation (UTC). - :vartype created_at: str - :ivar last_modified_by: The identity that last modified the resource. - :vartype last_modified_by: str - :ivar last_modified_by_type: The type of identity that last modified the resource. Known values + :ivar createdBy: The identity that created the resource. + :vartype createdBy: str + :ivar createdByType: The type of identity that created the resource. Known values are: "User", + "Application", "ManagedIdentity", and "Key". + :vartype createdByType: Union[str, "CreatedByType"] + :ivar createdAt: The timestamp of resource creation (UTC). + :vartype createdAt: str + :ivar lastModifiedBy: The identity that last modified the resource. + :vartype lastModifiedBy: str + :ivar lastModifiedByType: The type of identity that last modified the resource. Known values are: "User", "Application", "ManagedIdentity", and "Key". - :vartype last_modified_by_type: Union[str, "CreatedByType"] - :ivar last_modified_at: The timestamp of resource last modification (UTC). - :vartype last_modified_at: str + :vartype lastModifiedByType: Union[str, "CreatedByType"] + :ivar lastModifiedAt: The timestamp of resource last modification (UTC). + :vartype lastModifiedAt: str """ createdBy: str @@ -828,7 +828,7 @@ class SystemData(TypedDict, total=False): class User(ProxyResource): - """Represents a Mongo cluster user. + """Represents a DocumentDB cluster user. :ivar id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. @@ -838,9 +838,9 @@ class User(ProxyResource): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar system_data: Azure Resource Manager metadata containing createdBy and modifiedBy + :ivar systemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. - :vartype system_data: "SystemData" + :vartype systemData: "SystemData" :ivar properties: The resource-specific properties for this resource. :vartype properties: "UserProperties" """ @@ -852,10 +852,10 @@ class User(ProxyResource): class UserAssignedIdentity(TypedDict, total=False): """User assigned identity properties. - :ivar principal_id: The principal ID of the assigned identity. - :vartype principal_id: str - :ivar client_id: The client ID of the assigned identity. - :vartype client_id: str + :ivar principalId: The principal ID of the assigned identity. + :vartype principalId: str + :ivar clientId: The client ID of the assigned identity. + :vartype clientId: str """ principalId: str @@ -867,11 +867,11 @@ class UserAssignedIdentity(TypedDict, total=False): class UserProperties(TypedDict, total=False): """Definition of Mongo user resource on a cluster. - :ivar provisioning_state: The provisioning state of the user. Known values are: "Succeeded", + :ivar provisioningState: The provisioning state of the user. Known values are: "Succeeded", "Failed", "Canceled", "InProgress", "Updating", and "Dropping". - :vartype provisioning_state: Union[str, "ProvisioningState"] - :ivar identity_provider: The user's identity provider definition. - :vartype identity_provider: "IdentityProvider" + :vartype provisioningState: Union[str, "ProvisioningState"] + :ivar identityProvider: The user's identity provider definition. + :vartype identityProvider: "IdentityProvider" :ivar roles: Database roles that are assigned to the user. :vartype roles: list["DatabaseRole"] """ diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/generated_samples/mongo_clusters_update.py b/sdk/mongocluster/azure-mgmt-mongocluster/generated_samples/mongo_clusters_update.py index 3f0c953c8e03..cb7169af009f 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/generated_samples/mongo_clusters_update.py +++ b/sdk/mongocluster/azure-mgmt-mongocluster/generated_samples/mongo_clusters_update.py @@ -44,7 +44,7 @@ def main(): "publicNetworkAccess": "Enabled", "serverVersion": "5.0", "sharding": {"shardCount": 4}, - "storage": {"sizeGb": 256, "type": "PremiumSSD"}, + "storage": {"sizeGb": 256, "type": "PremiumSSDv2"}, } }, ).result() diff --git a/sdk/mongocluster/azure-mgmt-mongocluster/tsp-location.yaml b/sdk/mongocluster/azure-mgmt-mongocluster/tsp-location.yaml index f0b0e551158a..2a7e3809d890 100644 --- a/sdk/mongocluster/azure-mgmt-mongocluster/tsp-location.yaml +++ b/sdk/mongocluster/azure-mgmt-mongocluster/tsp-location.yaml @@ -1,4 +1,4 @@ directory: specification/mongocluster/resource-manager/Microsoft.DocumentDB/MongoCluster -commit: 358882ad707dcc3b0d1de9df6ba4dfba7e85da1a +commit: 180f62a563934f8c0fdd37e0b42845bc110340d3 repo: Azure/azure-rest-api-specs additionalDirectories: