azure.ai.ml.operations.WorkspaceConnectionsOperations.yml

### YamlMime:PythonClass
uid: azure.ai.ml.operations.WorkspaceConnectionsOperations
name: WorkspaceConnectionsOperations
fullName: azure.ai.ml.operations.WorkspaceConnectionsOperations
module: azure.ai.ml.operations
inheritances:
- azure.ai.ml._scope_dependent_operations._ScopeDependentOperations
summary: 'WorkspaceConnectionsOperations.


  You should not instantiate this class directly. Instead, you should create

  an MLClient instance that instantiates it for you and attaches it as an attribute.'
constructor:
  syntax: 'WorkspaceConnectionsOperations(operation_scope: OperationScope, operation_config:
    OperationConfig, service_client: AzureMachineLearningWorkspaces, all_operations:
    OperationsContainer, credentials: TokenCredential | None = None, **kwargs: Dict)'
  parameters:
  - name: operation_scope
    isRequired: true
  - name: operation_config
    isRequired: true
  - name: service_client
    isRequired: true
  - name: all_operations
    isRequired: true
  - name: credentials
    defaultValue: None
methods:
- uid: azure.ai.ml.operations.WorkspaceConnectionsOperations.create_or_update
  name: create_or_update
  summary: Create or update a connection.
  signature: 'create_or_update(workspace_connection: WorkspaceConnection, *, populate_secrets:
    bool = False, **kwargs: Any) -> WorkspaceConnection | None'
  parameters:
  - name: workspace_connection
    description: 'Definition of a Workspace Connection or one of its subclasses

      or object which can be translated to a connection.'
    isRequired: true
    types:
    - <xref:azure.ai.ml.entities.WorkspaceConnection>
  keywordOnlyParameters:
  - name: populate_secrets
    description: 'If true, make a secondary API call to try filling in the workspace

      connections credentials. Currently only works for api key-based credentials.
      Defaults to False.'
    types:
    - <xref:bool>
  return:
    description: Created or update connection.
    types:
    - <xref:azure.ai.ml.entities.WorkspaceConnection>
- uid: azure.ai.ml.operations.WorkspaceConnectionsOperations.delete
  name: delete
  summary: Delete the connection.
  signature: 'delete(name: str) -> None'
  parameters:
  - name: name
    description: Name of the connection.
    isRequired: true
    types:
    - <xref:str>
- uid: azure.ai.ml.operations.WorkspaceConnectionsOperations.get
  name: get
  summary: Get a connection by name.
  signature: 'get(name: str, *, populate_secrets: bool = False, **kwargs: Dict) ->
    WorkspaceConnection'
  parameters:
  - name: name
    description: Name of the connection.
    isRequired: true
    types:
    - <xref:str>
  keywordOnlyParameters:
  - name: populate_secrets
    description: 'If true, make a secondary API call to try filling in the workspace

      connections credentials. Currently only works for api key-based credentials.
      Defaults to False.'
    types:
    - <xref:bool>
  return:
    description: The connection with the provided name.
    types:
    - <xref:azure.ai.ml.entities.WorkspaceConnection>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
    description: 'Raised if the corresponding name and version cannot be

      retrieved from the service.'
- uid: azure.ai.ml.operations.WorkspaceConnectionsOperations.list
  name: list
  summary: List all connections for a workspace.
  signature: 'list(connection_type: str | None = None, *, populate_secrets: bool =
    False, include_data_connections: bool = False, **kwargs: Any) -> Iterable[WorkspaceConnection]'
  parameters:
  - name: connection_type
    description: Type of connection to list.
    isRequired: true
    types:
    - <xref:typing.Optional>[<xref:str>]
  keywordOnlyParameters:
  - name: populate_secrets
    description: 'If true, make a secondary API call to try filling in the workspace

      connections credentials. Currently only works for api key-based credentials.
      Defaults to False.'
    types:
    - <xref:bool>
  - name: include_data_connections
    description: If true, also return data connections. Defaults to False.
    types:
    - <xref:bool>
  return:
    description: An iterator like instance of connection objects
    types:
    - <xref:typing.Iterable>[<xref:azure.ai.ml.entities.WorkspaceConnection>]