Share via

WebhookOperations class

  • Reference
Package:
@azure/arm-automation

Class representing a WebhookOperations.

Constructors

WebhookOperations(AutomationClientContext)

Create a WebhookOperations.

Methods

createOrUpdate(string, string, string, WebhookCreateOrUpdateParameters, RequestOptionsBase)

Create the webhook identified by webhook name.
createOrUpdate(string, string, string, WebhookCreateOrUpdateParameters, RequestOptionsBase, ServiceCallback<Webhook>)
createOrUpdate(string, string, string, WebhookCreateOrUpdateParameters, ServiceCallback<Webhook>)
deleteMethod(string, string, string, RequestOptionsBase)

Delete the webhook by name.
deleteMethod(string, string, string, RequestOptionsBase, ServiceCallback<void>)
deleteMethod(string, string, string, ServiceCallback<void>)
generateUri(string, string, RequestOptionsBase)

Generates a Uri for use in creating a webhook.
generateUri(string, string, RequestOptionsBase, ServiceCallback<string>)
generateUri(string, string, ServiceCallback<string>)
get(string, string, string, RequestOptionsBase)

Retrieve the webhook identified by webhook name.
get(string, string, string, RequestOptionsBase, ServiceCallback<Webhook>)
get(string, string, string, ServiceCallback<Webhook>)
listByAutomationAccount(string, string, ServiceCallback<WebhookListResult>)
listByAutomationAccount(string, string, WebhookListByAutomationAccountOptionalParams)

Retrieve a list of webhooks.
listByAutomationAccount(string, string, WebhookListByAutomationAccountOptionalParams, ServiceCallback<WebhookListResult>)
listByAutomationAccountNext(string, RequestOptionsBase)

Retrieve a list of webhooks.
listByAutomationAccountNext(string, RequestOptionsBase, ServiceCallback<WebhookListResult>)
listByAutomationAccountNext(string, ServiceCallback<WebhookListResult>)
update(string, string, string, WebhookUpdateParameters, RequestOptionsBase)

Update the webhook identified by webhook name.
update(string, string, string, WebhookUpdateParameters, RequestOptionsBase, ServiceCallback<Webhook>)
update(string, string, string, WebhookUpdateParameters, ServiceCallback<Webhook>)

Constructor Details

WebhookOperations(AutomationClientContext)

Create a WebhookOperations.

new WebhookOperations(client: AutomationClientContext)

Parameters

client
AutomationClientContext

Reference to the service client.

Method Details

createOrUpdate(string, string, string, WebhookCreateOrUpdateParameters, RequestOptionsBase)

Create the webhook identified by webhook name.

function createOrUpdate(resourceGroupName: string, automationAccountName: string, webhookName: string, parameters: WebhookCreateOrUpdateParameters, options?: RequestOptionsBase): Promise<WebhookCreateOrUpdateResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

parameters
WebhookCreateOrUpdateParameters

The create or update parameters for webhook.

options
RequestOptionsBase

The optional parameters

Returns

Promise<WebhookCreateOrUpdateResponse>

Promise<Models.WebhookCreateOrUpdateResponse>

createOrUpdate(string, string, string, WebhookCreateOrUpdateParameters, RequestOptionsBase, ServiceCallback<Webhook>) 

