ConnectionOperations interface

Interface representing a Connection operations.

Properties

beginCreateOrUpdateDeployment
beginCreateOrUpdateDeploymentAndWait
beginDeleteDeployment
beginDeleteDeploymentAndWait
createOrUpdateDeployment

Create or update Azure OpenAI connection deployment resource with the specified parameters

deleteDeployment

Delete Azure OpenAI connection deployment resource by name

getAllModels

Get models under the Azure ML workspace for all Azure OpenAI connections that the user can deploy.

getDeployment

Get deployments under the Azure OpenAI connection by name.

getModels

Get available models under the Azure OpenAI connection.

listDeployments

Get all the deployments under the Azure OpenAI connection.

Property Details

beginCreateOrUpdateDeployment

Warning

This API is now deprecated.

use createOrUpdateDeployment instead

beginCreateOrUpdateDeployment: (resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, body: EndpointDeploymentResourcePropertiesBasicResource, options?: ConnectionCreateOrUpdateDeploymentOptionalParams) => Promise<SimplePollerLike<OperationState<EndpointDeploymentResourcePropertiesBasicResource>, EndpointDeploymentResourcePropertiesBasicResource>>

Property Value

(resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, body: EndpointDeploymentResourcePropertiesBasicResource, options?: ConnectionCreateOrUpdateDeploymentOptionalParams) => Promise<SimplePollerLike<OperationState<EndpointDeploymentResourcePropertiesBasicResource>, EndpointDeploymentResourcePropertiesBasicResource>>

beginCreateOrUpdateDeploymentAndWait

Warning

This API is now deprecated.

use createOrUpdateDeployment instead

beginCreateOrUpdateDeploymentAndWait: (resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, body: EndpointDeploymentResourcePropertiesBasicResource, options?: ConnectionCreateOrUpdateDeploymentOptionalParams) => Promise<EndpointDeploymentResourcePropertiesBasicResource>

Property Value

(resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, body: EndpointDeploymentResourcePropertiesBasicResource, options?: ConnectionCreateOrUpdateDeploymentOptionalParams) => Promise<EndpointDeploymentResourcePropertiesBasicResource>

beginDeleteDeployment

Warning

This API is now deprecated.

use deleteDeployment instead

beginDeleteDeployment: (resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, options?: ConnectionDeleteDeploymentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, options?: ConnectionDeleteDeploymentOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteDeploymentAndWait

Warning

This API is now deprecated.

use deleteDeployment instead

beginDeleteDeploymentAndWait: (resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, options?: ConnectionDeleteDeploymentOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, options?: ConnectionDeleteDeploymentOptionalParams) => Promise<void>

createOrUpdateDeployment

Create or update Azure OpenAI connection deployment resource with the specified parameters

createOrUpdateDeployment: (resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, body: EndpointDeploymentResourcePropertiesBasicResource, options?: ConnectionCreateOrUpdateDeploymentOptionalParams) => PollerLike<OperationState<EndpointDeploymentResourcePropertiesBasicResource>, EndpointDeploymentResourcePropertiesBasicResource>

Property Value

(resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, body: EndpointDeploymentResourcePropertiesBasicResource, options?: ConnectionCreateOrUpdateDeploymentOptionalParams) => PollerLike<OperationState<EndpointDeploymentResourcePropertiesBasicResource>, EndpointDeploymentResourcePropertiesBasicResource>

deleteDeployment

Delete Azure OpenAI connection deployment resource by name

deleteDeployment: (resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, options?: ConnectionDeleteDeploymentOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, options?: ConnectionDeleteDeploymentOptionalParams) => PollerLike<OperationState<void>, void>

getAllModels

Get models under the Azure ML workspace for all Azure OpenAI connections that the user can deploy.

getAllModels: (resourceGroupName: string, workspaceName: string, options?: ConnectionGetAllModelsOptionalParams) => Promise<EndpointModels>

Property Value

(resourceGroupName: string, workspaceName: string, options?: ConnectionGetAllModelsOptionalParams) => Promise<EndpointModels>

getDeployment

Get deployments under the Azure OpenAI connection by name.

getDeployment: (resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, options?: ConnectionGetDeploymentOptionalParams) => Promise<EndpointDeploymentResourcePropertiesBasicResource>

Property Value

(resourceGroupName: string, workspaceName: string, connectionName: string, deploymentName: string, options?: ConnectionGetDeploymentOptionalParams) => Promise<EndpointDeploymentResourcePropertiesBasicResource>

getModels

Get available models under the Azure OpenAI connection.

getModels: (resourceGroupName: string, workspaceName: string, connectionName: string, options?: ConnectionGetModelsOptionalParams) => PagedAsyncIterableIterator<EndpointModelProperties, EndpointModelProperties[], PageSettings>

Property Value

(resourceGroupName: string, workspaceName: string, connectionName: string, options?: ConnectionGetModelsOptionalParams) => PagedAsyncIterableIterator<EndpointModelProperties, EndpointModelProperties[], PageSettings>

listDeployments

Get all the deployments under the Azure OpenAI connection.

listDeployments: (resourceGroupName: string, workspaceName: string, connectionName: string, options?: ConnectionListDeploymentsOptionalParams) => PagedAsyncIterableIterator<EndpointDeploymentResourcePropertiesBasicResource, EndpointDeploymentResourcePropertiesBasicResource[], PageSettings>

Property Value

(resourceGroupName: string, workspaceName: string, connectionName: string, options?: ConnectionListDeploymentsOptionalParams) => PagedAsyncIterableIterator<EndpointDeploymentResourcePropertiesBasicResource, EndpointDeploymentResourcePropertiesBasicResource[], PageSettings>