Webhook - Create Or Update
웹후크 이름으로 식별되는 웹후크를 만듭니다.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/webhooks/{webhookName}?api-version=2024-10-23
URI 매개 변수
| Name | In(다음 안에) | 필수 | 형식 | Description |
|---|---|---|---|---|
|
automation
|
path | True |
string |
자동화 계정의 이름입니다. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._]+$ |
Azure 리소스 그룹의 이름입니다. |
|
subscription
|
path | True |
string |
Microsoft Azure 구독을 고유하게 식별하는 구독 자격 증명을 가져옵니다. 구독 ID는 모든 서비스 호출에 대한 URI의 일부를 형성합니다. |
|
webhook
|
path | True |
string |
웹후크 이름입니다. |
|
api-version
|
query | True |
string |
클라이언트 API 버전입니다. |
요청 본문
| Name | 필수 | 형식 | Description |
|---|---|---|---|
| name | True |
string |
웹후크의 이름을 가져오거나 설정합니다. |
| properties.expiryTime |
string (date-time) |
만료 시간을 가져오거나 설정합니다. |
|
| properties.isEnabled |
boolean |
웹후크의 사용 플래그 값을 가져오거나 설정합니다. |
|
| properties.parameters |
object |
작업의 매개 변수를 가져오거나 설정합니다. |
|
| properties.runOn |
string |
웹후크 작업이 실행될 하이브리드 작업자 그룹의 이름을 가져오거나 설정합니다. |
|
| properties.runbook |
Runbook을 가져오거나 설정합니다. |
||
| properties.uri |
string |
URI를 가져오거나 설정합니다. |
응답
| Name | 형식 | Description |
|---|---|---|
| 200 OK |
그래 |
|
| 201 Created |
생성됨 |
|
| Other Status Codes |
작업이 실패한 이유를 설명하는 자동화 오류 응답입니다. |
보안
azure_auth
Azure Active Directory OAuth2 흐름
형식:
oauth2
Flow:
implicit
권한 부여 URL:
https://login.microsoftonline.com/common/oauth2/authorize
범위
| Name | Description |
|---|---|
| user_impersonation | 사용자 계정 가장 |
예제
Create or update webhook
샘플 요청
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/webhooks/TestWebhook?api-version=2024-10-23
{
"name": "TestWebhook",
"properties": {
"isEnabled": true,
"uri": "<uri>",
"expiryTime": "2018-03-29T22:18:13.7002872Z",
"runbook": {
"name": "TestRunbook"
}
}
}
샘플 응답
{
"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"
}
}
정의
| Name | Description |
|---|---|
|
created |
리소스를 만든 ID의 형식입니다. |
|
Error |
작업 실패의 오류 응답 |
|
Runbook |
엔터티와 연결된 Runbook 속성입니다. |
|
system |
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다. |
| Webhook |
웹후크 형식의 정의입니다. |
|
Webhook |
웹후크 만들기 또는 업데이트 작업에 제공된 매개 변수입니다. |
createdByType
리소스를 만든 ID의 형식입니다.
| 값 | Description |
|---|---|
| User | |
| Application | |
| ManagedIdentity | |
| Key |
ErrorResponse
작업 실패의 오류 응답
| Name | 형식 | Description |
|---|---|---|
| code |
string |
오류 코드 |
| message |
string |
작업이 실패한 이유를 나타내는 오류 메시지입니다. |
RunbookAssociationProperty
엔터티와 연결된 Runbook 속성입니다.
| Name | 형식 | Description |
|---|---|---|
| name |
string |
Runbook의 이름을 가져오거나 설정합니다. |
systemData
리소스의 생성 및 마지막 수정과 관련된 메타데이터입니다.
| Name | 형식 | Description |
|---|---|---|
| createdAt |
string (date-time) |
리소스 만들기의 타임스탬프(UTC)입니다. |
| createdBy |
string |
리소스를 만든 ID입니다. |
| createdByType |
리소스를 만든 ID의 형식입니다. |
|
| lastModifiedAt |
string (date-time) |
리소스 마지막 수정의 타임스탬프(UTC) |
| lastModifiedBy |
string |
리소스를 마지막으로 수정한 ID입니다. |
| lastModifiedByType |
리소스를 마지막으로 수정한 ID의 형식입니다. |
Webhook
웹후크 형식의 정의입니다.
| Name | 형식 | Default value | Description |
|---|---|---|---|
| id |
string (arm-id) |
리소스에 대한 정규화된 리소스 ID입니다. 예: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" |
|
| name |
string |
리소스의 이름 |
|
| properties.creationTime |
string (date-time) |
생성 시간을 가져오거나 설정합니다. |
|
| properties.description |
string |
설명을 가져오거나 설정합니다. |
|
| properties.expiryTime |
string (date-time) |
만료 시간을 가져오거나 설정합니다. |
|
| properties.isEnabled |
boolean |
False |
웹후크의 사용 플래그 값을 가져오거나 설정합니다. |
| properties.lastInvokedTime |
string (date-time) |
마지막으로 호출된 시간을 가져오거나 설정합니다. |
|
| properties.lastModifiedBy |
string |
Webhook를 마지막으로 수정한 사용자의 세부 정보 |
|
| properties.lastModifiedTime |
string (date-time) |
마지막으로 수정한 시간을 가져오거나 설정합니다. |
|
| properties.parameters |
object |
웹후크가 연결된 Runbook을 호출할 때 생성되는 작업의 매개 변수를 가져오거나 설정합니다. |
|
| properties.runOn |
string |
웹후크 작업이 실행될 하이브리드 작업자 그룹의 이름을 가져오거나 설정합니다. |
|
| properties.runbook |
웹후크가 연결된 Runbook을 가져오거나 설정합니다. |
||
| properties.uri |
string |
웹후크 URI를 가져오거나 설정합니다. |
|
| systemData |
createdBy 및 modifiedBy 정보가 포함된 Azure Resource Manager 메타데이터입니다. |
||
| type |
string |
리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts" |
WebhookCreateOrUpdateParameters
웹후크 만들기 또는 업데이트 작업에 제공된 매개 변수입니다.
| Name | 형식 | Description |
|---|---|---|
| name |
string |
웹후크의 이름을 가져오거나 설정합니다. |
| properties.expiryTime |
string (date-time) |
만료 시간을 가져오거나 설정합니다. |
| properties.isEnabled |
boolean |
웹후크의 사용 플래그 값을 가져오거나 설정합니다. |
| properties.parameters |
object |
작업의 매개 변수를 가져오거나 설정합니다. |
| properties.runOn |
string |
웹후크 작업이 실행될 하이브리드 작업자 그룹의 이름을 가져오거나 설정합니다. |
| properties.runbook |
Runbook을 가져오거나 설정합니다. |
|
| properties.uri |
string |
URI를 가져오거나 설정합니다. |