Share via

ConnectionOperations interface

  • Reference
Package:
@azure/arm-automation

Interface representing a ConnectionOperations.

Methods

createOrUpdate(string, string, string, ConnectionCreateOrUpdateParameters, ConnectionCreateOrUpdateOptionalParams)

Create or update a connection.
delete(string, string, string, ConnectionDeleteOptionalParams)

Delete the connection.
get(string, string, string, ConnectionGetOptionalParams)

Retrieve the connection identified by connection name.
listByAutomationAccount(string, string, ConnectionListByAutomationAccountOptionalParams)

Retrieve a list of connections.
update(string, string, string, ConnectionUpdateParameters, ConnectionUpdateOptionalParams)

Update a connection.

Method Details

createOrUpdate(string, string, string, ConnectionCreateOrUpdateParameters, ConnectionCreateOrUpdateOptionalParams)

Create or update a connection.

function createOrUpdate(resourceGroupName: string, automationAccountName: string, connectionName: string, parameters: ConnectionCreateOrUpdateParameters, options?: ConnectionCreateOrUpdateOptionalParams): Promise<Connection>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

connectionName

string

The parameters supplied to the create or update connection operation.

parameters
ConnectionCreateOrUpdateParameters

The parameters supplied to the create or update connection operation.

options
ConnectionCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Connection>

delete(string, string, string, ConnectionDeleteOptionalParams)

Delete the connection.

function delete(resourceGroupName: string, automationAccountName: string, connectionName: string, options?: ConnectionDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

connectionName

string

The name of connection.

options
ConnectionDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ConnectionGetOptionalParams)

Retrieve the connection identified by connection name.

function get(resourceGroupName: string, automationAccountName: string, connectionName: string, options?: ConnectionGetOptionalParams): Promise<Connection>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

connectionName

string

The name of connection.

options
ConnectionGetOptionalParams

The options parameters.

Returns

Promise<Connection>

listByAutomationAccount(string, string, ConnectionListByAutomationAccountOptionalParams)

Retrieve a list of connections.

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options?: ConnectionListByAutomationAccountOptionalParams): PagedAsyncIterableIterator<Connection, Connection[], PageSettings>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
ConnectionListByAutomationAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Connection, Connection[], PageSettings>

update(string, string, string, ConnectionUpdateParameters, ConnectionUpdateOptionalParams)

Update a connection.

function update(resourceGroupName: string, automationAccountName: string, connectionName: string, parameters: ConnectionUpdateParameters, options?: ConnectionUpdateOptionalParams): Promise<Connection>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

connectionName

string

The parameters supplied to the update a connection operation.

parameters
ConnectionUpdateParameters

The parameters supplied to the update a connection operation.

options
ConnectionUpdateOptionalParams

The options parameters.

Returns

Promise<Connection>