function createOrUpdate(resourceGroupName: string, automationAccountName: string, webhookName: string, parameters: WebhookCreateOrUpdateParameters, options: RequestOptionsBase, callback: ServiceCallback<Webhook>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

parameters
WebhookCreateOrUpdateParameters

The create or update parameters for webhook.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<Webhook>

The callback

createOrUpdate(string, string, string, WebhookCreateOrUpdateParameters, ServiceCallback<Webhook>) 

function createOrUpdate(resourceGroupName: string, automationAccountName: string, webhookName: string, parameters: WebhookCreateOrUpdateParameters, callback: ServiceCallback<Webhook>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

parameters
WebhookCreateOrUpdateParameters

The create or update parameters for webhook.

callback

ServiceCallback<Webhook>

The callback

deleteMethod(string, string, string, RequestOptionsBase)

Delete the webhook by name.

function deleteMethod(resourceGroupName: string, automationAccountName: string, webhookName: string, options?: RequestOptionsBase): Promise<RestResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

options
RequestOptionsBase

The optional parameters

Returns

Promise<RestResponse>

Promise<msRest.RestResponse>

deleteMethod(string, string, string, RequestOptionsBase, ServiceCallback<void>) 

function deleteMethod(resourceGroupName: string, automationAccountName: string, webhookName: string, options: RequestOptionsBase, callback: ServiceCallback<void>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<void>

The callback

deleteMethod(string, string, string, ServiceCallback<void>) 

function deleteMethod(resourceGroupName: string, automationAccountName: string, webhookName: string, callback: ServiceCallback<void>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

callback

ServiceCallback<void>

The callback

generateUri(string, string, RequestOptionsBase)

Generates a Uri for use in creating a webhook.

function generateUri(resourceGroupName: string, automationAccountName: string, options?: RequestOptionsBase): Promise<WebhookGenerateUriResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
RequestOptionsBase

The optional parameters

Returns

Promise<WebhookGenerateUriResponse>

Promise<Models.WebhookGenerateUriResponse>

generateUri(string, string, RequestOptionsBase, ServiceCallback<string>) 

function generateUri(resourceGroupName: string, automationAccountName: string, options: RequestOptionsBase, callback: ServiceCallback<string>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<string>

The callback

generateUri(string, string, ServiceCallback<string>) 

function generateUri(resourceGroupName: string, automationAccountName: string, callback: ServiceCallback<string>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

callback

ServiceCallback<string>

The callback

get(string, string, string, RequestOptionsBase)

Retrieve the webhook identified by webhook name.

function get(resourceGroupName: string, automationAccountName: string, webhookName: string, options?: RequestOptionsBase): Promise<WebhookGetResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

options
RequestOptionsBase

The optional parameters

Returns

Promise<WebhookGetResponse>

Promise<Models.WebhookGetResponse>

get(string, string, string, RequestOptionsBase, ServiceCallback<Webhook>) 

function get(resourceGroupName: string, automationAccountName: string, webhookName: string, options: RequestOptionsBase, callback: ServiceCallback<Webhook>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<Webhook>

The callback

get(string, string, string, ServiceCallback<Webhook>) 

function get(resourceGroupName: string, automationAccountName: string, webhookName: string, callback: ServiceCallback<Webhook>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

callback

ServiceCallback<Webhook>

The callback

listByAutomationAccount(string, string, ServiceCallback<WebhookListResult>) 

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, callback: ServiceCallback<WebhookListResult>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

callback

ServiceCallback<WebhookListResult>

The callback

listByAutomationAccount(string, string, WebhookListByAutomationAccountOptionalParams)

Retrieve a list of webhooks.

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options?: WebhookListByAutomationAccountOptionalParams): Promise<WebhookListByAutomationAccountResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
WebhookListByAutomationAccountOptionalParams

The optional parameters

Returns

Promise<WebhookListByAutomationAccountResponse>

Promise<Models.WebhookListByAutomationAccountResponse>

listByAutomationAccount(string, string, WebhookListByAutomationAccountOptionalParams, ServiceCallback<WebhookListResult>) 

function listByAutomationAccount(resourceGroupName: string, automationAccountName: string, options: WebhookListByAutomationAccountOptionalParams, callback: ServiceCallback<WebhookListResult>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

options
WebhookListByAutomationAccountOptionalParams

The optional parameters

callback

ServiceCallback<WebhookListResult>

The callback

listByAutomationAccountNext(string, RequestOptionsBase)

Retrieve a list of webhooks.

function listByAutomationAccountNext(nextPageLink: string, options?: RequestOptionsBase): Promise<WebhookListByAutomationAccountNextResponse>

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

Returns

Promise<WebhookListByAutomationAccountNextResponse>

Promise<Models.WebhookListByAutomationAccountNextResponse>

listByAutomationAccountNext(string, RequestOptionsBase, ServiceCallback<WebhookListResult>) 

function listByAutomationAccountNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<WebhookListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<WebhookListResult>

The callback

listByAutomationAccountNext(string, ServiceCallback<WebhookListResult>) 

function listByAutomationAccountNext(nextPageLink: string, callback: ServiceCallback<WebhookListResult>)

Parameters

nextPageLink

string

The NextLink from the previous successful call to List operation.

callback

ServiceCallback<WebhookListResult>

The callback

update(string, string, string, WebhookUpdateParameters, RequestOptionsBase)

Update the webhook identified by webhook name.

function update(resourceGroupName: string, automationAccountName: string, webhookName: string, parameters: WebhookUpdateParameters, options?: RequestOptionsBase): Promise<WebhookUpdateResponse>

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

parameters
WebhookUpdateParameters

The update parameters for webhook.

options
RequestOptionsBase

The optional parameters

Returns

Promise<WebhookUpdateResponse>

Promise<Models.WebhookUpdateResponse>

update(string, string, string, WebhookUpdateParameters, RequestOptionsBase, ServiceCallback<Webhook>) 

function update(resourceGroupName: string, automationAccountName: string, webhookName: string, parameters: WebhookUpdateParameters, options: RequestOptionsBase, callback: ServiceCallback<Webhook>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

parameters
WebhookUpdateParameters

The update parameters for webhook.

options
RequestOptionsBase

The optional parameters

callback

ServiceCallback<Webhook>

The callback

update(string, string, string, WebhookUpdateParameters, ServiceCallback<Webhook>) 

function update(resourceGroupName: string, automationAccountName: string, webhookName: string, parameters: WebhookUpdateParameters, callback: ServiceCallback<Webhook>)

Parameters

resourceGroupName

string

Name of an Azure Resource group.

automationAccountName

string

The name of the automation account.

webhookName

string

The webhook name.

parameters
WebhookUpdateParameters

The update parameters for webhook.

callback

ServiceCallback<Webhook>

The callback