Dsc Compilation Job - Get
Retrieve the Dsc configuration compilation job identified by job id.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Automation/automationAccounts/{automationAccountName}/compilationjobs/{compilationJobName}?api-version=2019-06-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
automation
|
path | True |
string |
The name of the automation account. |
compilation
|
path | True |
string |
The DSC configuration Id. |
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. |
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
Get a DSC Compilation job
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/compilationjobs/TestCompilationJob?api-version=2019-06-01
Sample Response
{
"id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Automation/automationAccounts/myAutomationAccount33/compilationjobs/TestCompilationJob",
"name": "TestCompilationJob",
"type": "Microsoft.Automation/AutomationAccounts/compilationjobs",
"properties": {
"jobId": "ce6fe3e3-9db3-4096-a6b4-82bfb4c10a9a",
"creationTime": "2017-03-28T23:14:26.903+00:00",
"provisioningState": "Processing",
"status": "New",
"statusDetails": "None",
"startTime": null,
"endTime": null,
"lastModifiedTime": "2017-03-28T23:14:26.903+00:00",
"lastStatusModifiedTime": "2017-03-28T23:14:26.903+00:00",
"exception": null,
"parameters": null,
"configuration": {
"name": "SetupServer"
},
"runOn": null
}
}
Definitions
Name | Description |
---|---|
Dsc |
Definition of the Dsc Compilation job. |
Dsc |
The Dsc configuration property associated with the entity. |
Error |
Error response of an operation failure |
Job |
The current provisioning state of the job. |
Job |
Gets or sets the status of the job. |
DscCompilationJob
Definition of the Dsc Compilation job.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource Id for the resource |
name |
string |
The name of the resource |
properties.configuration |
Gets or sets the configuration. |
|
properties.creationTime |
string |
Gets the creation time of the job. |
properties.endTime |
string |
Gets the end time of the job. |
properties.exception |
string |
Gets the exception of the job. |
properties.jobId |
string |
Gets the id of the job. |
properties.lastModifiedTime |
string |
Gets the last modified time of the job. |
properties.lastStatusModifiedTime |
string |
Gets the last status modified time of the job. |
properties.parameters |
object |
Gets or sets the parameters of the job. |
properties.provisioningState |
The current provisioning state of the job. |
|
properties.runOn |
string |
Gets or sets the runOn which specifies the group name where the job is to be executed. |
properties.startTime |
string |
Gets the start time of the job. |
properties.startedBy |
string |
Gets the compilation job started by. |
properties.status |
Gets or sets the status of the job. |
|
properties.statusDetails |
string |
Gets or sets the status details of the job. |
type |
string |
The type of the resource. |
DscConfigurationAssociationProperty
The Dsc configuration property associated with the entity.
Name | Type | Description |
---|---|---|
name |
string |
Gets or sets the name of the Dsc configuration. |
ErrorResponse
Error response of an operation failure
Name | Type | Description |
---|---|---|
code |
string |
Error code |
message |
string |
Error message indicating why the operation failed. |
JobProvisioningState
The current provisioning state of the job.
Name | Type | Description |
---|---|---|
Failed |
string |
|
Processing |
string |
|
Succeeded |
string |
|
Suspended |
string |
JobStatus
Gets or sets the status of the job.
Name | Type | Description |
---|---|---|
Activating |
string |
|
Blocked |
string |
|
Completed |
string |
|
Disconnected |
string |
|
Failed |
string |
|
New |
string |
|
Removing |
string |
|
Resuming |
string |
|
Running |
string |
|
Stopped |
string |
|
Stopping |
string |
|
Suspended |
string |
|
Suspending |
string |