Webhook - Get
Retrieve the webhook identified by webhook name.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}?api-version=2015-10-31
Name | In | Required | Type | Description |
---|---|---|---|---|
automation
|
path | True |
string |
The name of the automation account. |
resource
|
path | True |
string |
Name of an Azure Resource group. Regex pattern: |
subscription
|
path | True |
string |
Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
webhook
|
path | True |
string |
The webhook name. |
api-version
|
query | True |
string |
Client Api Version. |
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Automation error response describing why the operation failed. |
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Sample request
Sample response
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
"name": "TestWebhook",
"properties": {
"isEnabled": true,
"expiryTime": "2018-03-29T22:18:13.7002872+00:00",
"runbook": {
"name": "TestRunbook"
},
"lastInvokedTime": null,
"runOn": null,
"parameters": null,
"uri": "",
"creationTime": "2017-03-29T22:18:14.6651862+00:00",
"lastModifiedBy": "",
"lastModifiedTime": "2017-03-29T22:18:14.6651862+00:00"
}
}
Name | Description |
---|---|
Error |
Error response of an operation failure |
Runbook |
The runbook property associated with the entity. |
Webhook |
Definition of the webhook type. |
Error response of an operation failure
Name | Type | Description |
---|---|---|
code |
string |
Error code |
message |
string |
Error message indicating why the operation failed. |
The runbook property associated with the entity.
Name | Type | Description |
---|---|---|
name |
string |
Gets or sets the name of the runbook. |
Definition of the webhook type.
Name | Type | Default value | Description |
---|---|---|---|
id |
string |
Fully qualified resource Id for the resource |
|
name |
string |
The name of the resource |
|
properties.creationTime |
string |
Gets or sets the creation time. |
|
properties.description |
string |
Gets or sets the description. |
|
properties.expiryTime |
string |
Gets or sets the expiry time. |
|
properties.isEnabled |
boolean |
False |
Gets or sets the value of the enabled flag of the webhook. |
properties.lastInvokedTime |
string |
Gets or sets the last invoked time. |
|
properties.lastModifiedBy |
string |
Details of the user who last modified the Webhook |
|
properties.lastModifiedTime |
string |
Gets or sets the last modified time. |
|
properties.parameters |
object |
Gets or sets the parameters of the job that is created when the webhook calls the runbook it is associated with. |
|
properties.runOn |
string |
Gets or sets the name of the hybrid worker group the webhook job will run on. |
|
properties.runbook |
Gets or sets the runbook the webhook is associated with. |
||
properties.uri |
string |
Gets or sets the webhook uri. |
|
type |
string |
The type of the resource. |