Share via


AgentsClient Constructors

Definition

Overloads

AgentsClient()

Initializes a new instance of AgentsClient for mocking.

AgentsClient(String, TokenCredential)

Initializes a new instance of AzureAIClient.

AgentsClient(String, TokenCredential, AIProjectClientOptions)

Initializes a new instance of AzureAIClient.

AgentsClient(Uri, String, String, String, TokenCredential)

Initializes a new instance of AzureAIClient.

AgentsClient(Uri, String, String, String, TokenCredential, AIProjectClientOptions)

Initializes a new instance of AzureAIClient.

AgentsClient()

Source:
AgentsClient.cs

Initializes a new instance of AgentsClient for mocking.

protected AgentsClient ();

Applies to

AgentsClient(String, TokenCredential)

Source:
AgentsClient.cs

Initializes a new instance of AzureAIClient.

public AgentsClient (string connectionString, Azure.Core.TokenCredential credential);

Parameters

connectionString
String

The Azure AI Studio project connection string, in the form endpoint;subscription_id;resource_group_name;project_name.

credential
TokenCredential

A credential used to authenticate to an Azure Service.

Exceptions

connectionString is null.

connectionString

Applies to

AgentsClient(String, TokenCredential, AIProjectClientOptions)

Source:
AgentsClient.cs

Initializes a new instance of AzureAIClient.

public AgentsClient (string connectionString, Azure.Core.TokenCredential credential, Azure.AI.Projects.AIProjectClientOptions options);

Parameters

connectionString
String

The Azure AI Studio project connection string, in the form endpoint;subscription_id;resource_group_name;project_name.

credential
TokenCredential

A credential used to authenticate to an Azure Service.

options
AIProjectClientOptions

The options for configuring the client.

Exceptions

connectionString is null.

connectionString is an empty string.

Applies to

AgentsClient(Uri, String, String, String, TokenCredential)

Source:
AgentsClient.cs

Initializes a new instance of AzureAIClient.

public AgentsClient (Uri endpoint, string subscriptionId, string resourceGroupName, string projectName, Azure.Core.TokenCredential credential);

Parameters

endpoint
Uri

The Azure AI Studio project endpoint, in the form https://&lt;azure-region&gt;.api.azureml.ms or https://&lt;private-link-guid&gt;.&lt;azure-region&gt;.api.azureml.ms, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link.

subscriptionId
String

The Azure subscription ID.

resourceGroupName
String

The name of the Azure Resource Group.

projectName
String

The Azure AI Studio project name.

credential
TokenCredential

A credential used to authenticate to an Azure Service.

Exceptions

endpoint, subscriptionId, resourceGroupName, projectName or credential is null.

subscriptionId, resourceGroupName or projectName is an empty string, and was expected to be non-empty.

Applies to

AgentsClient(Uri, String, String, String, TokenCredential, AIProjectClientOptions)

Source:
AgentsClient.cs

Initializes a new instance of AzureAIClient.

public AgentsClient (Uri endpoint, string subscriptionId, string resourceGroupName, string projectName, Azure.Core.TokenCredential credential, Azure.AI.Projects.AIProjectClientOptions options);

Parameters

endpoint
Uri

The Azure AI Studio project endpoint, in the form https://&lt;azure-region&gt;.api.azureml.ms or https://&lt;private-link-guid&gt;.&lt;azure-region&gt;.api.azureml.ms, where <azure-region> is the Azure region where the project is deployed (e.g. westus) and <private-link-guid> is the GUID of the Enterprise private link.

subscriptionId
String

The Azure subscription ID.

resourceGroupName
String

The name of the Azure Resource Group.

projectName
String

The Azure AI Studio project name.

credential
TokenCredential

A credential used to authenticate to an Azure Service.

options
AIProjectClientOptions

The options for configuring the client.

Exceptions

endpoint, subscriptionId, resourceGroupName, projectName or credential is null.

subscriptionId, resourceGroupName or projectName is an empty string, and was expected to be non-empty.

Applies to