Runbook interface

Package:
@azure/arm-automation

Definition of the runbook type.

Extends
TrackedResource

Properties

creationTime

Gets or sets the creation time.
description

Gets or sets the description.
draft

Gets or sets the draft runbook properties.
etag

Gets or sets the etag of the resource.
jobCount

Gets or sets the job count of the runbook.
lastModifiedBy

Gets or sets the last modified by.
lastModifiedTime

Gets or sets the last modified time.
logActivityTrace

Gets or sets the option to log activity trace of the runbook.
logProgress

Gets or sets progress log option.
logVerbose

Gets or sets verbose log option.
outputTypes

Gets or sets the runbook output types.
parameters

Gets or sets the runbook parameters.
provisioningState

Gets or sets the provisioning state of the runbook.
publishContentLink

Gets or sets the published runbook content link.
runbookType

Gets or sets the type of the runbook.
runtimeEnvironment

Runtime Environment of the runbook execution.
state

Gets or sets the state of the runbook.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

The geo-location where the resource lives
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

creationTime

Gets or sets the creation time.

creationTime?: Date

Property Value

Date

description

Gets or sets the description.

description?: string

Property Value

string

draft

Gets or sets the draft runbook properties.

draft?: RunbookDraft

Property Value

RunbookDraft

etag

Gets or sets the etag of the resource.

etag?: string

Property Value

string

jobCount

Gets or sets the job count of the runbook.

jobCount?: number

Property Value

number

lastModifiedBy

Gets or sets the last modified by.

lastModifiedBy?: string

Property Value

string

lastModifiedTime

Gets or sets the last modified time.

lastModifiedTime?: Date

Property Value

Date

logActivityTrace

Gets or sets the option to log activity trace of the runbook.

logActivityTrace?: number

Property Value

number

logProgress

Gets or sets progress log option.

logProgress?: boolean

Property Value

boolean

logVerbose

Gets or sets verbose log option.

logVerbose?: boolean

Property Value

boolean

outputTypes

Gets or sets the runbook output types.

outputTypes?: string[]

Property Value

string[]

parameters

Gets or sets the runbook parameters.

parameters?: Record<string, RunbookParameter>

Property Value

Record<string, RunbookParameter>

provisioningState

Gets or sets the provisioning state of the runbook.

provisioningState?: "Succeeded"

Property Value

"Succeeded"

Gets or sets the published runbook content link.

publishContentLink?: ContentLink

Property Value

ContentLink

runbookType

Gets or sets the type of the runbook.

runbookType?: string

Property Value

string

runtimeEnvironment

Runtime Environment of the runbook execution.

runtimeEnvironment?: string

Property Value

string

state

Gets or sets the state of the runbook.

state?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

name

The name of the resource

name?: string

Property Value

string

Inherited From TrackedResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From TrackedResource.systemData

tags

Resource tags.

tags?: Record<string, string>

Property Value

Record<string, string>

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From TrackedResource.type