5.0.0 • Published 5 years ago
@datafire/azure_automation_webhook v5.0.0
@datafire/azure_automation_webhook
Client library for AutomationManagementClient
Installation and Usage
npm install --save @datafire/azure_automation_webhooklet azure_automation_webhook = require('@datafire/azure_automation_webhook').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});Description
Actions
Webhook_ListByAutomationAccount
Retrieve a list of webhooks.
azure_automation_webhook.Webhook_ListByAutomationAccount({
"resourceGroupName": "",
"automationAccountName": "",
"subscriptionId": "",
"api-version": ""
}, context)Input
- input
object- resourceGroupName required
string: Name of an Azure Resource group. - automationAccountName required
string: The name of the automation account. - $filter
string: The filter to apply on the operation. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string: Client Api Version.
- resourceGroupName required
Output
- output WebhookListResult
Webhook_GenerateUri
Generates a Uri for use in creating a webhook.
azure_automation_webhook.Webhook_GenerateUri({
"resourceGroupName": "",
"automationAccountName": "",
"subscriptionId": "",
"api-version": ""
}, context)Input
- input
object- resourceGroupName required
string: Name of an Azure Resource group. - automationAccountName required
string: The name of the automation account. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string: Client Api Version.
- resourceGroupName required
Output
- output
string
Webhook_Delete
Delete the webhook by name.
azure_automation_webhook.Webhook_Delete({
"resourceGroupName": "",
"automationAccountName": "",
"webhookName": "",
"subscriptionId": "",
"api-version": ""
}, context)Input
- input
object- resourceGroupName required
string: Name of an Azure Resource group. - automationAccountName required
string: The name of the automation account. - webhookName required
string: The webhook name. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string: Client Api Version.
- resourceGroupName required
Output
Output schema unknown
Webhook_Get
Retrieve the webhook identified by webhook name.
azure_automation_webhook.Webhook_Get({
"resourceGroupName": "",
"automationAccountName": "",
"webhookName": "",
"subscriptionId": "",
"api-version": ""
}, context)Input
- input
object- resourceGroupName required
string: Name of an Azure Resource group. - automationAccountName required
string: The name of the automation account. - webhookName required
string: The webhook name. - subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string: Client Api Version.
- resourceGroupName required
Output
- output Webhook
Webhook_Update
Update the webhook identified by webhook name.
azure_automation_webhook.Webhook_Update({
"resourceGroupName": "",
"automationAccountName": "",
"webhookName": "",
"parameters": null,
"subscriptionId": "",
"api-version": ""
}, context)Input
- input
object- resourceGroupName required
string: Name of an Azure Resource group. - automationAccountName required
string: The name of the automation account. - webhookName required
string: The webhook name. - parameters required WebhookUpdateParameters
- subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string: Client Api Version.
- resourceGroupName required
Output
- output Webhook
Webhook_CreateOrUpdate
Create the webhook identified by webhook name.
azure_automation_webhook.Webhook_CreateOrUpdate({
"resourceGroupName": "",
"automationAccountName": "",
"webhookName": "",
"parameters": null,
"subscriptionId": "",
"api-version": ""
}, context)Input
- input
object- resourceGroupName required
string: Name of an Azure Resource group. - automationAccountName required
string: The name of the automation account. - webhookName required
string: The webhook name. - parameters required WebhookCreateOrUpdateParameters
- subscriptionId required
string: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string: Client Api Version.
- resourceGroupName required
Output
- output Webhook
Definitions
RunbookAssociationProperty
- RunbookAssociationProperty
object: The runbook property associated with the entity.- name
string: Gets or sets the name of the runbook.
- name
Webhook
- Webhook
object: Definition of the webhook type.- properties WebhookProperties
- id
string: Fully qualified resource Id for the resource - name
string: The name of the resource - type
string: The type of the resource.
WebhookCreateOrUpdateParameters
- WebhookCreateOrUpdateParameters
object: The parameters supplied to the create or update webhook operation.- name required
string: Gets or sets the name of the webhook. - properties required WebhookCreateOrUpdateProperties
- name required
WebhookCreateOrUpdateProperties
- WebhookCreateOrUpdateProperties
object: The properties of the create webhook operation.- expiryTime
string: Gets or sets the expiry time. - isEnabled
boolean: Gets or sets the value of the enabled flag of webhook. - parameters
object: Gets or sets the parameters of the job. - runOn
string: Gets or sets the name of the hybrid worker group the webhook job will run on. - runbook RunbookAssociationProperty
- uri
string: Gets or sets the uri.
- expiryTime
WebhookListResult
- WebhookListResult
object: The response model for the list webhook operation.- nextLink
string: Gets or sets the next link. - value
array: Gets or sets a list of webhooks.- items Webhook
- nextLink
WebhookProperties
- WebhookProperties
object: Definition of the webhook properties- creationTime
string: Gets or sets the creation time. - description
string: Gets or sets the description. - expiryTime
string: Gets or sets the expiry time. - isEnabled
boolean: Gets or sets the value of the enabled flag of the webhook. - lastInvokedTime
string: Gets or sets the last invoked time. - lastModifiedBy
string: Details of the user who last modified the Webhook - lastModifiedTime
string: Gets or sets the last modified time. - parameters
object: Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with. - runOn
string: Gets or sets the name of the hybrid worker group the webhook job will run on. - runbook RunbookAssociationProperty
- uri
string: Gets or sets the webhook uri.
- creationTime
WebhookUpdateParameters
- WebhookUpdateParameters
object: The parameters supplied to the update webhook operation.- name
string: Gets or sets the name of the webhook. - properties WebhookUpdateProperties
- name
WebhookUpdateProperties
- WebhookUpdateProperties
object: The properties of the update webhook.- description
string: Gets or sets the description of the webhook. - isEnabled
boolean: Gets or sets the value of the enabled flag of webhook. - parameters
object: Gets or sets the parameters of the job. - runOn
string: Gets or sets the name of the hybrid worker group the webhook job will run on.
- description