Share via

ProjectConnectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CognitiveServicesManagementClient's

<xref:project_connections> attribute.

Constructor

ProjectConnectionsOperations(*args, **kwargs)

Methods

create

Create or update Cognitive Services project connection under the specified project.

Create or update Cognitive Services project connection under the specified project.
delete

Delete Cognitive Services project connection by name.

Delete Cognitive Services project connection by name.
get

Lists Cognitive Services project connection by name.

Lists Cognitive Services project connection by name.
list

Lists all the available Cognitive Services project connections under the specified project.

Lists all the available Cognitive Services project connections under the specified project.
update

Update Cognitive Services project connection under the specified project.

Update Cognitive Services project connection under the specified project.

create

Create or update Cognitive Services project connection under the specified project.

Create or update Cognitive Services project connection under the specified project.

create(resource_group_name: str, account_name: str, project_name: str, connection_name: str, connection: _models.ConnectionPropertiesV2BasicResource | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ConnectionPropertiesV2BasicResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

The name of Cognitive Services account. Required.
project_name
Required
str

The name of Cognitive Services account's project. Required.
connection_name
Required
str

Friendly name of the connection. Required.
connection
ConnectionPropertiesV2BasicResource or IO[bytes]

The object for creating or updating a new account connection. Is either a ConnectionPropertiesV2BasicResource type or a IO[bytes] type. Default value is None.

Default value: None

Returns

Type Description
ConnectionPropertiesV2BasicResource

ConnectionPropertiesV2BasicResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete Cognitive Services project connection by name.

Delete Cognitive Services project connection by name.

delete(resource_group_name: str, account_name: str, project_name: str, connection_name: str, **kwargs: Any) -> None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

The name of Cognitive Services account. Required.
project_name
Required
str

The name of Cognitive Services account's project. Required.
connection_name
Required
str

Friendly name of the connection. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Lists Cognitive Services project connection by name.

Lists Cognitive Services project connection by name.

get(resource_group_name: str, account_name: str, project_name: str, connection_name: str, **kwargs: Any) -> ConnectionPropertiesV2BasicResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

The name of Cognitive Services account. Required.
project_name
Required
str

The name of Cognitive Services account's project. Required.
connection_name
Required
str

Friendly name of the connection. Required.

Returns

Type Description
ConnectionPropertiesV2BasicResource

ConnectionPropertiesV2BasicResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists all the available Cognitive Services project connections under the specified project.

Lists all the available Cognitive Services project connections under the specified project.

list(resource_group_name: str, account_name: str, project_name: str, target: str | None = None, category: str | None = None, include_all: bool = False, **kwargs: Any) -> ItemPaged[ConnectionPropertiesV2BasicResource]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

The name of Cognitive Services account. Required.
project_name
Required
str

The name of Cognitive Services account's project. Required.
target
str

Target of the connection. Default value is None.

Default value: None
category
str

Category of the connection. Default value is None.

Default value: None
include_all
bool

query parameter that indicates if get connection call should return both connections and datastores. Default value is False.

Default value: False

Returns

Type Description
ItemPaged[ConnectionPropertiesV2BasicResource]

An iterator like instance of either ConnectionPropertiesV2BasicResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

update

Update Cognitive Services project connection under the specified project.

Update Cognitive Services project connection under the specified project.

update(resource_group_name: str, account_name: str, project_name: str, connection_name: str, connection: _models.ConnectionUpdateContent | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ConnectionPropertiesV2BasicResource

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
account_name
Required
str

The name of Cognitive Services account. Required.
project_name
Required
str

The name of Cognitive Services account's project. Required.
connection_name
Required
str

Friendly name of the connection. Required.
connection
ConnectionUpdateContent or IO[bytes]

Parameters for account connection update. Is either a ConnectionUpdateContent type or a IO[bytes] type. Default value is None.

Default value: None

Returns

Type Description
ConnectionPropertiesV2BasicResource

ConnectionPropertiesV2BasicResource or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.cognitiveservices.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv86\\Lib\\site-packages\\azure\\mgmt\\cognitiveservices\\models\\__init__.py'>