Share via

CredentialOperations interface

  • Reference
Package:
@azure/arm-automation

Interface representing a CredentialOperations.

Methods

createOrUpdate(string, string, string, CredentialCreateOrUpdateParameters, CredentialCreateOrUpdateOptionalParams)

Create a credential.
delete(string, string, string, CredentialDeleteOptionalParams)

Delete the credential.
get(string, string, string, CredentialGetOptionalParams)

Retrieve the credential identified by credential name.
listByAutomationAccount(string, string, CredentialListByAutomationAccountOptionalParams)

Retrieve a list of credentials.
update(string, string, string, CredentialUpdateParameters, CredentialUpdateOptionalParams)

Update a credential.

Method Details

createOrUpdate(string, string, string, CredentialCreateOrUpdateParameters, CredentialCreateOrUpdateOptionalParams)

Create a credential.

function createOrUpdate(resourceGroupName: string, automationAccountName: string, credentialName: string, parameters: CredentialCreateOrUpdateParameters, options?: CredentialCreateOrUpdateOptionalParams): Promise<Credential_2>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

credentialName

string

The parameters supplied to the create or update credential operation.

parameters
CredentialCreateOrUpdateParameters

The parameters supplied to the create or update credential operation.

options
CredentialCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Credential>

delete(string, string, string, CredentialDeleteOptionalParams)

Delete the credential.

function delete(resourceGroupName: string, automationAccountName: string, credentialName: string, options?: CredentialDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

credentialName

string

The name of credential.

options
CredentialDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, CredentialGetOptionalParams)

Retrieve the credential identified by credential name.

function get(resourceGroupName: string, automationAccountName: string, credentialName: string, options?: CredentialGetOptionalParams): Promise<Credential_2>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

credentialName

string

The name of credential.

options
CredentialGetOptionalParams

The options parameters.

Returns

Promise<Credential>

listByAutomationAccount(string, string, CredentialListByAutomationAccountOptionalParams)

Retrieve a list of credentials.

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

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
CredentialListByAutomationAccountOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Credential, Credential[], PageSettings>

update(string, string, string, CredentialUpdateParameters, CredentialUpdateOptionalParams)

Update a credential.

function update(resourceGroupName: string, automationAccountName: string, credentialName: string, parameters: CredentialUpdateParameters, options?: CredentialUpdateOptionalParams): Promise<Credential_2>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

credentialName

string

The parameters supplied to the Update credential operation.

parameters
CredentialUpdateParameters

The parameters supplied to the Update credential operation.

options
CredentialUpdateOptionalParams

The options parameters.

Returns

Promise<Credential>