Hybrid Runbook Worker Group - Update
Update a hybrid runbook worker group.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/hybridRunbookWorkerGroups/{hybridRunbookWorkerGroupName}?api-version=2023-11-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
automation
|
path | True |
string |
The name of the automation account. |
hybrid
|
path | True |
string |
The hybrid runbook worker group name |
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. |
api-version
|
query | True |
string |
Client Api Version. |
Request Body
Name | Type | Description |
---|---|---|
name |
string |
Gets or sets the name of the resource. |
properties.credential |
Sets the credential of a worker group. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
Automation error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
Update hybrid worker group
Sample request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/testaccount/hybridRunbookWorkerGroups/TestHybridGroup?api-version=2023-11-01
{
"properties": {
"credential": {
"name": "myRunAsCredentialUpdatedName"
}
}
}
Sample response
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/testaccount/hybridRunbookWorkerGroups/TestHybridGroup",
"name": "TestHybridGroup",
"properties": {
"groupType": "User",
"credential": {
"name": "myRunAsCredentialUpdatedName"
}
},
"systemData": {
"createdBy": "foo@contoso.com",
"createdByType": "User",
"createdAt": "2018-04-24T16:30:55+00:00",
"lastModifiedBy": "foo@contoso.com",
"lastModifiedByType": "User",
"lastModifiedAt": "2018-04-24T16:30:55+00:00"
}
}
Definitions
Name | Description |
---|---|
created |
The type of identity that created the resource. |
Error |
Error response of an operation failure |
Group |
Type of the HybridWorkerGroup. |
Hybrid |
Definition of hybrid runbook worker group. |
Hybrid |
The parameters supplied to the create hybrid runbook worker group operation. |
Run |
Definition of RunAs credential to use for hybrid worker. |
system |
Metadata pertaining to creation and last modification of the resource. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
ErrorResponse
Error response of an operation failure
Name | Type | Description |
---|---|---|
code |
string |
Error code |
message |
string |
Error message indicating why the operation failed. |
GroupTypeEnum
Type of the HybridWorkerGroup.
Name | Type | Description |
---|---|---|
System |
string |
|
User |
string |
HybridRunbookWorkerGroup
Definition of hybrid runbook worker group.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource Id for the resource |
name |
string |
The name of the resource |
properties.credential |
Sets the credential of a worker group. |
|
properties.groupType |
Type of the HybridWorkerGroup. |
|
systemData |
Resource system metadata. |
|
type |
string |
The type of the resource. |
HybridRunbookWorkerGroupCreateOrUpdateParameters
The parameters supplied to the create hybrid runbook worker group operation.
Name | Type | Description |
---|---|---|
name |
string |
Gets or sets the name of the resource. |
properties.credential |
Sets the credential of a worker group. |
RunAsCredentialAssociationProperty
Definition of RunAs credential to use for hybrid worker.
Name | Type | Description |
---|---|---|
name |
string |
Gets or sets the name of the credential. |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The timestamp of resource last modification (UTC) |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |