ConnectionsOperations.GetConnection 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.
Get a connection by name.
public Azure.AI.Projects.ConnectionProperties GetConnection(string connectionName, bool includeCredentials = false, string clientRequestId = default, System.Threading.CancellationToken cancellationToken = default);member this.GetConnection : string * bool * string * System.Threading.CancellationToken -> Azure.AI.Projects.ConnectionPropertiesPublic Function GetConnection (connectionName As String, Optional includeCredentials As Boolean = false, Optional clientRequestId As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As ConnectionPropertiesParameters
- connectionName
- String
The name of the connection. Required.
- includeCredentials
- Boolean
Whether to include credentials in the response. Default is false.
- clientRequestId
- String
An opaque, globally-unique, client-generated string identifier for the request.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
A ConnectionProperties object.
Exceptions
Thrown when the request fails.
