SecurityConnectors interface

Package:

@azure/arm-security

Interface representing a SecurityConnectors.

Methods

createOrUpdate(string, string, SecurityConnector, SecurityConnectorsCreateOrUpdateOptionalParams)	Creates or updates a security connector. If a security connector is already created and a subsequent request is issued for the same security connector id, then it will be updated.
delete(string, string, SecurityConnectorsDeleteOptionalParams)	Deletes a security connector.
get(string, string, SecurityConnectorsGetOptionalParams)	Retrieves details of a specific security connector
list(SecurityConnectorsListOptionalParams)	Lists all the security connectors in the specified subscription. Use the 'nextLink' property in the response to get the next page of security connectors for the specified subscription.
listByResourceGroup(string, SecurityConnectorsListByResourceGroupOptionalParams)	Lists all the security connectors in the specified resource group. Use the 'nextLink' property in the response to get the next page of security connectors for the specified resource group.
update(string, string, SecurityConnector, SecurityConnectorsUpdateOptionalParams)	Updates a security connector

Method Details

createOrUpdate(string, string, SecurityConnector, SecurityConnectorsCreateOrUpdateOptionalParams)

Creates or updates a security connector. If a security connector is already created and a subsequent request is issued for the same security connector id, then it will be updated.

function createOrUpdate(resourceGroupName: string, securityConnectorName: string, securityConnector: SecurityConnector, options?: SecurityConnectorsCreateOrUpdateOptionalParams): Promise<SecurityConnector>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

securityConnectorName

string

The security connector name.

securityConnector

SecurityConnector

The security connector resource

options

SecurityConnectorsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<SecurityConnector>

delete(string, string, SecurityConnectorsDeleteOptionalParams)

Deletes a security connector.

function delete(resourceGroupName: string, securityConnectorName: string, options?: SecurityConnectorsDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

securityConnectorName

string

The security connector name.

options

SecurityConnectorsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, SecurityConnectorsGetOptionalParams)

Retrieves details of a specific security connector

function get(resourceGroupName: string, securityConnectorName: string, options?: SecurityConnectorsGetOptionalParams): Promise<SecurityConnector>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

securityConnectorName

string

The security connector name.

options

SecurityConnectorsGetOptionalParams

The options parameters.

Returns

Promise<SecurityConnector>

list(SecurityConnectorsListOptionalParams)

Lists all the security connectors in the specified subscription. Use the 'nextLink' property in the response to get the next page of security connectors for the specified subscription.

function list(options?: SecurityConnectorsListOptionalParams): PagedAsyncIterableIterator<SecurityConnector, SecurityConnector[], PageSettings>

Parameters

options

SecurityConnectorsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SecurityConnector, SecurityConnector[], PageSettings>

listByResourceGroup(string, SecurityConnectorsListByResourceGroupOptionalParams)

Lists all the security connectors in the specified resource group. Use the 'nextLink' property in the response to get the next page of security connectors for the specified resource group.

function listByResourceGroup(resourceGroupName: string, options?: SecurityConnectorsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SecurityConnector, SecurityConnector[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

options

SecurityConnectorsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<SecurityConnector, SecurityConnector[], PageSettings>

update(string, string, SecurityConnector, SecurityConnectorsUpdateOptionalParams)

Updates a security connector

function update(resourceGroupName: string, securityConnectorName: string, securityConnector: SecurityConnector, options?: SecurityConnectorsUpdateOptionalParams): Promise<SecurityConnector>

Parameters

resourceGroupName

string

The name of the resource group within the user's subscription. The name is case insensitive.

securityConnectorName

string

The security connector name.

securityConnector

SecurityConnector

The security connector resource

options

SecurityConnectorsUpdateOptionalParams

The options parameters.

Returns

Promise<SecurityConnector>