5.0.0 • Published 5 years ago
@datafire/azure_automation_dsccompilationjob v5.0.0
@datafire/azure_automation_dsccompilationjob
Client library for AutomationManagement
Installation and Usage
npm install --save @datafire/azure_automation_dsccompilationjob
let azure_automation_dsccompilationjob = require('@datafire/azure_automation_dsccompilationjob').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Description
Actions
DscCompilationJob_ListByAutomationAccount
Retrieve a list of dsc compilation jobs.
azure_automation_dsccompilationjob.DscCompilationJob_ListByAutomationAccount({
"resourceGroupName": "",
"automationAccountName": "",
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: Name of an Azure Resource group. - automationAccountName required
string
: The name of the automation account. - $filter
string
: The filter to apply on the operation. - subscriptionId required
string
: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string
: Client Api Version.
- resourceGroupName required
Output
- output DscCompilationJobListResult
DscCompilationJob_Get
Retrieve the Dsc configuration compilation job identified by job id.
azure_automation_dsccompilationjob.DscCompilationJob_Get({
"resourceGroupName": "",
"automationAccountName": "",
"compilationJobName": "",
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: Name of an Azure Resource group. - automationAccountName required
string
: The name of the automation account. - compilationJobName required
string
: The DSC configuration Id. - subscriptionId required
string
: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string
: Client Api Version.
- resourceGroupName required
Output
- output DscCompilationJob
DscCompilationJob_Create
Creates the Dsc compilation job of the configuration.
azure_automation_dsccompilationjob.DscCompilationJob_Create({
"resourceGroupName": "",
"automationAccountName": "",
"compilationJobName": "",
"parameters": null,
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: Name of an Azure Resource group. - automationAccountName required
string
: The name of the automation account. - compilationJobName required
string
: The DSC configuration Id. - parameters required DscCompilationJobCreateParameters
- subscriptionId required
string
: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string
: Client Api Version.
- resourceGroupName required
Output
- output DscCompilationJob
DscCompilationJobStream_ListByJob
Retrieve all the job streams for the compilation Job.
azure_automation_dsccompilationjob.DscCompilationJobStream_ListByJob({
"resourceGroupName": "",
"automationAccountName": "",
"jobId": "",
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: Name of an Azure Resource group. - automationAccountName required
string
: The name of the automation account. - jobId required
string
: The job id. - subscriptionId required
string
: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string
: Client Api Version.
- resourceGroupName required
Output
- output JobStreamListResult
DscCompilationJob_GetStream
Retrieve the job stream identified by job stream id.
azure_automation_dsccompilationjob.DscCompilationJob_GetStream({
"resourceGroupName": "",
"automationAccountName": "",
"jobId": "",
"jobStreamId": "",
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: Name of an Azure Resource group. - automationAccountName required
string
: The name of the automation account. - jobId required
string
: The job id. - jobStreamId required
string
: The job stream id. - subscriptionId required
string
: Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. - api-version required
string
: Client Api Version.
- resourceGroupName required
Output
- output JobStream
Definitions
DscCompilationJob
- DscCompilationJob
object
: Definition of the Dsc Compilation job.- properties DscCompilationJobProperties
- id
string
: Fully qualified resource Id for the resource - name
string
: The name of the resource - type
string
: The type of the resource.
DscCompilationJobCreateParameters
- DscCompilationJobCreateParameters
object
: The parameters supplied to the create compilation job operation.- location
string
: Gets or sets the location of the resource. - name
string
: Gets or sets name of the resource. - properties required DscCompilationJobCreateProperties
- tags
object
: Gets or sets the tags attached to the resource.
- location
DscCompilationJobCreateProperties
- DscCompilationJobCreateProperties
object
: The parameters supplied to the create compilation job operation.- configuration required DscConfigurationAssociationProperty
- incrementNodeConfigurationBuild
boolean
: If a new build version of NodeConfiguration is required. - parameters
object
: Gets or sets the parameters of the job.
DscCompilationJobListResult
- DscCompilationJobListResult
object
: The response model for the list job operation.- nextLink
string
: Gets or sets the next link. - value
array
: Gets or sets a list of Dsc Compilation jobs.- items DscCompilationJob
- nextLink
DscCompilationJobProperties
- DscCompilationJobProperties
object
: Definition of Dsc Compilation job properties.- configuration DscConfigurationAssociationProperty
- creationTime
string
: Gets the creation time of the job. - endTime
string
: Gets the end time of the job. - exception
string
: Gets the exception of the job. - jobId
string
: Gets the id of the job. - lastModifiedTime
string
: Gets the last modified time of the job. - lastStatusModifiedTime
string
: Gets the last status modified time of the job. - parameters
object
: Gets or sets the parameters of the job. - provisioningState JobProvisioningStateProperty
- runOn
string
: Gets or sets the runOn which specifies the group name where the job is to be executed. - startTime
string
: Gets the start time of the job. - startedBy
string
: Gets the compilation job started by. - status
string
(values: New, Activating, Running, Completed, Failed, Stopped, Blocked, Suspended, Disconnected, Suspending, Stopping, Resuming, Removing): Gets or sets the status of the job. - statusDetails
string
: Gets or sets the status details of the job.
DscConfigurationAssociationProperty
- DscConfigurationAssociationProperty
object
: The Dsc configuration property associated with the entity.- name
string
: Gets or sets the name of the Dsc configuration.
- name
JobProvisioningStateProperty
- JobProvisioningStateProperty
string
(values: Failed, Succeeded, Suspended, Processing): The provisioning state of the resource.
JobStream
- JobStream
object
: Definition of the job stream.- id
string
: Gets or sets the id of the resource. - properties JobStreamProperties
- id
JobStreamListResult
- JobStreamListResult
object
: The response model for the list job stream operation.- nextLink
string
: Gets or sets the next link. - value
array
: A list of job streams.- items JobStream
- nextLink
JobStreamProperties
- JobStreamProperties
object
: Definition of the job stream.- jobStreamId
string
: Gets or sets the id of the job stream. - streamText
string
: Gets or sets the stream text. - streamType
string
(values: Progress, Output, Warning, Error, Debug, Verbose, Any): Gets or sets the stream type. - summary
string
: Gets or sets the summary. - time
string
: Gets or sets the creation time of the job. - value
object
: Gets or sets the values of the job stream.
- jobStreamId