Connectors interface

  • Reference
Package:
@azure/arm-security

Interface representing a Connectors.

Methods

createOrUpdate(string, ConnectorSetting, ConnectorsCreateOrUpdateOptionalParams)

Create a cloud account connector or update an existing one. Connect to your cloud account. For AWS, use either account credentials or role-based authentication. For GCP, use account organization credentials.
delete(string, ConnectorsDeleteOptionalParams)

Delete a cloud account connector from a subscription
get(string, ConnectorsGetOptionalParams)

Details of a specific cloud account connector
list(ConnectorsListOptionalParams)

Cloud accounts connectors of a subscription

Method Details

createOrUpdate(string, ConnectorSetting, ConnectorsCreateOrUpdateOptionalParams)

Create a cloud account connector or update an existing one. Connect to your cloud account. For AWS, use either account credentials or role-based authentication. For GCP, use account organization credentials.

function createOrUpdate(connectorName: string, connectorSetting: ConnectorSetting, options?: ConnectorsCreateOrUpdateOptionalParams): Promise<ConnectorSetting>

Parameters

connectorName

string

Name of the cloud account connector

connectorSetting
ConnectorSetting

Settings for the cloud account connector

options
ConnectorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ConnectorSetting>

delete(string, ConnectorsDeleteOptionalParams)

Delete a cloud account connector from a subscription

function delete(connectorName: string, options?: ConnectorsDeleteOptionalParams): Promise<void>

Parameters

connectorName

string

Name of the cloud account connector

options
ConnectorsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, ConnectorsGetOptionalParams)

Details of a specific cloud account connector

function get(connectorName: string, options?: ConnectorsGetOptionalParams): Promise<ConnectorSetting>

Parameters

connectorName

string

Name of the cloud account connector

options
ConnectorsGetOptionalParams

The options parameters.

Returns

Promise<ConnectorSetting>

list(ConnectorsListOptionalParams)

Cloud accounts connectors of a subscription

function list(options?: ConnectorsListOptionalParams): PagedAsyncIterableIterator<ConnectorSetting, ConnectorSetting[], PageSettings>

Parameters

options
ConnectorsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ConnectorSetting, ConnectorSetting[], PageSettings>