你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Operations - List

列出 Microsoft.Search 提供程序的所有可用 REST API 操作。

GET https://management.azure.com/providers/Microsoft.Search/operations?api-version=2021-04-01-preview

URI 参数

Name In Required Type Description
api-version
query True
  • string

要用于每个请求的 API 版本。

响应

Name Type Description
200 OK

成功。 响应描述操作列表。

Other Status Codes

操作 API 失败。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

SearchListOperations

Sample Request

GET https://management.azure.com/providers/Microsoft.Search/operations?api-version=2021-04-01-preview

Sample Response

{
  "value": [
    {
      "name": "Microsoft.Search/operations/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Search Services",
        "operation": "List all available operations",
        "description": "Lists all of the available operations of the Microsoft.Search provider."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/register/action",
      "isDataAction": false,
      "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."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Search Services",
        "operation": "Set Search Service",
        "description": "Creates or updates the search service."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Search Services",
        "operation": "Get Search Service",
        "description": "Reads the search service."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Search Services",
        "operation": "Delete Search Service",
        "description": "Deletes the search service."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/start/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Search Services",
        "operation": "Start Search Service",
        "description": "Starts the search service."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/stop/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Search Services",
        "operation": "Stop Search Service",
        "description": "Stops the search service."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/listAdminKeys/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Search Services",
        "operation": "Get Admin Key",
        "description": "Reads the admin keys."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/regenerateAdminKey/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Search Services",
        "operation": "Regenerate Admin Key",
        "description": "Regenerates the admin key."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/listQueryKeys/action",
      "isDataAction": false,
      "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."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/createQueryKey/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Search Services",
        "operation": "Create Query Key",
        "description": "Creates the query key."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/deleteQueryKey/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "API Keys",
        "operation": "Delete Query Key",
        "description": "Deletes the query key."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/checkNameAvailability/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Service Name Availability",
        "operation": "Check Service Name Availability",
        "description": "Checks availability of the service name."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/diagnosticSettings/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Diagnostic Settings",
        "operation": "Get Diagnostic Setting",
        "description": "Gets the diganostic setting read for the resource"
      },
      "origin": "system"
    },
    {
      "name": "Microsoft.Search/searchServices/diagnosticSettings/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Diagnostic Settings",
        "operation": "Set Diagnostic Setting",
        "description": "Creates or updates the diganostic setting for the resource"
      },
      "origin": "system"
    },
    {
      "name": "Microsoft.Search/searchServices/metricDefinitions/read",
      "isDataAction": false,
      "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"
      },
      "origin": "system",
      "properties": {
        "serviceSpecification": {
          "metricSpecifications": [
            {
              "name": "SearchLatency",
              "displayName": "Search Latency",
              "displayDescription": "Average search latency for the search service",
              "unit": "Seconds",
              "aggregationType": "Average",
              "availabilities": [
                {
                  "timeGrain": "PT1M",
                  "blobDuration": "PT1H"
                }
              ]
            },
            {
              "name": "SearchQueriesPerSecond",
              "displayName": "Search queries per second",
              "displayDescription": "Search queries per second for the search service",
              "unit": "CountPerSecond",
              "aggregationType": "Average",
              "availabilities": [
                {
                  "timeGrain": "PT1M",
                  "blobDuration": "PT1H"
                }
              ]
            },
            {
              "name": "ThrottledSearchQueriesPercentage",
              "displayName": "Throttled search queries percentage",
              "displayDescription": "Percentage of search queries that were throttled for the search service",
              "unit": "Percent",
              "aggregationType": "Average",
              "availabilities": [
                {
                  "timeGrain": "PT1M",
                  "blobDuration": "PT1H"
                }
              ]
            }
          ]
        }
      }
    },
    {
      "name": "Microsoft.Search/searchServices/logDefinitions/read",
      "isDataAction": false,
      "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"
      },
      "origin": "system",
      "properties": {
        "serviceSpecification": {
          "logSpecifications": [
            {
              "name": "OperationLogs",
              "displayName": "Operation Logs",
              "blobDuration": "PT1H"
            }
          ]
        }
      }
    },
    {
      "name": "Microsoft.Search/searchServices/privateEndpointConnectionProxies/validate/action",
      "isDataAction": false,
      "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"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/privateEndpointConnectionProxies/write",
      "isDataAction": false,
      "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"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/privateEndpointConnectionProxies/read",
      "isDataAction": false,
      "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"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/privateEndpointConnectionProxies/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Private Endpoint Connection Proxy",
        "operation": "Delete Private Endpoint Connection Proxy",
        "description": "Deletes an existing private endpoint connection proxy"
      },
      "origin": "user,system"
    },
    {
      "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"
      },
      "origin": "user,system"
    },
    {
      "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"
      },
      "origin": "user,system"
    },
    {
      "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"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/sharedPrivateLinkResources/write",
      "isDataAction": false,
      "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"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/sharedPrivateLinkResources/read",
      "isDataAction": false,
      "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"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/sharedPrivateLinkResources/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Shared Private Link Resource",
        "operation": "Delete Shared Private Link Resource",
        "description": "Deletes an existing shared private link resource"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/sharedPrivateLinkResources/operationStatuses/read",
      "isDataAction": false,
      "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"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/indexes/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Indexes",
        "operation": "Read Index",
        "description": "Return an index or its statistics, return a list of indexes or their statistics, or test the lexical analysis components of an index."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/indexes/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Indexes",
        "operation": "Create or Update Index",
        "description": "Create an index or modify its properties."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/indexes/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Indexes",
        "operation": "Delete Index",
        "description": "Delete an index."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/synonymMaps/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Synonym Maps",
        "operation": "Read Synonym Map",
        "description": "Return a synonym map or a list of synonym maps."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/synonymMaps/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Synonym Maps",
        "operation": "Create or Update Synonym Map",
        "description": "Create a synonym map or modify its properties."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/synonymMaps/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Synonym Maps",
        "operation": "Delete Synonym Map",
        "description": "Delete a synonym map."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/dataSources/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Data Sources",
        "operation": "Read Data Source",
        "description": "Return a data source or a list of data sources."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/dataSources/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Data Sources",
        "operation": "Create or Update Data Source",
        "description": "Create a data source or modify its properties."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/dataSources/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Data Sources",
        "operation": "Delete Data Source",
        "description": "Delete a data source."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/skillsets/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Skillsets",
        "operation": "Read Skillset",
        "description": "Return a skillset or a list of skillsets."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/skillsets/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Skillsets",
        "operation": "Create or Update Skillset",
        "description": "Create a skillset or modify its properties."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/skillsets/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Skillsets",
        "operation": "Delete Skillset",
        "description": "Delete a skillset."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/indexers/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Indexers",
        "operation": "Read Indexer",
        "description": "Return an indexer or its status, or return a list of indexers or their statuses."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/indexers/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Indexers",
        "operation": "Create or Manage Indexer",
        "description": "Create an indexer, modify its properties, or manage its execution."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/indexers/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Indexers",
        "operation": "Delete Indexer",
        "description": "Delete an indexer."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/debugSessions/read",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Debug Sessions",
        "operation": "Read Debug Session",
        "description": "Return a debug session or a list of debug sessions."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/debugSessions/write",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Debug Sessions",
        "operation": "Create or Update Debug Session",
        "description": "Create a debug session or modify its properties."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/debugSessions/delete",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Debug Sessions",
        "operation": "Delete Debug Session",
        "description": "Delete a debug session."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/debugSessions/execute/action",
      "isDataAction": false,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Debug Sessions",
        "operation": "Execute Debug Session",
        "description": "Use a debug session, get execution data, or evaluate expressions on it."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/indexes/documents/read",
      "isDataAction": true,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Documents",
        "operation": "Read Documents",
        "description": "Read documents or suggested query terms from an index."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/indexes/documents/write",
      "isDataAction": true,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Documents",
        "operation": "Write Documents",
        "description": "Upload documents to an index or modify existing documents."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.Search/searchServices/indexes/documents/delete",
      "isDataAction": true,
      "display": {
        "provider": "Microsoft Search",
        "resource": "Documents",
        "operation": "Delete Documents",
        "description": "Delete documents from an index."
      },
      "origin": "user,system"
    }
  ]
}

