diff --git a/sdk/search/azure-mgmt-search/_meta.json b/sdk/search/azure-mgmt-search/_meta.json index a3d82ef711c6..3467be0674dd 100644 --- a/sdk/search/azure-mgmt-search/_meta.json +++ b/sdk/search/azure-mgmt-search/_meta.json @@ -1,11 +1,11 @@ { - "commit": "e1017d9ab49f41296177b4f4c9ac741fb7de044d", + "commit": "a231973a4fd49f699621dd74cb1b47d9d6fdcd13", "repository_url": "https://github.com/Azure/azure-rest-api-specs", "autorest": "3.9.7", "use": [ "@autorest/python@6.7.1", "@autorest/modelerfour@4.26.2" ], - "autorest_command": "autorest specification/search/resource-manager/readme.md --generate-sample=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/home/vsts/work/1/azure-sdk-for-python/sdk --use=@autorest/python@6.7.1 --use=@autorest/modelerfour@4.26.2 --version=3.9.7 --version-tolerant=False", + "autorest_command": "autorest specification/search/resource-manager/readme.md --generate-sample=True --include-x-ms-examples-original-file=True --python --python-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-python/sdk --use=@autorest/python@6.7.1 --use=@autorest/modelerfour@4.26.2 --version=3.9.7 --version-tolerant=False", "readme": "specification/search/resource-manager/readme.md" } \ No newline at end of file diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/_configuration.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/_configuration.py index 694256fcb159..b05f13d7e3f0 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/_configuration.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/_configuration.py @@ -28,7 +28,8 @@ class SearchManagementClientConfiguration(Configuration): # pylint: disable=too :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.TokenCredential :param subscription_id: The unique identifier for a Microsoft Azure subscription. You can - obtain this value from the Azure Resource Manager API or the portal. Required. + obtain this value from the Azure Resource Manager API, command line tools, or the portal. + Required. :type subscription_id: str :keyword api_version: Api Version. Default value is "2023-11-01". Note that overriding this default value may result in unsupported behavior. diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/_search_management_client.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/_search_management_client.py index a3350dce322c..f307e3fe618c 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/_search_management_client.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/_search_management_client.py @@ -35,7 +35,7 @@ class SearchManagementClient( SearchManagementClientOperationsMixin ): # pylint: disable=client-accepts-api-version-keyword,too-many-instance-attributes - """Client that can be used to manage Azure Cognitive Search services and API keys. + """Client that can be used to manage search services and API keys. :ivar operations: Operations operations :vartype operations: azure.mgmt.search.operations.Operations @@ -58,7 +58,8 @@ class SearchManagementClient( :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials.TokenCredential :param subscription_id: The unique identifier for a Microsoft Azure subscription. You can - obtain this value from the Azure Resource Manager API or the portal. Required. + obtain this value from the Azure Resource Manager API, command line tools, or the portal. + Required. :type subscription_id: str :param base_url: Service URL. Default value is "https://management.azure.com". :type base_url: str diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/_version.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/_version.py index f89ed38360ab..e5754a47ce68 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/_version.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "9.1.0" +VERSION = "1.0.0b1" diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/_configuration.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/_configuration.py index d813b42ba7e6..2c6b03d5735f 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/_configuration.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/_configuration.py @@ -28,7 +28,8 @@ class SearchManagementClientConfiguration(Configuration): # pylint: disable=too :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential :param subscription_id: The unique identifier for a Microsoft Azure subscription. You can - obtain this value from the Azure Resource Manager API or the portal. Required. + obtain this value from the Azure Resource Manager API, command line tools, or the portal. + Required. :type subscription_id: str :keyword api_version: Api Version. Default value is "2023-11-01". Note that overriding this default value may result in unsupported behavior. diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/_search_management_client.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/_search_management_client.py index ea3e05ccaf32..add5d66b00b4 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/_search_management_client.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/_search_management_client.py @@ -35,7 +35,7 @@ class SearchManagementClient( SearchManagementClientOperationsMixin ): # pylint: disable=client-accepts-api-version-keyword,too-many-instance-attributes - """Client that can be used to manage Azure Cognitive Search services and API keys. + """Client that can be used to manage search services and API keys. :ivar operations: Operations operations :vartype operations: azure.mgmt.search.aio.operations.Operations @@ -59,7 +59,8 @@ class SearchManagementClient( :param credential: Credential needed for the client to connect to Azure. Required. :type credential: ~azure.core.credentials_async.AsyncTokenCredential :param subscription_id: The unique identifier for a Microsoft Azure subscription. You can - obtain this value from the Azure Resource Manager API or the portal. Required. + obtain this value from the Azure Resource Manager API, command line tools, or the portal. + Required. :type subscription_id: str :param base_url: Service URL. Default value is "https://management.azure.com". :type base_url: str diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_admin_keys_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_admin_keys_operations.py index 1ba6cc833801..521421e38616 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_admin_keys_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_admin_keys_operations.py @@ -59,7 +59,7 @@ async def get( search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None, **kwargs: Any ) -> _models.AdminKeyResult: - """Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service. + """Gets the primary and secondary admin API keys for the specified search service. .. seealso:: - https://aka.ms/search-manage @@ -67,8 +67,8 @@ async def get( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -149,8 +149,8 @@ async def regenerate( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param key_kind: Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Known values are: "primary" and "secondary". Required. diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_private_endpoint_connections_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_private_endpoint_connections_operations.py index bdef7873d36d..5b7441aaef0a 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_private_endpoint_connections_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_private_endpoint_connections_operations.py @@ -80,11 +80,11 @@ async def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param private_endpoint_connection: The definition of the private endpoint connection to update. Required. @@ -121,11 +121,11 @@ async def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param private_endpoint_connection: The definition of the private endpoint connection to update. Required. @@ -160,11 +160,11 @@ async def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param private_endpoint_connection: The definition of the private endpoint connection to update. Is either a PrivateEndpointConnection type or a IO type. Required. @@ -263,11 +263,11 @@ async def get( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -348,11 +348,11 @@ async def delete( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -434,8 +434,8 @@ def list_by_service( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_private_link_resources_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_private_link_resources_operations.py index dd1f50169adc..6da6ea3d4286 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_private_link_resources_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_private_link_resources_operations.py @@ -69,8 +69,8 @@ def list_supported( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_query_keys_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_query_keys_operations.py index 0f55803437d9..fced8440754a 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_query_keys_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_query_keys_operations.py @@ -76,8 +76,8 @@ async def create( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param name: The name of the new query API key. Required. :type name: str @@ -151,7 +151,7 @@ def list_by_search_service( search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None, **kwargs: Any ) -> AsyncIterable["_models.QueryKey"]: - """Returns the list of query API keys for the given Azure Cognitive Search service. + """Returns the list of query API keys for the given search service. .. seealso:: - https://aka.ms/search-manage @@ -159,8 +159,8 @@ def list_by_search_service( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -267,8 +267,8 @@ async def delete( # pylint: disable=inconsistent-return-statements :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param key: The query key to be deleted. Query keys are identified by value, not by name. Required. diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_search_management_client_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_search_management_client_operations.py index f29b53fc6b0d..e6040a75cb00 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_search_management_client_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_search_management_client_operations.py @@ -41,15 +41,14 @@ async def usage_by_subscription_sku( search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None, **kwargs: Any ) -> _models.QuotaUsageResult: - """Gets the quota usage for a search sku in the given subscription. + """Gets the quota usage for a search SKU in the given subscription. .. seealso:: - https://aka.ms/search-manage :param location: The unique location name for a Microsoft Azure geographic region. Required. :type location: str - :param sku_name: The unique search service sku name supported by Azure Cognitive Search. - Required. + :param sku_name: The unique SKU name that identifies a billable tier. Required. :type sku_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_services_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_services_operations.py index 950034e8b95a..50553865aa05 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_services_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_services_operations.py @@ -166,12 +166,12 @@ async def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to create or update. - Search service names must only contain lowercase letters, digits or dashes, cannot use dash as - the first two or last one characters, cannot contain consecutive dashes, and must be between 2 - and 60 characters in length. Search service names must be globally unique since they are part - of the service URI (https://:code:``.search.windows.net). You cannot change the service - name after the service is created. Required. + :param search_service_name: The name of the search service to create or update. Search service + names must only contain lowercase letters, digits or dashes, cannot use dash as the first two + or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 + characters in length. Search service names must be globally unique since they are part of the + service URI (https://:code:``.search.windows.net). You cannot change the service name + after the service is created. Required. :type search_service_name: str :param service: The definition of the search service to create or update. Required. :type service: ~azure.mgmt.search.models.SearchService @@ -215,12 +215,12 @@ async def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to create or update. - Search service names must only contain lowercase letters, digits or dashes, cannot use dash as - the first two or last one characters, cannot contain consecutive dashes, and must be between 2 - and 60 characters in length. Search service names must be globally unique since they are part - of the service URI (https://:code:``.search.windows.net). You cannot change the service - name after the service is created. Required. + :param search_service_name: The name of the search service to create or update. Search service + names must only contain lowercase letters, digits or dashes, cannot use dash as the first two + or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 + characters in length. Search service names must be globally unique since they are part of the + service URI (https://:code:``.search.windows.net). You cannot change the service name + after the service is created. Required. :type search_service_name: str :param service: The definition of the search service to create or update. Required. :type service: IO @@ -262,12 +262,12 @@ async def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to create or update. - Search service names must only contain lowercase letters, digits or dashes, cannot use dash as - the first two or last one characters, cannot contain consecutive dashes, and must be between 2 - and 60 characters in length. Search service names must be globally unique since they are part - of the service URI (https://:code:``.search.windows.net). You cannot change the service - name after the service is created. Required. + :param search_service_name: The name of the search service to create or update. Search service + names must only contain lowercase letters, digits or dashes, cannot use dash as the first two + or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 + characters in length. Search service names must be globally unique since they are part of the + service URI (https://:code:``.search.windows.net). You cannot change the service name + after the service is created. Required. :type search_service_name: str :param service: The definition of the search service to create or update. Is either a SearchService type or a IO type. Required. @@ -359,7 +359,7 @@ async def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to update. Required. + :param search_service_name: The name of the search service to update. Required. :type search_service_name: str :param service: The definition of the search service to update. Required. :type service: ~azure.mgmt.search.models.SearchServiceUpdate @@ -394,7 +394,7 @@ async def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to update. Required. + :param search_service_name: The name of the search service to update. Required. :type search_service_name: str :param service: The definition of the search service to update. Required. :type service: IO @@ -427,7 +427,7 @@ async def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to update. Required. + :param search_service_name: The name of the search service to update. Required. :type search_service_name: str :param service: The definition of the search service to update. Is either a SearchServiceUpdate type or a IO type. Required. @@ -523,8 +523,8 @@ async def get( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -603,8 +603,8 @@ async def delete( # pylint: disable=inconsistent-return-statements :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_shared_private_link_resources_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_shared_private_link_resources_operations.py index 9e122542e18c..6494d08e42be 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_shared_private_link_resources_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/aio/operations/_shared_private_link_resources_operations.py @@ -159,11 +159,11 @@ async def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param shared_private_link_resource: The definition of the shared private link resource to create or update. Required. @@ -209,11 +209,11 @@ async def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param shared_private_link_resource: The definition of the shared private link resource to create or update. Required. @@ -257,11 +257,11 @@ async def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param shared_private_link_resource: The definition of the shared private link resource to create or update. Is either a SharedPrivateLinkResource type or a IO type. Required. @@ -356,11 +356,11 @@ async def get( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -499,11 +499,11 @@ async def begin_delete( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -584,8 +584,8 @@ def list_by_service( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/models/_models_py3.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/models/_models_py3.py index 73004cccd71c..e1c746427d00 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/models/_models_py3.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/models/_models_py3.py @@ -24,8 +24,7 @@ class AdminKeyResult(_serialization.Model): - """Response containing the primary and secondary admin API keys for a given Azure Cognitive Search - service. + """Response containing the primary and secondary admin API keys for a given search service. Variables are only populated by the server, and will be ignored when sending a request. @@ -208,10 +207,10 @@ def __init__( class DataPlaneAadOrApiKeyAuthOption(_serialization.Model): - """Indicates that either the API key or an access token from Azure Active Directory can be used - for authentication. + """Indicates that either the API key or an access token from a Microsoft Entra ID tenant can be + used for authentication. - :ivar aad_auth_failure_mode: Describes what response the data plane API of a Search service + :ivar aad_auth_failure_mode: Describes what response the data plane API of a search service would send for requests that failed authentication. Known values are: "http403" and "http401WithBearerChallenge". :vartype aad_auth_failure_mode: str or ~azure.mgmt.search.models.AadAuthFailureMode @@ -225,7 +224,7 @@ def __init__( self, *, aad_auth_failure_mode: Optional[Union[str, "_models.AadAuthFailureMode"]] = None, **kwargs: Any ) -> None: """ - :keyword aad_auth_failure_mode: Describes what response the data plane API of a Search service + :keyword aad_auth_failure_mode: Describes what response the data plane API of a search service would send for requests that failed authentication. Known values are: "http403" and "http401WithBearerChallenge". :paramtype aad_auth_failure_mode: str or ~azure.mgmt.search.models.AadAuthFailureMode @@ -235,13 +234,13 @@ def __init__( class DataPlaneAuthOptions(_serialization.Model): - """Defines the options for how the data plane API of a Search service authenticates requests. This - cannot be set if 'disableLocalAuth' is set to true. + """Defines the options for how the search service authenticates a data plane request. This cannot + be set if 'disableLocalAuth' is set to true. - :ivar api_key_only: Indicates that only the API key needs to be used for authentication. + :ivar api_key_only: Indicates that only the API key can be used for authentication. :vartype api_key_only: JSON - :ivar aad_or_api_key: Indicates that either the API key or an access token from Azure Active - Directory can be used for authentication. + :ivar aad_or_api_key: Indicates that either the API key or an access token from a Microsoft + Entra ID tenant can be used for authentication. :vartype aad_or_api_key: ~azure.mgmt.search.models.DataPlaneAadOrApiKeyAuthOption """ @@ -258,10 +257,10 @@ def __init__( **kwargs: Any ) -> None: """ - :keyword api_key_only: Indicates that only the API key needs to be used for authentication. + :keyword api_key_only: Indicates that only the API key can be used for authentication. :paramtype api_key_only: JSON - :keyword aad_or_api_key: Indicates that either the API key or an access token from Azure Active - Directory can be used for authentication. + :keyword aad_or_api_key: Indicates that either the API key or an access token from a Microsoft + Entra ID tenant can be used for authentication. :paramtype aad_or_api_key: ~azure.mgmt.search.models.DataPlaneAadOrApiKeyAuthOption """ super().__init__(**kwargs) @@ -271,17 +270,17 @@ def __init__( class EncryptionWithCmk(_serialization.Model): """Describes a policy that determines how resources within the search service are to be encrypted - with Customer Managed Keys. + with customer=managed keys. Variables are only populated by the server, and will be ignored when sending a request. - :ivar enforcement: Describes how a search service should enforce having one or more non - customer encrypted resources. Known values are: "Disabled", "Enabled", and "Unspecified". + :ivar enforcement: Describes how a search service should enforce having one or more + non-customer-encrypted resources. Known values are: "Disabled", "Enabled", and "Unspecified". :vartype enforcement: str or ~azure.mgmt.search.models.SearchEncryptionWithCmk :ivar encryption_compliance_status: Describes whether the search service is compliant or not - with respect to having non customer encrypted resources. If a service has more than one non - customer encrypted resource and 'Enforcement' is 'enabled' then the service will be marked as - 'nonCompliant'. Known values are: "Compliant" and "NonCompliant". + with respect to having non-customer-encrypted resources. If a service has more than one + non-customer-encrypted resource and 'Enforcement' is 'enabled' then the service will be marked + as 'nonCompliant'. Known values are: "Compliant" and "NonCompliant". :vartype encryption_compliance_status: str or ~azure.mgmt.search.models.SearchEncryptionComplianceStatus """ @@ -299,8 +298,8 @@ def __init__( self, *, enforcement: Optional[Union[str, "_models.SearchEncryptionWithCmk"]] = None, **kwargs: Any ) -> None: """ - :keyword enforcement: Describes how a search service should enforce having one or more non - customer encrypted resources. Known values are: "Disabled", "Enabled", and "Unspecified". + :keyword enforcement: Describes how a search service should enforce having one or more + non-customer-encrypted resources. Known values are: "Disabled", "Enabled", and "Unspecified". :paramtype enforcement: str or ~azure.mgmt.search.models.SearchEncryptionWithCmk """ super().__init__(**kwargs) @@ -347,10 +346,10 @@ def __init__(self, *, type: Union[str, "_models.IdentityType"], **kwargs: Any) - class IpRule(_serialization.Model): - """The IP restriction rule of the Azure Cognitive Search service. + """The IP restriction rule of the search service. - :ivar value: Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in - CIDR format (eg., 123.1.2.3/24) to be allowed. + :ivar value: Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP + range in CIDR format (for example, 123.1.2.3/24) to be allowed. :vartype value: str """ @@ -360,8 +359,8 @@ class IpRule(_serialization.Model): def __init__(self, *, value: Optional[str] = None, **kwargs: Any) -> None: """ - :keyword value: Value corresponding to a single IPv4 address (eg., 123.1.2.3) or an IP range in - CIDR format (eg., 123.1.2.3/24) to be allowed. + :keyword value: Value corresponding to a single IPv4 address (for example, 123.1.2.3) or an IP + range in CIDR format (for example, 123.1.2.3/24) to be allowed. :paramtype value: str """ super().__init__(**kwargs) @@ -369,11 +368,11 @@ def __init__(self, *, value: Optional[str] = None, **kwargs: Any) -> None: class ListQueryKeysResult(_serialization.Model): - """Response containing the query API keys for a given Azure Cognitive Search service. + """Response containing the query API keys for a given search service. Variables are only populated by the server, and will be ignored when sending a request. - :ivar value: The query keys for the Azure Cognitive Search service. + :ivar value: The query keys for the search service. :vartype value: list[~azure.mgmt.search.models.QueryKey] :ivar next_link: Request URL that can be used to query next page of query keys. Returned when the total number of requested query keys exceed maximum page size. @@ -398,14 +397,11 @@ def __init__(self, **kwargs: Any) -> None: class NetworkRuleSet(_serialization.Model): - """Network specific rules that determine how the Azure Cognitive Search service may be reached. - - :ivar ip_rules: A list of IP restriction rules that defines the inbound network(s) with - allowing access to the search service endpoint. At the meantime, all other public IP networks - are blocked by the firewall. These restriction rules are applied only when the - 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public - interface is not allowed even with any public IP rules, and private endpoint connections would - be the exclusive access method. + """Network-specific rules that determine how the search service can be reached. + + :ivar ip_rules: A list of IP restriction rules used for an IP firewall. Any IPs that do not + match the rules are blocked by the firewall. These rules are only applied when the + 'publicNetworkAccess' of the search service is 'enabled'. :vartype ip_rules: list[~azure.mgmt.search.models.IpRule] """ @@ -415,12 +411,9 @@ class NetworkRuleSet(_serialization.Model): def __init__(self, *, ip_rules: Optional[List["_models.IpRule"]] = None, **kwargs: Any) -> None: """ - :keyword ip_rules: A list of IP restriction rules that defines the inbound network(s) with - allowing access to the search service endpoint. At the meantime, all other public IP networks - are blocked by the firewall. These restriction rules are applied only when the - 'publicNetworkAccess' of the search service is 'enabled'; otherwise, traffic over public - interface is not allowed even with any public IP rules, and private endpoint connections would - be the exclusive access method. + :keyword ip_rules: A list of IP restriction rules used for an IP firewall. Any IPs that do not + match the rules are blocked by the firewall. These rules are only applied when the + 'publicNetworkAccess' of the search service is 'enabled'. :paramtype ip_rules: list[~azure.mgmt.search.models.IpRule] """ super().__init__(**kwargs) @@ -496,7 +489,7 @@ def __init__(self, **kwargs: Any) -> None: class OperationListResult(_serialization.Model): """The result of the request to list REST API operations. It contains a list of operations and a - URL to get the next set of results. + URL to get the next set of results. Variables are only populated by the server, and will be ignored when sending a request. @@ -559,7 +552,7 @@ def __init__(self, **kwargs: Any) -> None: class PrivateEndpointConnection(Resource): - """Describes an existing Private Endpoint connection to the Azure Cognitive Search service. + """Describes an existing private endpoint connection to the search service. Variables are only populated by the server, and will be ignored when sending a request. @@ -571,8 +564,8 @@ class PrivateEndpointConnection(Resource): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar properties: Describes the properties of an existing Private Endpoint connection to the - Azure Cognitive Search service. + :ivar properties: Describes the properties of an existing private endpoint connection to the + search service. :vartype properties: ~azure.mgmt.search.models.PrivateEndpointConnectionProperties """ @@ -593,8 +586,8 @@ def __init__( self, *, properties: Optional["_models.PrivateEndpointConnectionProperties"] = None, **kwargs: Any ) -> None: """ - :keyword properties: Describes the properties of an existing Private Endpoint connection to the - Azure Cognitive Search service. + :keyword properties: Describes the properties of an existing private endpoint connection to the + search service. :paramtype properties: ~azure.mgmt.search.models.PrivateEndpointConnectionProperties """ super().__init__(**kwargs) @@ -632,8 +625,7 @@ def __init__(self, **kwargs: Any) -> None: class PrivateEndpointConnectionProperties(_serialization.Model): - """Describes the properties of an existing Private Endpoint connection to the Azure Cognitive - Search service. + """Describes the properties of an existing Private Endpoint connection to the search service. :ivar private_endpoint: The private endpoint resource from Microsoft.Network provider. :vartype private_endpoint: @@ -645,9 +637,9 @@ class PrivateEndpointConnectionProperties(_serialization.Model): :ivar group_id: The group id from the provider of resource the private link service connection is for. :vartype group_id: str - :ivar provisioning_state: The provisioning state of the private link service connection. Can be - Updating, Deleting, Failed, Succeeded, or Incomplete. Known values are: "Updating", "Deleting", - "Failed", "Succeeded", "Incomplete", and "Canceled". + :ivar provisioning_state: The provisioning state of the private link service connection. Valid + values are Updating, Deleting, Failed, Succeeded, or Incomplete. Known values are: "Updating", + "Deleting", "Failed", "Succeeded", "Incomplete", and "Canceled". :vartype provisioning_state: str or ~azure.mgmt.search.models.PrivateLinkServiceConnectionProvisioningState """ @@ -684,9 +676,9 @@ def __init__( :keyword group_id: The group id from the provider of resource the private link service connection is for. :paramtype group_id: str - :keyword provisioning_state: The provisioning state of the private link service connection. Can - be Updating, Deleting, Failed, Succeeded, or Incomplete. Known values are: "Updating", - "Deleting", "Failed", "Succeeded", "Incomplete", and "Canceled". + :keyword provisioning_state: The provisioning state of the private link service connection. + Valid values are Updating, Deleting, Failed, Succeeded, or Incomplete. Known values are: + "Updating", "Deleting", "Failed", "Succeeded", "Incomplete", and "Canceled". :paramtype provisioning_state: str or ~azure.mgmt.search.models.PrivateLinkServiceConnectionProvisioningState """ @@ -721,8 +713,8 @@ class PrivateEndpointConnectionPropertiesPrivateLinkServiceConnectionState(_seri """Describes the current state of an existing Private Link Service connection to the Azure Private Endpoint. - :ivar status: Status of the the private link service connection. Can be Pending, Approved, - Rejected, or Disconnected. Known values are: "Pending", "Approved", "Rejected", and + :ivar status: Status of the the private link service connection. Valid values are Pending, + Approved, Rejected, or Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected". :vartype status: str or ~azure.mgmt.search.models.PrivateLinkServiceConnectionStatus :ivar description: The description for the private link service connection state. @@ -746,8 +738,8 @@ def __init__( **kwargs: Any ) -> None: """ - :keyword status: Status of the the private link service connection. Can be Pending, Approved, - Rejected, or Disconnected. Known values are: "Pending", "Approved", "Rejected", and + :keyword status: Status of the the private link service connection. Valid values are Pending, + Approved, Rejected, or Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected". :paramtype status: str or ~azure.mgmt.search.models.PrivateLinkServiceConnectionStatus :keyword description: The description for the private link service connection state. @@ -762,7 +754,7 @@ def __init__( class PrivateLinkResource(Resource): - """Describes a supported private link resource for the Azure Cognitive Search service. + """Describes a supported private link resource for the search service. Variables are only populated by the server, and will be ignored when sending a request. @@ -774,8 +766,8 @@ class PrivateLinkResource(Resource): :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar properties: Describes the properties of a supported private link resource for the Azure - Cognitive Search service. + :ivar properties: Describes the properties of a supported private link resource for the search + service. :vartype properties: ~azure.mgmt.search.models.PrivateLinkResourceProperties """ @@ -800,9 +792,9 @@ def __init__(self, **kwargs: Any) -> None: class PrivateLinkResourceProperties(_serialization.Model): - """Describes the properties of a supported private link resource for the Azure Cognitive Search - service. For a given API version, this represents the 'supported' groupIds when creating a - shared private link resource. + """Describes the properties of a supported private link resource for the search service. For a + given API version, this represents the 'supported' groupIds when creating a shared private link + resource. Variables are only populated by the server, and will be ignored when sending a request. @@ -813,7 +805,7 @@ class PrivateLinkResourceProperties(_serialization.Model): :ivar required_zone_names: The list of required DNS zone names of the private link resource. :vartype required_zone_names: list[str] :ivar shareable_private_link_resource_types: The list of resources that are onboarded to - private link service, that are supported by Azure Cognitive Search. + private link service and that are supported by search. :vartype shareable_private_link_resource_types: list[~azure.mgmt.search.models.ShareablePrivateLinkResourceType] """ @@ -868,8 +860,7 @@ def __init__(self, **kwargs: Any) -> None: class QueryKey(_serialization.Model): - """Describes an API key for a given Azure Cognitive Search service that has permissions for query - operations only. + """Describes an API key for a given search service that has permissions for query operations only. Variables are only populated by the server, and will be ignored when sending a request. @@ -897,19 +888,19 @@ def __init__(self, **kwargs: Any) -> None: class QuotaUsageResult(_serialization.Model): - """Describes the quota usage for a particular sku supported by Azure Cognitive Search. + """Describes the quota usage for a particular SKU. Variables are only populated by the server, and will be ignored when sending a request. - :ivar id: The resource id of the quota usage sku endpoint for Microsoft.Search provider. + :ivar id: The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. :vartype id: str - :ivar unit: The unit of measurement for the search sku. + :ivar unit: The unit of measurement for the search SKU. :vartype unit: str - :ivar current_value: The currently used up value for the particular search sku. + :ivar current_value: The currently used up value for the particular search SKU. :vartype current_value: int - :ivar limit: The quota limit for the particular search sku. + :ivar limit: The quota limit for the particular search SKU. :vartype limit: int - :ivar name: The name of the sku supported by Azure Cognitive Search. + :ivar name: The name of the SKU supported by Azure AI Search. :vartype name: ~azure.mgmt.search.models.QuotaUsageResultName """ @@ -935,13 +926,13 @@ def __init__( **kwargs: Any ) -> None: """ - :keyword id: The resource id of the quota usage sku endpoint for Microsoft.Search provider. + :keyword id: The resource ID of the quota usage SKU endpoint for Microsoft.Search provider. :paramtype id: str - :keyword unit: The unit of measurement for the search sku. + :keyword unit: The unit of measurement for the search SKU. :paramtype unit: str - :keyword current_value: The currently used up value for the particular search sku. + :keyword current_value: The currently used up value for the particular search SKU. :paramtype current_value: int - :keyword limit: The quota limit for the particular search sku. + :keyword limit: The quota limit for the particular search SKU. :paramtype limit: int """ super().__init__(**kwargs) @@ -953,12 +944,11 @@ def __init__( class QuotaUsageResultName(_serialization.Model): - """The name of the sku supported by Azure Cognitive Search. + """The name of the SKU supported by Azure AI Search. - :ivar value: The sku name supported by Azure Cognitive Search. + :ivar value: The SKU name supported by Azure AI Search. :vartype value: str - :ivar localized_value: The localized string value for the sku supported by Azure Cognitive - Search. + :ivar localized_value: The localized string value for the SKU name. :vartype localized_value: str """ @@ -969,10 +959,9 @@ class QuotaUsageResultName(_serialization.Model): def __init__(self, *, value: Optional[str] = None, localized_value: Optional[str] = None, **kwargs: Any) -> None: """ - :keyword value: The sku name supported by Azure Cognitive Search. + :keyword value: The SKU name supported by Azure AI Search. :paramtype value: str - :keyword localized_value: The localized string value for the sku supported by Azure Cognitive - Search. + :keyword localized_value: The localized string value for the SKU name. :paramtype localized_value: str """ super().__init__(**kwargs) @@ -981,12 +970,11 @@ def __init__(self, *, value: Optional[str] = None, localized_value: Optional[str class QuotaUsagesListResult(_serialization.Model): - """Response containing the quota usage information for all the supported skus of Azure Cognitive - Search service. + """Response containing the quota usage information for all the supported SKUs of Azure AI Search. Variables are only populated by the server, and will be ignored when sending a request. - :ivar value: The quota usages for the SKUs supported by Azure Cognitive Search. + :ivar value: The quota usages for the SKUs supported by Azure AI Search. :vartype value: list[~azure.mgmt.search.models.QuotaUsageResult] :ivar next_link: Request URL that can be used to query next page of quota usages. Returned when the total number of requested quota usages exceed maximum page size. @@ -1082,7 +1070,7 @@ def __init__(self, *, location: str, tags: Optional[Dict[str, str]] = None, **kw class SearchService(TrackedResource): # pylint: disable=too-many-instance-attributes - """Describes an Azure Cognitive Search service and its current state. + """Describes a search service and its current state. Variables are only populated by the server, and will be ignored when sending a request. @@ -1100,8 +1088,8 @@ class SearchService(TrackedResource): # pylint: disable=too-many-instance-attri :vartype tags: dict[str, str] :ivar location: The geo-location where the resource lives. Required. :vartype location: str - :ivar sku: The SKU of the Search Service, which determines price tier and capacity limits. This - property is required when creating a new Search Service. + :ivar sku: The SKU of the search service, which determines billing rate and capacity limits. + This property is required when creating a new search service. :vartype sku: ~azure.mgmt.search.models.Sku :ivar identity: The identity of the resource. :vartype identity: ~azure.mgmt.search.models.Identity @@ -1130,10 +1118,10 @@ class SearchService(TrackedResource): # pylint: disable=too-many-instance-attri units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error - state. If your service is in the degraded, disabled, or error states, it means the Azure - Cognitive Search team is actively investigating the underlying issue. Dedicated services in - these states are still chargeable based on the number of search units provisioned. Known values - are: "running", "provisioning", "deleting", "degraded", "disabled", and "error". + state. If your service is in the degraded, disabled, or error states, Microsoft is actively + investigating the underlying issue. Dedicated services in these states are still chargeable + based on the number of search units provisioned. Known values are: "running", "provisioning", + "deleting", "degraded", "disabled", and "error". :vartype status: str or ~azure.mgmt.search.models.SearchServiceStatus :ivar status_details: The details of the search service status. :vartype status_details: str @@ -1147,8 +1135,8 @@ class SearchService(TrackedResource): # pylint: disable=too-many-instance-attri uses capacity that is already set up. Known values are: "succeeded", "provisioning", and "failed". :vartype provisioning_state: str or ~azure.mgmt.search.models.ProvisioningState - :ivar network_rule_set: Network specific rules that determine how the Azure Cognitive Search - service may be reached. + :ivar network_rule_set: Network-specific rules that determine how the search service may be + reached. :vartype network_rule_set: ~azure.mgmt.search.models.NetworkRuleSet :ivar encryption_with_cmk: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. @@ -1160,16 +1148,16 @@ class SearchService(TrackedResource): # pylint: disable=too-many-instance-attri :ivar auth_options: Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. :vartype auth_options: ~azure.mgmt.search.models.DataPlaneAuthOptions - :ivar private_endpoint_connections: The list of private endpoint connections to the Azure - Cognitive Search service. + :ivar private_endpoint_connections: The list of private endpoint connections to the search + service. :vartype private_endpoint_connections: list[~azure.mgmt.search.models.PrivateEndpointConnection] :ivar semantic_search: Sets options that control the availability of semantic search. This - configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. - Known values are: "disabled", "free", and "standard". + configuration is only possible for certain search SKUs in certain locations. Known values are: + "disabled", "free", and "standard". :vartype semantic_search: str or ~azure.mgmt.search.models.SearchSemanticSearch :ivar shared_private_link_resources: The list of shared private link resources managed by the - Azure Cognitive Search service. + search service. :vartype shared_private_link_resources: list[~azure.mgmt.search.models.SharedPrivateLinkResource] """ @@ -1241,8 +1229,8 @@ def __init__( :paramtype tags: dict[str, str] :keyword location: The geo-location where the resource lives. Required. :paramtype location: str - :keyword sku: The SKU of the Search Service, which determines price tier and capacity limits. - This property is required when creating a new Search Service. + :keyword sku: The SKU of the search service, which determines billing rate and capacity limits. + This property is required when creating a new search service. :paramtype sku: ~azure.mgmt.search.models.Sku :keyword identity: The identity of the resource. :paramtype identity: ~azure.mgmt.search.models.Identity @@ -1266,8 +1254,8 @@ def __init__( is not allowed, and private endpoint connections would be the exclusive access method. Known values are: "enabled" and "disabled". :paramtype public_network_access: str or ~azure.mgmt.search.models.PublicNetworkAccess - :keyword network_rule_set: Network specific rules that determine how the Azure Cognitive Search - service may be reached. + :keyword network_rule_set: Network-specific rules that determine how the search service may be + reached. :paramtype network_rule_set: ~azure.mgmt.search.models.NetworkRuleSet :keyword encryption_with_cmk: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. @@ -1280,8 +1268,8 @@ def __init__( authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. :paramtype auth_options: ~azure.mgmt.search.models.DataPlaneAuthOptions :keyword semantic_search: Sets options that control the availability of semantic search. This - configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. - Known values are: "disabled", "free", and "standard". + configuration is only possible for certain search SKUs in certain locations. Known values are: + "disabled", "free", and "standard". :paramtype semantic_search: str or ~azure.mgmt.search.models.SearchSemanticSearch """ super().__init__(tags=tags, location=location, **kwargs) @@ -1304,11 +1292,11 @@ def __init__( class SearchServiceListResult(_serialization.Model): - """Response containing a list of Azure Cognitive Search services. + """Response containing a list of search services. Variables are only populated by the server, and will be ignored when sending a request. - :ivar value: The list of Search services. + :ivar value: The list of search services. :vartype value: list[~azure.mgmt.search.models.SearchService] :ivar next_link: Request URL that can be used to query next page of search services. Returned when the total number of requested search services exceed maximum page size. @@ -1333,7 +1321,7 @@ def __init__(self, **kwargs: Any) -> None: class SearchServiceUpdate(Resource): # pylint: disable=too-many-instance-attributes - """The parameters used to update an Azure Cognitive Search service. + """The parameters used to update a search service. Variables are only populated by the server, and will be ignored when sending a request. @@ -1345,11 +1333,11 @@ class SearchServiceUpdate(Resource): # pylint: disable=too-many-instance-attrib :ivar type: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". :vartype type: str - :ivar sku: The SKU of the Search Service, which determines price tier and capacity limits. This - property is required when creating a new Search Service. + :ivar sku: The SKU of the search service, which determines the billing rate and capacity + limits. This property is required when creating a new search service. :vartype sku: ~azure.mgmt.search.models.Sku :ivar location: The geographic location of the resource. This must be one of the supported and - registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). + registered Azure geo regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource. :vartype location: str :ivar tags: Tags to help categorize the resource in the Azure portal. @@ -1381,10 +1369,10 @@ class SearchServiceUpdate(Resource): # pylint: disable=too-many-instance-attrib units are not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error - state. If your service is in the degraded, disabled, or error states, it means the Azure - Cognitive Search team is actively investigating the underlying issue. Dedicated services in - these states are still chargeable based on the number of search units provisioned. Known values - are: "running", "provisioning", "deleting", "degraded", "disabled", and "error". + state. If your service is in the degraded, disabled, or error states, Microsoft is actively + investigating the underlying issue. Dedicated services in these states are still chargeable + based on the number of search units provisioned. Known values are: "running", "provisioning", + "deleting", "degraded", "disabled", and "error". :vartype status: str or ~azure.mgmt.search.models.SearchServiceStatus :ivar status_details: The details of the search service status. :vartype status_details: str @@ -1398,8 +1386,8 @@ class SearchServiceUpdate(Resource): # pylint: disable=too-many-instance-attrib uses capacity that is already set up. Known values are: "succeeded", "provisioning", and "failed". :vartype provisioning_state: str or ~azure.mgmt.search.models.ProvisioningState - :ivar network_rule_set: Network specific rules that determine how the Azure Cognitive Search - service may be reached. + :ivar network_rule_set: Network-specific rules that determine how the search service may be + reached. :vartype network_rule_set: ~azure.mgmt.search.models.NetworkRuleSet :ivar encryption_with_cmk: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. @@ -1411,16 +1399,16 @@ class SearchServiceUpdate(Resource): # pylint: disable=too-many-instance-attrib :ivar auth_options: Defines the options for how the data plane API of a search service authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. :vartype auth_options: ~azure.mgmt.search.models.DataPlaneAuthOptions - :ivar private_endpoint_connections: The list of private endpoint connections to the Azure - Cognitive Search service. + :ivar private_endpoint_connections: The list of private endpoint connections to the search + service. :vartype private_endpoint_connections: list[~azure.mgmt.search.models.PrivateEndpointConnection] :ivar semantic_search: Sets options that control the availability of semantic search. This - configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. - Known values are: "disabled", "free", and "standard". + configuration is only possible for certain search SKUs in certain locations. Known values are: + "disabled", "free", and "standard". :vartype semantic_search: str or ~azure.mgmt.search.models.SearchSemanticSearch :ivar shared_private_link_resources: The list of shared private link resources managed by the - Azure Cognitive Search service. + search service. :vartype shared_private_link_resources: list[~azure.mgmt.search.models.SharedPrivateLinkResource] """ @@ -1487,11 +1475,11 @@ def __init__( **kwargs: Any ) -> None: """ - :keyword sku: The SKU of the Search Service, which determines price tier and capacity limits. - This property is required when creating a new Search Service. + :keyword sku: The SKU of the search service, which determines the billing rate and capacity + limits. This property is required when creating a new search service. :paramtype sku: ~azure.mgmt.search.models.Sku :keyword location: The geographic location of the resource. This must be one of the supported - and registered Azure Geo Regions (for example, West US, East US, Southeast Asia, and so forth). + and registered Azure geo regions (for example, West US, East US, Southeast Asia, and so forth). This property is required when creating a new resource. :paramtype location: str :keyword tags: Tags to help categorize the resource in the Azure portal. @@ -1518,8 +1506,8 @@ def __init__( is not allowed, and private endpoint connections would be the exclusive access method. Known values are: "enabled" and "disabled". :paramtype public_network_access: str or ~azure.mgmt.search.models.PublicNetworkAccess - :keyword network_rule_set: Network specific rules that determine how the Azure Cognitive Search - service may be reached. + :keyword network_rule_set: Network-specific rules that determine how the search service may be + reached. :paramtype network_rule_set: ~azure.mgmt.search.models.NetworkRuleSet :keyword encryption_with_cmk: Specifies any policy regarding encryption of resources (such as indexes) using customer manager keys within a search service. @@ -1532,8 +1520,8 @@ def __init__( authenticates requests. This cannot be set if 'disableLocalAuth' is set to true. :paramtype auth_options: ~azure.mgmt.search.models.DataPlaneAuthOptions :keyword semantic_search: Sets options that control the availability of semantic search. This - configuration is only possible for certain Azure Cognitive Search SKUs in certain locations. - Known values are: "disabled", "free", and "standard". + configuration is only possible for certain search SKUs in certain locations. Known values are: + "disabled", "free", and "standard". :paramtype semantic_search: str or ~azure.mgmt.search.models.SearchSemanticSearch """ super().__init__(**kwargs) @@ -1558,19 +1546,19 @@ def __init__( class ShareablePrivateLinkResourceProperties(_serialization.Model): - """Describes the properties of a resource type that has been onboarded to private link service, - supported by Azure Cognitive Search. + """Describes the properties of a resource type that has been onboarded to private link service and + that's supported by search. Variables are only populated by the server, and will be ignored when sending a request. :ivar type: The resource provider type for the resource that has been onboarded to private link - service, supported by Azure Cognitive Search. + service and that's supported by search. :vartype type: str :ivar group_id: The resource provider group id for the resource that has been onboarded to - private link service, supported by Azure Cognitive Search. + private link service and that's supported by search. :vartype group_id: str :ivar description: The description of the resource type that has been onboarded to private link - service, supported by Azure Cognitive Search. + service and that's supported by search. :vartype description: str """ @@ -1595,16 +1583,16 @@ def __init__(self, **kwargs: Any) -> None: class ShareablePrivateLinkResourceType(_serialization.Model): - """Describes an resource type that has been onboarded to private link service, supported by Azure - Cognitive Search. + """Describes a resource type that has been onboarded to private link service and that's supported + by search. Variables are only populated by the server, and will be ignored when sending a request. - :ivar name: The name of the resource type that has been onboarded to private link service, - supported by Azure Cognitive Search. + :ivar name: The name of the resource type that has been onboarded to private link service and + that's supported by search. :vartype name: str :ivar properties: Describes the properties of a resource type that has been onboarded to - private link service, supported by Azure Cognitive Search. + private link service and that's supported by search. :vartype properties: ~azure.mgmt.search.models.ShareablePrivateLinkResourceProperties """ @@ -1626,7 +1614,7 @@ def __init__(self, **kwargs: Any) -> None: class SharedPrivateLinkResource(Resource): - """Describes a Shared Private Link Resource managed by the Azure Cognitive Search service. + """Describes a Shared Private Link Resource managed by the search service. Variables are only populated by the server, and will be ignored when sending a request. @@ -1639,7 +1627,7 @@ class SharedPrivateLinkResource(Resource): "Microsoft.Storage/storageAccounts". :vartype type: str :ivar properties: Describes the properties of a Shared Private Link Resource managed by the - Azure Cognitive Search service. + search service. :vartype properties: ~azure.mgmt.search.models.SharedPrivateLinkResourceProperties """ @@ -1661,7 +1649,7 @@ def __init__( ) -> None: """ :keyword properties: Describes the properties of a Shared Private Link Resource managed by the - Azure Cognitive Search service. + search service. :paramtype properties: ~azure.mgmt.search.models.SharedPrivateLinkResourceProperties """ super().__init__(**kwargs) @@ -1701,8 +1689,8 @@ def __init__(self, *, next_link: Optional[str] = None, **kwargs: Any) -> None: class SharedPrivateLinkResourceProperties(_serialization.Model): - """Describes the properties of an existing Shared Private Link Resource managed by the Azure - Cognitive Search service. + """Describes the properties of an existing Shared Private Link Resource managed by the search + service. :ivar private_link_resource_id: The resource id of the resource the shared private link resource is for. @@ -1717,12 +1705,13 @@ class SharedPrivateLinkResourceProperties(_serialization.Model): the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). :vartype resource_region: str - :ivar status: Status of the shared private link resource. Can be Pending, Approved, Rejected or - Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected". + :ivar status: Status of the shared private link resource. Valid values are Pending, Approved, + Rejected or Disconnected. Known values are: "Pending", "Approved", "Rejected", and + "Disconnected". :vartype status: str or ~azure.mgmt.search.models.SharedPrivateLinkResourceStatus - :ivar provisioning_state: The provisioning state of the shared private link resource. Can be - Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: "Updating", "Deleting", - "Failed", "Succeeded", and "Incomplete". + :ivar provisioning_state: The provisioning state of the shared private link resource. Valid + values are Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: "Updating", + "Deleting", "Failed", "Succeeded", and "Incomplete". :vartype provisioning_state: str or ~azure.mgmt.search.models.SharedPrivateLinkResourceProvisioningState """ @@ -1761,12 +1750,13 @@ def __init__( of the resource to which a shared private link is to be created. This is only required for those resources whose DNS configuration are regional (such as Azure Kubernetes Service). :paramtype resource_region: str - :keyword status: Status of the shared private link resource. Can be Pending, Approved, Rejected - or Disconnected. Known values are: "Pending", "Approved", "Rejected", and "Disconnected". + :keyword status: Status of the shared private link resource. Valid values are Pending, + Approved, Rejected or Disconnected. Known values are: "Pending", "Approved", "Rejected", and + "Disconnected". :paramtype status: str or ~azure.mgmt.search.models.SharedPrivateLinkResourceStatus - :keyword provisioning_state: The provisioning state of the shared private link resource. Can be - Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: "Updating", "Deleting", - "Failed", "Succeeded", and "Incomplete". + :keyword provisioning_state: The provisioning state of the shared private link resource. Valid + values are Updating, Deleting, Failed, Succeeded or Incomplete. Known values are: "Updating", + "Deleting", "Failed", "Succeeded", and "Incomplete". :paramtype provisioning_state: str or ~azure.mgmt.search.models.SharedPrivateLinkResourceProvisioningState """ @@ -1780,8 +1770,7 @@ def __init__( class Sku(_serialization.Model): - """Defines the SKU of an Azure Cognitive Search Service, which determines price tier and capacity - limits. + """Defines the SKU of a search service, which determines billing rate and capacity limits. :ivar name: The SKU of the search service. Valid values include: 'free': Shared service. 'basic': Dedicated service with up to 3 replicas. 'standard': Dedicated service with up to 12 diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/models/_search_management_client_enums.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/models/_search_management_client_enums.py index 4b592680bca0..25169d06f377 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/models/_search_management_client_enums.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/models/_search_management_client_enums.py @@ -11,7 +11,7 @@ class AadAuthFailureMode(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Describes what response the data plane API of a Search service would send for requests that + """Describes what response the data plane API of a search service would send for requests that failed authentication. """ @@ -53,8 +53,8 @@ class IdentityType(str, Enum, metaclass=CaseInsensitiveEnumMeta): class PrivateLinkServiceConnectionProvisioningState(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The provisioning state of the private link service connection. Can be Updating, Deleting, - Failed, Succeeded, or Incomplete. + """The provisioning state of the private link service connection. Valid values are Updating, + Deleting, Failed, Succeeded, or Incomplete. """ UPDATING = "Updating" @@ -74,8 +74,8 @@ class PrivateLinkServiceConnectionProvisioningState(str, Enum, metaclass=CaseIns class PrivateLinkServiceConnectionStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Status of the the private link service connection. Can be Pending, Approved, Rejected, or - Disconnected. + """Status of the the private link service connection. Valid values are Pending, Approved, + Rejected, or Disconnected. """ PENDING = "Pending" @@ -117,27 +117,27 @@ class PublicNetworkAccess(str, Enum, metaclass=CaseInsensitiveEnumMeta): class SearchEncryptionComplianceStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Describes whether the search service is compliant or not with respect to having non customer - encrypted resources. If a service has more than one non customer encrypted resource and - 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'. + """Describes whether the search service is compliant or not with respect to having + non-customer-encrypted resources. If a service has more than one non-customer-encrypted + resource and 'Enforcement' is 'enabled' then the service will be marked as 'nonCompliant'. """ COMPLIANT = "Compliant" - """Indicates that the search service is compliant, either because number of non customer encrypted + """Indicates that the search service is compliant, either because number of non-customer-encrypted #: resources is zero or enforcement is disabled.""" NON_COMPLIANT = "NonCompliant" - """Indicates that the search service has more than 1 non customer encrypted resources.""" + """Indicates that the search service has more than one non-customer-encrypted resources.""" class SearchEncryptionWithCmk(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Describes how a search service should enforce having one or more non customer encrypted + """Describes how a search service should enforce having one or more non-customer-encrypted resources. """ DISABLED = "Disabled" - """No enforcement will be made and the search service can have non customer encrypted resources.""" + """No enforcement will be made and the search service can have non-customer-encrypted resources.""" ENABLED = "Enabled" - """Search service will be marked as non-compliant if there are one or more non customer encrypted + """Search service will be marked as non-compliant if there are one or more non-customer-encrypted #: resources.""" UNSPECIFIED = "Unspecified" """Enforcement policy is not explicitly specified, with the behavior being the same as if it were @@ -145,19 +145,19 @@ class SearchEncryptionWithCmk(str, Enum, metaclass=CaseInsensitiveEnumMeta): class SearchSemanticSearch(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Sets options that control the availability of semantic search. This configuration is only - possible for certain Azure Cognitive Search SKUs in certain locations. + """Sets options that control the availability of semantic ranking. This configuration is only + possible for certain search SKUs in certain locations. """ DISABLED = "disabled" - """Indicates that semantic search is disabled for the search service.""" + """Indicates that semantic ranking is disabled for the search service.""" FREE = "free" - """Enables semantic search on a search service and indicates that it is to be used within the - #: limits of the free tier. This would cap the volume of semantic search requests and is offered + """Enables semantic ranking on a search service and indicates that it is to be used within the + #: limits of the free tier. This would cap the volume of semantic ranking requests and is offered #: at no extra charge. This is the default for newly provisioned search services.""" STANDARD = "standard" - """Enables semantic search on a search service as a billable feature, with higher throughput and - #: volume of semantic search queries.""" + """Enables semantic ranking on a search service as a billable feature, with higher throughput and + #: volume of semantic ranking requests.""" class SearchServiceStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): @@ -168,9 +168,9 @@ class SearchServiceStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): not healthy. The search service is most likely operational, but performance might be slow and some requests might be dropped. 'disabled': The search service is disabled. In this state, the service will reject all API requests. 'error': The search service is in an error state. If your - service is in the degraded, disabled, or error states, it means the Azure Cognitive Search team - is actively investigating the underlying issue. Dedicated services in these states are still - chargeable based on the number of search units provisioned. + service is in the degraded, disabled, or error states, Microsoft is actively investigating the + underlying issue. Dedicated services in these states are still chargeable based on the number + of search units provisioned. """ RUNNING = "running" @@ -197,8 +197,8 @@ class SharedPrivateLinkResourceAsyncOperationResult(str, Enum, metaclass=CaseIns class SharedPrivateLinkResourceProvisioningState(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """The provisioning state of the shared private link resource. Can be Updating, Deleting, Failed, - Succeeded or Incomplete. + """The provisioning state of the shared private link resource. Valid values are Updating, + Deleting, Failed, Succeeded or Incomplete. """ UPDATING = "Updating" @@ -209,7 +209,9 @@ class SharedPrivateLinkResourceProvisioningState(str, Enum, metaclass=CaseInsens class SharedPrivateLinkResourceStatus(str, Enum, metaclass=CaseInsensitiveEnumMeta): - """Status of the shared private link resource. Can be Pending, Approved, Rejected or Disconnected.""" + """Status of the shared private link resource. Valid values are Pending, Approved, Rejected or + Disconnected. + """ PENDING = "Pending" APPROVED = "Approved" @@ -228,20 +230,20 @@ class SkuName(str, Enum, metaclass=CaseInsensitiveEnumMeta): """ FREE = "free" - """Free tier, with no SLA guarantees and a subset of features offered to paid tiers.""" + """Free tier, with no SLA guarantees and a subset of the features offered on billable tiers.""" BASIC = "basic" - """Paid tier dedicated service with up to 3 replicas.""" + """Billable tier for a dedicated service having up to 3 replicas.""" STANDARD = "standard" - """Paid tier dedicated service with up to 12 partitions and 12 replicas.""" + """Billable tier for a dedicated service having up to 12 partitions and 12 replicas.""" STANDARD2 = "standard2" """Similar to 'standard', but with more capacity per search unit.""" STANDARD3 = "standard3" """The largest Standard offering with up to 12 partitions and 12 replicas (or up to 3 partitions #: with more indexes if you also set the hostingMode property to 'highDensity').""" STORAGE_OPTIMIZED_L1 = "storage_optimized_l1" - """Paid tier dedicated service that supports 1TB per partition, up to 12 partitions.""" + """Billable tier for a dedicated service that supports 1TB per partition, up to 12 partitions.""" STORAGE_OPTIMIZED_L2 = "storage_optimized_l2" - """Paid tier dedicated service that supports 2TB per partition, up to 12 partitions.""" + """Billable tier for a dedicated service that supports 2TB per partition, up to 12 partitions.""" class UnavailableNameReason(str, Enum, metaclass=CaseInsensitiveEnumMeta): diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_admin_keys_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_admin_keys_operations.py index 3685b1476585..bdef45e9fc77 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_admin_keys_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_admin_keys_operations.py @@ -139,7 +139,7 @@ def get( search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None, **kwargs: Any ) -> _models.AdminKeyResult: - """Gets the primary and secondary admin API keys for the specified Azure Cognitive Search service. + """Gets the primary and secondary admin API keys for the specified search service. .. seealso:: - https://aka.ms/search-manage @@ -147,8 +147,8 @@ def get( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -229,8 +229,8 @@ def regenerate( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param key_kind: Specifies which key to regenerate. Valid values include 'primary' and 'secondary'. Known values are: "primary" and "secondary". Required. diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_private_endpoint_connections_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_private_endpoint_connections_operations.py index ddb7dfec8c20..f028c8a6950c 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_private_endpoint_connections_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_private_endpoint_connections_operations.py @@ -243,11 +243,11 @@ def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param private_endpoint_connection: The definition of the private endpoint connection to update. Required. @@ -284,11 +284,11 @@ def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param private_endpoint_connection: The definition of the private endpoint connection to update. Required. @@ -323,11 +323,11 @@ def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param private_endpoint_connection: The definition of the private endpoint connection to update. Is either a PrivateEndpointConnection type or a IO type. Required. @@ -426,11 +426,11 @@ def get( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -511,11 +511,11 @@ def delete( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param private_endpoint_connection_name: The name of the private endpoint connection to the - Azure Cognitive Search service with the specified resource group. Required. + search service with the specified resource group. Required. :type private_endpoint_connection_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -597,8 +597,8 @@ def list_by_service( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_private_link_resources_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_private_link_resources_operations.py index 36e82e4fd989..b1d791c7cfc7 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_private_link_resources_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_private_link_resources_operations.py @@ -109,8 +109,8 @@ def list_supported( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_query_keys_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_query_keys_operations.py index 72f9c436280a..f208b473e9d2 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_query_keys_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_query_keys_operations.py @@ -191,8 +191,8 @@ def create( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param name: The name of the new query API key. Required. :type name: str @@ -266,7 +266,7 @@ def list_by_search_service( search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None, **kwargs: Any ) -> Iterable["_models.QueryKey"]: - """Returns the list of query API keys for the given Azure Cognitive Search service. + """Returns the list of query API keys for the given search service. .. seealso:: - https://aka.ms/search-manage @@ -274,8 +274,8 @@ def list_by_search_service( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -382,8 +382,8 @@ def delete( # pylint: disable=inconsistent-return-statements :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param key: The query key to be deleted. Query keys are identified by value, not by name. Required. diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_search_management_client_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_search_management_client_operations.py index 79f48eba960b..617e8288ee20 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_search_management_client_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_search_management_client_operations.py @@ -76,15 +76,14 @@ def usage_by_subscription_sku( search_management_request_options: Optional[_models.SearchManagementRequestOptions] = None, **kwargs: Any ) -> _models.QuotaUsageResult: - """Gets the quota usage for a search sku in the given subscription. + """Gets the quota usage for a search SKU in the given subscription. .. seealso:: - https://aka.ms/search-manage :param location: The unique location name for a Microsoft Azure geographic region. Required. :type location: str - :param sku_name: The unique search service sku name supported by Azure Cognitive Search. - Required. + :param sku_name: The unique SKU name that identifies a billable tier. Required. :type sku_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_services_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_services_operations.py index 60f6fd31a764..768d1ce1afee 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_services_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_services_operations.py @@ -411,12 +411,12 @@ def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to create or update. - Search service names must only contain lowercase letters, digits or dashes, cannot use dash as - the first two or last one characters, cannot contain consecutive dashes, and must be between 2 - and 60 characters in length. Search service names must be globally unique since they are part - of the service URI (https://:code:``.search.windows.net). You cannot change the service - name after the service is created. Required. + :param search_service_name: The name of the search service to create or update. Search service + names must only contain lowercase letters, digits or dashes, cannot use dash as the first two + or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 + characters in length. Search service names must be globally unique since they are part of the + service URI (https://:code:``.search.windows.net). You cannot change the service name + after the service is created. Required. :type search_service_name: str :param service: The definition of the search service to create or update. Required. :type service: ~azure.mgmt.search.models.SearchService @@ -460,12 +460,12 @@ def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to create or update. - Search service names must only contain lowercase letters, digits or dashes, cannot use dash as - the first two or last one characters, cannot contain consecutive dashes, and must be between 2 - and 60 characters in length. Search service names must be globally unique since they are part - of the service URI (https://:code:``.search.windows.net). You cannot change the service - name after the service is created. Required. + :param search_service_name: The name of the search service to create or update. Search service + names must only contain lowercase letters, digits or dashes, cannot use dash as the first two + or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 + characters in length. Search service names must be globally unique since they are part of the + service URI (https://:code:``.search.windows.net). You cannot change the service name + after the service is created. Required. :type search_service_name: str :param service: The definition of the search service to create or update. Required. :type service: IO @@ -507,12 +507,12 @@ def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to create or update. - Search service names must only contain lowercase letters, digits or dashes, cannot use dash as - the first two or last one characters, cannot contain consecutive dashes, and must be between 2 - and 60 characters in length. Search service names must be globally unique since they are part - of the service URI (https://:code:``.search.windows.net). You cannot change the service - name after the service is created. Required. + :param search_service_name: The name of the search service to create or update. Search service + names must only contain lowercase letters, digits or dashes, cannot use dash as the first two + or last one characters, cannot contain consecutive dashes, and must be between 2 and 60 + characters in length. Search service names must be globally unique since they are part of the + service URI (https://:code:``.search.windows.net). You cannot change the service name + after the service is created. Required. :type search_service_name: str :param service: The definition of the search service to create or update. Is either a SearchService type or a IO type. Required. @@ -604,7 +604,7 @@ def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to update. Required. + :param search_service_name: The name of the search service to update. Required. :type search_service_name: str :param service: The definition of the search service to update. Required. :type service: ~azure.mgmt.search.models.SearchServiceUpdate @@ -639,7 +639,7 @@ def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to update. Required. + :param search_service_name: The name of the search service to update. Required. :type search_service_name: str :param service: The definition of the search service to update. Required. :type service: IO @@ -672,7 +672,7 @@ def update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service to update. Required. + :param search_service_name: The name of the search service to update. Required. :type search_service_name: str :param service: The definition of the search service to update. Is either a SearchServiceUpdate type or a IO type. Required. @@ -768,8 +768,8 @@ def get( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -848,8 +848,8 @@ def delete( # pylint: disable=inconsistent-return-statements :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: diff --git a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_shared_private_link_resources_operations.py b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_shared_private_link_resources_operations.py index 055cdd6ff6c6..d2d2291b0be8 100644 --- a/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_shared_private_link_resources_operations.py +++ b/sdk/search/azure-mgmt-search/azure/mgmt/search/operations/_shared_private_link_resources_operations.py @@ -322,11 +322,11 @@ def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param shared_private_link_resource: The definition of the shared private link resource to create or update. Required. @@ -372,11 +372,11 @@ def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param shared_private_link_resource: The definition of the shared private link resource to create or update. Required. @@ -420,11 +420,11 @@ def begin_create_or_update( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param shared_private_link_resource: The definition of the shared private link resource to create or update. Is either a SharedPrivateLinkResource type or a IO type. Required. @@ -518,11 +518,11 @@ def get( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -661,11 +661,11 @@ def begin_delete( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param shared_private_link_resource_name: The name of the shared private link resource managed - by the Azure Cognitive Search service within the specified resource group. Required. + by the search service within the specified resource group. Required. :type shared_private_link_resource_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: @@ -745,8 +745,8 @@ def list_by_service( :param resource_group_name: The name of the resource group within the current subscription. You can obtain this value from the Azure Resource Manager API or the portal. Required. :type resource_group_name: str - :param search_service_name: The name of the Azure Cognitive Search service associated with the - specified resource group. Required. + :param search_service_name: The name of the search service associated with the specified + resource group. Required. :type search_service_name: str :param search_management_request_options: Parameter group. Default value is None. :type search_management_request_options: