Operations - List
Lists all of the available REST API operations of the Microsoft.Search provider.
GET https://management.azure.com/providers/Microsoft.Search/operations?api-version=2023-11-01URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
api-version
|
query | True |
string |
The API version to use for each request. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Success. The response describes the list of operations. |
|
| Other Status Codes |
Operations API failed. |
Security
azure_auth
Microsoft Entra ID OAuth2 authorization flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name | Description |
|---|---|
| user_impersonation | impersonate your user account |
Examples
OperationsList
Sample request
GET https://management.azure.com/providers/Microsoft.Search/operations?api-version=2023-11-01
Sample response
{
"value": [
{
"name": "Microsoft.Search/operations/read",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "List all available operations",
"description": "Lists all of the available operations of the Microsoft.Search provider."
}
},
{
"name": "Microsoft.Search/register/action",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "Register the Search Resource Provider",
"description": "Registers the subscription for the search resource provider and enables the creation of search services."
}
},
{
"name": "Microsoft.Search/searchServices/write",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "Set Search Service",
"description": "Creates or updates the search service."
}
},
{
"name": "Microsoft.Search/searchServices/read",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "Get Search Service",
"description": "Reads the search service."
}
},
{
"name": "Microsoft.Search/searchServices/delete",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "Delete Search Service",
"description": "Deletes the search service."
}
},
{
"name": "Microsoft.Search/searchServices/start/action",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "Start Search Service",
"description": "Starts the search service."
}
},
{
"name": "Microsoft.Search/searchServices/stop/action",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "Stop Search Service",
"description": "Stops the search service."
}
},
{
"name": "Microsoft.Search/searchServices/listAdminKeys/action",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "Get Admin Key",
"description": "Reads the admin keys."
}
},
{
"name": "Microsoft.Search/searchServices/regenerateAdminKey/action",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "Regenerate Admin Key",
"description": "Regenerates the admin key."
}
},
{
"name": "Microsoft.Search/searchServices/listQueryKeys/action",
"display": {
"provider": "Microsoft Search",
"resource": "API Keys",
"operation": "Get Query Keys",
"description": "Returns the list of query API keys for the given Azure Search service."
}
},
{
"name": "Microsoft.Search/searchServices/createQueryKey/action",
"display": {
"provider": "Microsoft Search",
"resource": "Search Services",
"operation": "Create Query Key",
"description": "Creates the query key."
}
},
{
"name": "Microsoft.Search/searchServices/deleteQueryKey/delete",
"display": {
"provider": "Microsoft Search",
"resource": "API Keys",
"operation": "Delete Query Key",
"description": "Deletes the query key."
}
},
{
"name": "Microsoft.Search/checkNameAvailability/action",
"display": {
"provider": "Microsoft Search",
"resource": "Service Name Availability",
"operation": "Check Service Name Availability",
"description": "Checks availability of the service name."
}
},
{
"name": "Microsoft.Search/searchServices/diagnosticSettings/read",
"display": {
"provider": "Microsoft Search",
"resource": "Diagnostic Settings",
"operation": "Get Diagnostic Setting",
"description": "Gets the diganostic setting read for the resource"
}
},
{
"name": "Microsoft.Search/searchServices/diagnosticSettings/write",
"display": {
"provider": "Microsoft Search",
"resource": "Diagnostic Settings",
"operation": "Set Diagnostic Setting",
"description": "Creates or updates the diganostic setting for the resource"
}
},
{
"name": "Microsoft.Search/searchServices/metricDefinitions/read",
"display": {
"provider": "Microsoft Search",
"resource": "The metric definitions for the search service",
"operation": "Read search service metric definitions",
"description": "Gets the available metrics for the search service"
}
},
{
"name": "Microsoft.Search/searchServices/logDefinitions/read",
"display": {
"provider": "Microsoft Search",
"resource": "The log definition for the search service",
"operation": "Read search service log definitions",
"description": "Gets the available logs for the search service"
}
},
{
"name": "Microsoft.Search/searchServices/privateEndpointConnectionProxies/validate/action",
"display": {
"provider": "Microsoft Search",
"resource": "Private Endpoint Connection Proxy",
"operation": "Validate Private Endpoint Connection Proxy",
"description": "Validates a private endpoint connection create call from NRP side"
}
},
{
"name": "Microsoft.Search/searchServices/privateEndpointConnectionProxies/write",
"display": {
"provider": "Microsoft Search",
"resource": "Private Endpoint Connection Proxy",
"operation": "Create Private Endpoint Connection Proxy",
"description": "Creates a private endpoint connection proxy with the specified parameters or updates the properties or tags for the specified private endpoint connection proxy"
}
},
{
"name": "Microsoft.Search/searchServices/privateEndpointConnectionProxies/read",
"display": {
"provider": "Microsoft Search",
"resource": "Private Endpoint Connection Proxy",
"operation": "Get Private Endpoint Connection Proxy",
"description": "Returns the list of private endpoint connection proxies or gets the properties for the specified private endpoint connection proxy"
}
},
{
"name": "Microsoft.Search/searchServices/privateEndpointConnectionProxies/delete",
"display": {
"provider": "Microsoft Search",
"resource": "Private Endpoint Connection Proxy",
"operation": "Delete Private Endpoint Connection Proxy",
"description": "Deletes an existing private endpoint connection proxy"
}
},
{
"name": "Microsoft.Search/searchServices/privateEndpointConnections/write",
"display": {
"provider": "Microsoft Search",
"resource": "Private Endpoint Connection",
"operation": "Create Private Endpoint Connection",
"description": "Creates a private endpoint connections with the specified parameters or updates the properties or tags for the specified private endpoint connections"
}
},
{
"name": "Microsoft.Search/searchServices/privateEndpointConnections/read",
"display": {
"provider": "Microsoft Search",
"resource": "Private Endpoint Connection",
"operation": "Get Private Endpoint Connection",
"description": "Returns the list of private endpoint connections or gets the properties for the specified private endpoint connections"
}
},
{
"name": "Microsoft.Search/searchServices/privateEndpointConnections/delete",
"display": {
"provider": "Microsoft Search",
"resource": "Private Endpoint Connection",
"operation": "Delete Private Endpoint Connection",
"description": "Deletes an existing private endpoint connections"
}
},
{
"name": "Microsoft.Search/searchServices/sharedPrivateLinkResources/write",
"display": {
"provider": "Microsoft Search",
"resource": "Shared Private Link Resource",
"operation": "Create Shared Private Link Resource",
"description": "Creates a new shared private link resource with the specified parameters or updates the properties for the specified shared private link resource"
}
},
{
"name": "Microsoft.Search/searchServices/sharedPrivateLinkResources/read",
"display": {
"provider": "Microsoft Search",
"resource": "Shared Private Link Resource",
"operation": "Get Shared Private Link Resource",
"description": "Returns the list of shared private link resources or gets the properties for the specified shared private link resource"
}
},
{
"name": "Microsoft.Search/searchServices/sharedPrivateLinkResources/delete",
"display": {
"provider": "Microsoft Search",
"resource": "Shared Private Link Resource",
"operation": "Delete Shared Private Link Resource",
"description": "Deletes an existing shared private link resource"
}
},
{
"name": "Microsoft.Search/searchServices/sharedPrivateLinkResources/operationStatuses/read",
"display": {
"provider": "Microsoft Search",
"resource": "Shared Private Link Resource",
"operation": "Get Operation Status",
"description": "Get the details of a long running shared private link resource operation"
}
}
]
}Definitions
| Name | Description |
|---|---|
|
Cloud |
Contains information about an API error. |
|
Cloud |
Describes a particular API error with an error code and a message. |
| Display |
The object that describes the operation. |
| Operation |
Describes a REST API operation. |
|
Operation |
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. |
CloudError
Contains information about an API error.
| Name | Type | Description |
|---|---|---|
| error |
Describes a particular API error with an error code and a message. |
CloudErrorBody
Describes a particular API error with an error code and a message.
| Name | Type | Description |
|---|---|---|
| code |
string |
An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases. |
| details |
Contains nested errors that are related to this error. |
|
| message |
string |
A message that describes the error in detail and provides debugging information. |
| target |
string |
The target of the particular error (for example, the name of the property in error). |
Display
The object that describes the operation.
| Name | Type | Description |
|---|---|---|
| description |
string |
The friendly name of the operation. |
| operation |
string |
The operation type: read, write, delete, listKeys/action, etc. |
| provider |
string |
The friendly name of the resource provider. |
| resource |
string |
The resource type on which the operation is performed. |
Operation
Describes a REST API operation.
| Name | Type | Description |
|---|---|---|
| display |
The object that describes the operation. |
|
| name |
string |
The name of the operation. This name is of the form {provider}/{resource}/{operation}. |
OperationListResult
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.
| Name | Type | Description |
|---|---|---|
| nextLink |
string |
The URL to get the next set of operation list results, if any. |
| value |
The list of operations supported by the resource provider. |