Dsc Node - Update
Update the dsc node.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/nodes/{nodeId}?api-version=2019-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
automation
|
path | True |
string |
The name of the automation account. |
node
|
path | True |
string |
Parameters supplied to the update dsc node. |
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 |
---|---|---|
nodeId |
string |
Gets or sets the id of the dsc node. |
properties |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK Media Types: "application/json", "text/plain" |
|
Other Status Codes |
Automation error response describing why the operation failed. Media Types: "application/json", "text/plain" |
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 a node
Sample request
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId?api-version=2019-06-01
{
"nodeId": "nodeId",
"properties": {
"nodeConfiguration": {
"name": "SetupServer.localhost"
}
}
}
Sample response
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/nodes/nodeId",
"name": "DSCCOMP",
"type": "Microsoft.Automation/AutomationAccounts/Nodes",
"properties": {
"lastSeen": "2018-03-22T22:25:39.0963773+00:00",
"registrationTime": "2018-03-10T00:51:12.5393083+00:00",
"ip": "ip",
"nodeId": "nodeId",
"status": "Pending",
"nodeConfiguration": {
"name": "SetupServer.localhost"
},
"extensionHandler": [
{
"name": "Microsoft.Powershell.DSC",
"version": "2.75.0.0"
}
]
}
}
Definitions
Name | Description |
---|---|
Dsc |
Definition of a DscNode |
Dsc |
The dsc extensionHandler property associated with the node |
Dsc |
The parameters supplied to the update dsc node operation. |
Error |
Error response of an operation failure |
Properties |
DscNode
Definition of a DscNode
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource Id for the resource |
name |
string |
The name of the resource |
properties.accountId |
string |
Gets or sets the account id of the node. |
properties.etag |
string |
Gets or sets the etag of the resource. |
properties.extensionHandler |
Gets or sets the list of extensionHandler properties for a Node. |
|
properties.ip |
string |
Gets or sets the ip of the node. |
properties.lastSeen |
string |
Gets or sets the last seen time of the node. |
properties.nodeConfiguration.name |
string |
Gets or sets the name of the dsc node configuration. |
properties.nodeId |
string |
Gets or sets the node id. |
properties.registrationTime |
string |
Gets or sets the registration time of the node. |
properties.status |
string |
Gets or sets the status of the node. |
properties.totalCount |
integer |
Gets the total number of records matching filter criteria. |
type |
string |
The type of the resource. |
DscNodeExtensionHandlerAssociationProperty
The dsc extensionHandler property associated with the node
Name | Type | Description |
---|---|---|
name |
string |
Gets or sets the name of the extension handler. |
version |
string |
Gets or sets the version of the extension handler. |
DscNodeUpdateParameters
The parameters supplied to the update dsc node operation.
Name | Type | Description |
---|---|---|
nodeId |
string |
Gets or sets the id of the dsc node. |
properties |
ErrorResponse
Error response of an operation failure
Name | Type | Description |
---|---|---|
code |
string |
Error code |
message |
string |
Error message indicating why the operation failed. |
Properties
Name | Type | Description |
---|---|---|
nodeConfiguration.name |
string |
Gets or sets the name of the dsc node configuration. |