定义

CloudError

包含有关 API 错误的信息。

CloudErrorBody

描述具有错误代码和消息的特定 API 错误。

Display

描述操作的对象。

Operation

描述 REST API 操作。

OperationAvailability

描述指标规范的特定可用性。

OperationListResult

列出 REST API 操作的请求的结果。 它包含操作列表和用于获取下一组结果的 URL。

OperationLogsSpecification

此操作的一种类型的日志的规范。

OperationMetricDimension

描述指标规范的特定维度。

OperationMetricsSpecification

此操作的一种类型的指标的规范。

OperationProperties

描述此操作的其他属性。

OperationServiceSpecification

此操作的服务规范。

CloudError

包含有关 API 错误的信息。

Name Type Description
error

描述具有错误代码和消息的特定 API 错误。

message
  • string

有关 (错误 (有关详细信息/调试信息的简短说明,请参阅“error.message”属性) 。

CloudErrorBody

描述具有错误代码和消息的特定 API 错误。

Name Type Description
code
  • string

描述错误条件的错误代码比 HTTP 状态代码更精确。 可用于以编程方式处理特定错误案例。

details

包含与此错误相关的嵌套错误。

message
  • string

详细说明错误并提供调试信息的消息。

target
  • string

特定错误的目标 (例如,错误) 中属性的名称。

Display

描述操作的对象。

Name Type Description
description
  • string

操作的友好名称。

operation
  • string

操作类型:读取、写入、删除、listKeys/action 等。

provider
  • string

资源提供程序的友好名称。

resource
  • string

对其执行操作的资源类型。

Operation

描述 REST API 操作。

Name Type Description
display

描述操作的对象。

isDataAction
  • boolean

描述指定的操作是否为数据平面 API 操作。 资源提供程序直接支持此值不为 true 的操作。

name
  • string

操作的名称。 此名称的格式为 {provider}/{resource}/{operation}。

origin
  • string

描述允许哪些发起实体调用此操作。

properties

描述此操作的其他属性。

OperationAvailability

描述指标规范的特定可用性。

Name Type Description
blobDuration
  • string

维度的 Blob 持续时间。

timeGrain
  • string

维度的时间粒度。

OperationListResult

列出 REST API 操作的请求的结果。 它包含操作列表和用于获取下一组结果的 URL。

Name Type Description
nextLink
  • string

用于获取下一组操作列表结果(如果有)的 URL。

value

Azure 认知搜索的操作列表、资源提供程序支持的一些操作列表,另一些由数据平面 API 提供支持。

OperationLogsSpecification

此操作的一种类型的日志的规范。

Name Type Description
blobDuration
  • string

日志规范的 Blob 持续时间。

displayName
  • string

日志规范的显示名称。

name
  • string

日志规范的名称。

OperationMetricDimension

描述指标规范的特定维度。

Name Type Description
displayName
  • string

维度的显示名称。

name
  • string

维的名称。

OperationMetricsSpecification

此操作的一种类型的指标的规范。

Name Type Description
aggregationType
  • string

指标规范的聚合类型。

availabilities

指标规范的可用性。

dimensions

指标规范的维度。

displayDescription
  • string

指标规范的显示说明。

displayName
  • string

指标规范的显示名称。

name
  • string

指标规范的名称。

unit
  • string

指标规范的单位。

OperationProperties

描述此操作的其他属性。

Name Type Description
serviceSpecification

此操作的服务规范。

OperationServiceSpecification

此操作的服务规范。

Name Type Description
logSpecifications

此操作的日志规范。

metricSpecifications

此操作的指标规范。