azure.mgmt.search.operations module

class azure.mgmt.search.operations.AdminKeysOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s admin_keys attribute.

get(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → AdminKeyResult[source]

Gets the primary and secondary admin API keys for the specified Azure AI Search service.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

AdminKeyResult or the result of cls(response)

Return type:

AdminKeyResult

Raises:

HttpResponseError –

regenerate(resource_group_name: str, search_service_name: str, key_kind: str | AdminKeyKind, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → AdminKeyResult[source]

Regenerates either the primary or secondary admin API key. You can only regenerate one key at a time.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • key_kind (str or AdminKeyKind) – Specifies which key to regenerate. Valid values include ‘primary’ and ‘secondary’. Known values are: “primary” and “secondary”. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

AdminKeyResult or the result of cls(response)

Return type:

AdminKeyResult

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.NetworkSecurityPerimeterConfigurationsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s network_security_perimeter_configurations attribute.

begin_reconcile(resource_group_name: str, search_service_name: str, nsp_config_name: str, **kwargs: Any) → LROPoller[None][source]

Reconcile network security perimeter configuration for the Azure AI Search resource provider. This triggers a manual resync with network security perimeter configurations by ensuring the search service carries the latest configuration.

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • nsp_config_name (str) – The network security configuration name. Required.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, search_service_name: str, nsp_config_name: str, **kwargs: Any) → NetworkSecurityPerimeterConfiguration[source]

Gets a network security perimeter configuration.

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • nsp_config_name (str) – The network security configuration name. Required.

Returns:

NetworkSecurityPerimeterConfiguration or the result of cls(response)

Return type:

NetworkSecurityPerimeterConfiguration

Raises:

HttpResponseError –

list_by_service(resource_group_name: str, search_service_name: str, **kwargs: Any) → Iterable[NetworkSecurityPerimeterConfiguration][source]

Gets a list of network security perimeter configurations for a search service.

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

Returns:

An iterator like instance of either NetworkSecurityPerimeterConfiguration or the result of cls(response)

Return type:

ItemPaged[NetworkSecurityPerimeterConfiguration]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.OfferingsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s offerings attribute.

list(**kwargs: Any) → Iterable[OfferingsByRegion][source]

Lists all of the features and SKUs offered by the Azure AI Search service in each region.

Returns:

An iterator like instance of either OfferingsByRegion or the result of cls(response)

Return type:

ItemPaged[OfferingsByRegion]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.Operations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[Operation][source]

Lists all of the available REST API operations of the Microsoft.Search provider.

Returns:

An iterator like instance of either Operation or the result of cls(response)

Return type:

ItemPaged[Operation]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.PrivateEndpointConnectionsOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s private_endpoint_connections attribute.

delete(resource_group_name: str, search_service_name: str, private_endpoint_connection_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → PrivateEndpointConnection | None[source]

Disconnects the private endpoint connection and deletes it from the search service.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection to the Azure AI Search service with the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

PrivateEndpointConnection or None or the result of cls(response)

Return type:

PrivateEndpointConnection or None

Raises:

HttpResponseError –

get(resource_group_name: str, search_service_name: str, private_endpoint_connection_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → PrivateEndpointConnection[source]

Gets the details of the private endpoint connection to the search service in the given resource group.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection to the Azure AI Search service with the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

list_by_service(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → Iterable[PrivateEndpointConnection][source]

Gets a list of all private endpoint connections in the given service.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An iterator like instance of either PrivateEndpointConnection or the result of cls(response)

Return type:

ItemPaged[PrivateEndpointConnection]

Raises:

HttpResponseError –

update(resource_group_name: str, search_service_name: str, private_endpoint_connection_name: str, private_endpoint_connection: PrivateEndpointConnection | IO[bytes], search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → PrivateEndpointConnection[source]

Updates a private endpoint connection to the search service in the given resource group.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • private_endpoint_connection_name (str) – The name of the private endpoint connection to the Azure AI Search service with the specified resource group. Required.

  • private_endpoint_connection (PrivateEndpointConnection or IO[bytes]) – The definition of the private endpoint connection to update. Is either a PrivateEndpointConnection type or a IO[bytes] type. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

PrivateEndpointConnection or the result of cls(response)

Return type:

PrivateEndpointConnection

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.PrivateLinkResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s private_link_resources attribute.

list_supported(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → Iterable[PrivateLinkResource][source]

Gets a list of all supported private link resource types for the given service.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An iterator like instance of either PrivateLinkResource or the result of cls(response)

Return type:

ItemPaged[PrivateLinkResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.QueryKeysOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s query_keys attribute.

create(resource_group_name: str, search_service_name: str, name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → QueryKey[source]

Generates a new query key for the specified search service. You can create up to 50 query keys per service.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • name (str) – The name of the new query API key. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

QueryKey or the result of cls(response)

Return type:

QueryKey

Raises:

HttpResponseError –

delete(resource_group_name: str, search_service_name: str, key: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → None[source]

Deletes the specified query key. Unlike admin keys, query keys are not regenerated. The process for regenerating a query key is to delete and then recreate it.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • key (str) – The query key to be deleted. Query keys are identified by value, not by name. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

list_by_search_service(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → Iterable[QueryKey][source]

Returns the list of query API keys for the given Azure AI Search service.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An iterator like instance of either QueryKey or the result of cls(response)

Return type:

ItemPaged[QueryKey]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.SearchManagementClientOperationsMixin[source]

Bases: SearchManagementClientMixinABC

usage_by_subscription_sku(location: str, sku_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → QuotaUsageResult[source]

Gets the quota usage for a search SKU in the given subscription.

See also

Parameters:

  • location (str) – The unique location name for a Microsoft Azure geographic region. Required.

  • sku_name (str) – The unique SKU name that identifies a billable tier. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

QuotaUsageResult or the result of cls(response)

Return type:

QuotaUsageResult

Raises:

HttpResponseError –

class azure.mgmt.search.operations.ServicesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s services attribute.

begin_create_or_update(resource_group_name: str, search_service_name: str, service: SearchService | IO[bytes], search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → LROPoller[SearchService][source]

Creates or updates a search service in the given resource group. If the search service already exists, all properties will be updated with the given values.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI 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://<name>.search.windows.net). You cannot change the service name after the service is created. Required.

  • service (SearchService or IO[bytes]) – The definition of the search service to create or update. Is either a SearchService type or a IO[bytes] type. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An instance of LROPoller that returns either SearchService or the result of cls(response)

Return type:

LROPoller[SearchService]

Raises:

HttpResponseError –

begin_upgrade(resource_group_name: str, search_service_name: str, **kwargs: Any) → LROPoller[SearchService][source]

Upgrades the Azure AI Search service to the latest version available.

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

Returns:

An instance of LROPoller that returns either SearchService or the result of cls(response)

Return type:

LROPoller[SearchService]

Raises:

HttpResponseError –

check_name_availability(name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → CheckNameAvailabilityOutput[source]

Checks whether or not the given search service name is available for use. Search service names must be globally unique since they are part of the service URI (https://<name>.search.windows.net).

See also

Parameters:

  • name (str) – The search service name to validate. 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. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

CheckNameAvailabilityOutput or the result of cls(response)

Return type:

CheckNameAvailabilityOutput

Raises:

HttpResponseError –

delete(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → None[source]

Deletes a search service in the given resource group, along with its associated resources.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

None or the result of cls(response)

Return type:

None

Raises:

HttpResponseError –

get(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → SearchService[source]

Gets the search service with the given name in the given resource group.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

SearchService or the result of cls(response)

Return type:

SearchService

Raises:

HttpResponseError –

list_by_resource_group(resource_group_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → Iterable[SearchService][source]

Gets a list of all Search services in the given resource group.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An iterator like instance of either SearchService or the result of cls(response)

Return type:

ItemPaged[SearchService]

Raises:

HttpResponseError –

list_by_subscription(search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → Iterable[SearchService][source]

Gets a list of all Search services in the given subscription.

See also

Parameters:

search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An iterator like instance of either SearchService or the result of cls(response)

Return type:

ItemPaged[SearchService]

Raises:

HttpResponseError –

update(resource_group_name: str, search_service_name: str, service: SearchServiceUpdate | IO[bytes], search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → SearchService[source]

Updates an existing search service in the given resource group.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service to update. Required.

  • service (SearchServiceUpdate or IO[bytes]) – The definition of the search service to update. Is either a SearchServiceUpdate type or a IO[bytes] type. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

SearchService or the result of cls(response)

Return type:

SearchService

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.SharedPrivateLinkResourcesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s shared_private_link_resources attribute.

begin_create_or_update(resource_group_name: str, search_service_name: str, shared_private_link_resource_name: str, shared_private_link_resource: SharedPrivateLinkResource | IO[bytes], search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → LROPoller[SharedPrivateLinkResource][source]

Initiates the creation or update of a shared private link resource managed by the search service in the given resource group.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • shared_private_link_resource_name (str) – The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. Required.

  • shared_private_link_resource (SharedPrivateLinkResource or IO[bytes]) – The definition of the shared private link resource to create or update. Is either a SharedPrivateLinkResource type or a IO[bytes] type. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An instance of LROPoller that returns either SharedPrivateLinkResource or the result of cls(response)

Return type:

LROPoller[SharedPrivateLinkResource]

Raises:

HttpResponseError –

begin_delete(resource_group_name: str, search_service_name: str, shared_private_link_resource_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → LROPoller[None][source]

Initiates the deletion of the shared private link resource from the search service.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • shared_private_link_resource_name (str) – The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An instance of LROPoller that returns either None or the result of cls(response)

Return type:

LROPoller[None]

Raises:

HttpResponseError –

get(resource_group_name: str, search_service_name: str, shared_private_link_resource_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → SharedPrivateLinkResource[source]

Gets the details of the shared private link resource managed by the search service in the given resource group.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • shared_private_link_resource_name (str) – The name of the shared private link resource managed by the Azure AI Search service within the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

SharedPrivateLinkResource or the result of cls(response)

Return type:

SharedPrivateLinkResource

Raises:

HttpResponseError –

list_by_service(resource_group_name: str, search_service_name: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → Iterable[SharedPrivateLinkResource][source]

Gets a list of all shared private link resources managed by the given service.

See also

Parameters:

  • resource_group_name (str) – 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.

  • search_service_name (str) – The name of the Azure AI Search service associated with the specified resource group. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An iterator like instance of either SharedPrivateLinkResource or the result of cls(response)

Return type:

ItemPaged[SharedPrivateLinkResource]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>
class azure.mgmt.search.operations.UsagesOperations(*args, **kwargs)[source]

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through SearchManagementClient’s usages attribute.

list_by_subscription(location: str, search_management_request_options: SearchManagementRequestOptions | None = None, **kwargs: Any) → Iterable[QuotaUsageResult][source]

Get a list of all Azure AI Search quota usages across the subscription.

See also

Parameters:

  • location (str) – The unique location name for a Microsoft Azure geographic region. Required.

  • search_management_request_options (SearchManagementRequestOptions) – Parameter group. Default value is None.

Returns:

An iterator like instance of either QuotaUsageResult or the result of cls(response)

Return type:

ItemPaged[QuotaUsageResult]

Raises:

HttpResponseError –

models = <module 'azure.mgmt.search.models' from '/mnt/vss/_work/1/s/sdk/search/azure-mgmt-search/.tox/sphinx/lib/python3.13/site-packages/azure/mgmt/search/models/__init__.py'>