IndexesOperations.GetIndexAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| GetIndexAsync(String, String, CancellationToken) |
Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist. |
| GetIndexAsync(String, String, RequestOptions) |
[Protocol Method] Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.
|
GetIndexAsync(String, String, CancellationToken)
- Source:
- IndexesOperations.cs
Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.SearchIndex>> GetIndexAsync(string name, string version, System.Threading.CancellationToken cancellationToken = default);abstract member GetIndexAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.SearchIndex>>
override this.GetIndexAsync : string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<System.ClientModel.ClientResult<Azure.AI.Projects.SearchIndex>>Public Overridable Function GetIndexAsync (name As String, version As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClientResult(Of SearchIndex))Parameters
- name
- String
The name of the resource.
- version
- String
The specific version id of the Index to retrieve.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
name or version is null.
name or version is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
Applies to
GetIndexAsync(String, String, RequestOptions)
- Source:
- IndexesOperations.cs
[Protocol Method] Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.
- This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
public virtual System.Threading.Tasks.Task<System.ClientModel.ClientResult> GetIndexAsync(string name, string version, System.ClientModel.Primitives.RequestOptions options);abstract member GetIndexAsync : string * string * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>
override this.GetIndexAsync : string * string * System.ClientModel.Primitives.RequestOptions -> System.Threading.Tasks.Task<System.ClientModel.ClientResult>Public Overridable Function GetIndexAsync (name As String, version As String, options As RequestOptions) As Task(Of ClientResult)Parameters
- name
- String
The name of the resource.
- version
- String
The specific version id of the Index to retrieve.
- options
- RequestOptions
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
name or version is null.
name or version is an empty string, and was expected to be non-empty.
Service returned a non-success status code.
