Dela via


Webhook - Create Or Update

Skapa webhooken som identifieras med webhook-namnet.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}?api-version=2015-10-31

URI-parametrar

Name I Obligatorisk Typ Description
automationAccountName
path True

string

Namnet på automationskontot.

resourceGroupName
path True

string

minLength: 1
maxLength: 90
pattern: ^[-\w\._]+$

Namnet på en Azure-resursgrupp.

subscriptionId
path True

string

Hämtar prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure-prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

webhookName
path True

string

Webhookens namn.

api-version
query True

string

Klient-API-version.

Begärandetext

Name Obligatorisk Typ Description
name True

string

Hämtar eller anger namnet på webhooken.

properties.expiryTime

string (date-time)

Hämtar eller anger förfallotiden.

properties.isEnabled

boolean

Hämtar eller anger värdet för den aktiverade flaggan webhook.

properties.parameters

object

Hämtar eller anger parametrarna för jobbet.

properties.runOn

string

Hämtar eller anger namnet på den hybridarbetsgrupp som webhook-jobbet ska köras på.

properties.runbook

RunbookAssociationProperty

Hämtar eller ställer in runbooken.

properties.uri

string

Hämtar eller ställer in URI:n.

Svar

Name Typ Description
200 OK

Webhook

OKEJ

201 Created

Webhook

Skapad

Other Status Codes

ErrorResponse

Automation-felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

Create or update webhook

Exempelbegäran

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook?api-version=2015-10-31

{
  "name": "TestWebhook",
  "properties": {
    "isEnabled": true,
    "uri": "<uri>",
    "expiryTime": "2018-03-29T22:18:13.7002872Z",
    "runbook": {
      "name": "TestRunbook"
    }
  }
}

Exempelsvar

{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "name": "TestWebhook",
  "type": "Microsoft.Automation/AutomationAccounts/Webhooks",
  "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"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook",
  "name": "TestWebhook",
  "type": "Microsoft.Automation/AutomationAccounts/Webhooks",
  "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"
  }
}

Definitioner

Name Description
ErrorResponse

Felsvar på ett åtgärdsfel

RunbookAssociationProperty

Runbook-egenskapen som är associerad med entiteten.

Webhook

Definition av typen webhook.

WebhookCreateOrUpdateParameters

Parametrarna som anges för åtgärden skapa eller uppdatera webhook.

ErrorResponse

Felsvar på ett åtgärdsfel

Name Typ Description
code

string

Felkod

message

string

Felmeddelande som anger varför åtgärden misslyckades.

RunbookAssociationProperty

Runbook-egenskapen som är associerad med entiteten.

Name Typ Description
name

string

Hämtar eller anger namnet på runbooken.

Webhook

Definition av typen webhook.

Name Typ Standardvärde Description
id

string

Fullständigt kvalificerat resurs-ID för resursen

name

string

Namnet på resursen

properties.creationTime

string (date-time)

Hämtar eller anger skapandetiden.

properties.description

string

Hämtar eller anger beskrivningen.

properties.expiryTime

string (date-time)

Hämtar eller anger förfallotiden.

properties.isEnabled

boolean

False

Hämtar eller anger värdet för den aktiverade flaggan för webhooken.

properties.lastInvokedTime

string (date-time)

Hämtar eller anger den senast anropade tiden.

properties.lastModifiedBy

string

Information om den användare som senast ändrade Webhook

properties.lastModifiedTime

string (date-time)

Hämtar eller anger den senaste ändrade tiden.

properties.parameters

object

Hämtar eller anger parametrarna för jobbet som skapas när webhooken anropar den runbook som den är associerad med.

properties.runOn

string

Hämtar eller anger namnet på den hybridarbetsgrupp som webhook-jobbet ska köras på.

properties.runbook

RunbookAssociationProperty

Hämtar eller anger den runbook som webhooken är associerad med.

properties.uri

string

Hämtar eller ställer in webhookens uri.

type

string

Resurstypen.

WebhookCreateOrUpdateParameters

Parametrarna som anges för åtgärden skapa eller uppdatera webhook.

Name Typ Description
name

string

Hämtar eller anger namnet på webhooken.

properties.expiryTime

string (date-time)

Hämtar eller anger förfallotiden.

properties.isEnabled

boolean

Hämtar eller anger värdet för den aktiverade flaggan webhook.

properties.parameters

object

Hämtar eller anger parametrarna för jobbet.

properties.runOn

string

Hämtar eller anger namnet på den hybridarbetsgrupp som webhook-jobbet ska köras på.

properties.runbook

RunbookAssociationProperty

Hämtar eller ställer in runbooken.

properties.uri

string

Hämtar eller ställer in URI:n.