Azure Native

Pulumi Official
Package maintained by Pulumi
v1.64.1 published on Wednesday, May 18, 2022 by Pulumi

getRunbook

Definition of the runbook type. API Version: 2019-06-01.

Using getRunbook

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getRunbook(args: GetRunbookArgs, opts?: InvokeOptions): Promise<GetRunbookResult>
function getRunbookOutput(args: GetRunbookOutputArgs, opts?: InvokeOptions): Output<GetRunbookResult>
def get_runbook(automation_account_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                runbook_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetRunbookResult
def get_runbook_output(automation_account_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                runbook_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetRunbookResult]
func LookupRunbook(ctx *Context, args *LookupRunbookArgs, opts ...InvokeOption) (*LookupRunbookResult, error)
func LookupRunbookOutput(ctx *Context, args *LookupRunbookOutputArgs, opts ...InvokeOption) LookupRunbookResultOutput

> Note: This function is named LookupRunbook in the Go SDK.

public static class GetRunbook 
{
    public static Task<GetRunbookResult> InvokeAsync(GetRunbookArgs args, InvokeOptions? opts = null)
    public static Output<GetRunbookResult> Invoke(GetRunbookInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetRunbookResult> getRunbook(GetRunbookArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:automation:getRunbook
  Arguments:
    # Arguments dictionary

The following arguments are supported:

AutomationAccountName string

The name of the automation account.

ResourceGroupName string

Name of an Azure Resource group.

RunbookName string

The runbook name.

AutomationAccountName string

The name of the automation account.

ResourceGroupName string

Name of an Azure Resource group.

RunbookName string

The runbook name.

automationAccountName String

The name of the automation account.

resourceGroupName String

Name of an Azure Resource group.

runbookName String

The runbook name.

automationAccountName string

The name of the automation account.

resourceGroupName string

Name of an Azure Resource group.

runbookName string

The runbook name.

automation_account_name str

The name of the automation account.

resource_group_name str

Name of an Azure Resource group.

runbook_name str

The runbook name.

automationAccountName String

The name of the automation account.

resourceGroupName String

Name of an Azure Resource group.

runbookName String

The runbook name.

getRunbook Result

The following output properties are available:

Id string

Fully qualified resource Id for the resource

Name string

The name of the resource

Type string

The type of the resource.

CreationTime string

Gets or sets the creation time.

Description string

Gets or sets the description.

Draft Pulumi.AzureNative.Automation.Outputs.RunbookDraftResponse

Gets or sets the draft runbook properties.

Etag string

Gets or sets the etag of the resource.

JobCount int

Gets or sets the job count of the runbook.

LastModifiedBy string

Gets or sets the last modified by.

LastModifiedTime string

Gets or sets the last modified time.

Location string

The Azure Region where the resource lives

LogActivityTrace int

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

LogProgress bool

Gets or sets progress log option.

LogVerbose bool

Gets or sets verbose log option.

OutputTypes List<string>

Gets or sets the runbook output types.

Parameters Dictionary<string, Pulumi.AzureNative.Automation.Outputs.RunbookParameterResponse>

Gets or sets the runbook parameters.

ProvisioningState string

Gets or sets the provisioning state of the runbook.

PublishContentLink Pulumi.AzureNative.Automation.Outputs.ContentLinkResponse

Gets or sets the published runbook content link.

RunbookType string

Gets or sets the type of the runbook.

State string

Gets or sets the state of the runbook.

Tags Dictionary<string, string>

Resource tags.

Id string

Fully qualified resource Id for the resource

Name string

The name of the resource

Type string

The type of the resource.

CreationTime string

Gets or sets the creation time.

Description string

Gets or sets the description.

Draft RunbookDraftResponse

Gets or sets the draft runbook properties.

Etag string

Gets or sets the etag of the resource.

JobCount int

Gets or sets the job count of the runbook.

LastModifiedBy string

Gets or sets the last modified by.

LastModifiedTime string

Gets or sets the last modified time.

Location string

The Azure Region where the resource lives

LogActivityTrace int

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

LogProgress bool

Gets or sets progress log option.

LogVerbose bool

Gets or sets verbose log option.

OutputTypes []string

Gets or sets the runbook output types.

Parameters map[string]RunbookParameterResponse

Gets or sets the runbook parameters.

ProvisioningState string

Gets or sets the provisioning state of the runbook.

PublishContentLink ContentLinkResponse

Gets or sets the published runbook content link.

RunbookType string

Gets or sets the type of the runbook.

State string

Gets or sets the state of the runbook.

Tags map[string]string

Resource tags.

id String

Fully qualified resource Id for the resource

name String

The name of the resource

type String

The type of the resource.

creationTime String

Gets or sets the creation time.

description String

Gets or sets the description.

draft RunbookDraftResponse

Gets or sets the draft runbook properties.

etag String

Gets or sets the etag of the resource.

jobCount Integer

Gets or sets the job count of the runbook.

lastModifiedBy String

Gets or sets the last modified by.

lastModifiedTime String

Gets or sets the last modified time.

location String

The Azure Region where the resource lives

logActivityTrace Integer

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

logProgress Boolean

Gets or sets progress log option.

logVerbose Boolean

Gets or sets verbose log option.

outputTypes List

Gets or sets the runbook output types.

parameters MapParameterResponse>

Gets or sets the runbook parameters.

provisioningState String

Gets or sets the provisioning state of the runbook.

publishContentLink ContentLinkResponse

Gets or sets the published runbook content link.

runbookType String

Gets or sets the type of the runbook.

state String

Gets or sets the state of the runbook.

tags Map

Resource tags.

id string

Fully qualified resource Id for the resource

name string

The name of the resource

type string

The type of the resource.

creationTime string

Gets or sets the creation time.

description string

Gets or sets the description.

draft RunbookDraftResponse

Gets or sets the draft runbook properties.

etag string

Gets or sets the etag of the resource.

jobCount number

Gets or sets the job count of the runbook.

lastModifiedBy string

Gets or sets the last modified by.

lastModifiedTime string

Gets or sets the last modified time.

location string

The Azure Region where the resource lives

logActivityTrace number

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

logProgress boolean

Gets or sets progress log option.

logVerbose boolean

Gets or sets verbose log option.

outputTypes string[]

Gets or sets the runbook output types.

parameters {[key: string]: RunbookParameterResponse}

Gets or sets the runbook parameters.

provisioningState string

Gets or sets the provisioning state of the runbook.

publishContentLink ContentLinkResponse

Gets or sets the published runbook content link.

runbookType string

Gets or sets the type of the runbook.

state string

Gets or sets the state of the runbook.

tags {[key: string]: string}

Resource tags.

id str

Fully qualified resource Id for the resource

name str

The name of the resource

type str

The type of the resource.

creation_time str

Gets or sets the creation time.

description str

Gets or sets the description.

draft RunbookDraftResponse

Gets or sets the draft runbook properties.

etag str

Gets or sets the etag of the resource.

job_count int

Gets or sets the job count of the runbook.

last_modified_by str

Gets or sets the last modified by.

last_modified_time str

Gets or sets the last modified time.

location str

The Azure Region where the resource lives

log_activity_trace int

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

log_progress bool

Gets or sets progress log option.

log_verbose bool

Gets or sets verbose log option.

output_types Sequence[str]

Gets or sets the runbook output types.

parameters Mapping[str, RunbookParameterResponse]

Gets or sets the runbook parameters.

provisioning_state str

Gets or sets the provisioning state of the runbook.

publish_content_link ContentLinkResponse

Gets or sets the published runbook content link.

runbook_type str

Gets or sets the type of the runbook.

state str

Gets or sets the state of the runbook.

tags Mapping[str, str]

Resource tags.

id String

Fully qualified resource Id for the resource

name String

The name of the resource

type String

The type of the resource.

creationTime String

Gets or sets the creation time.

description String

Gets or sets the description.

draft Property Map

Gets or sets the draft runbook properties.

etag String

Gets or sets the etag of the resource.

jobCount Number

Gets or sets the job count of the runbook.

lastModifiedBy String

Gets or sets the last modified by.

lastModifiedTime String

Gets or sets the last modified time.

location String

The Azure Region where the resource lives

logActivityTrace Number

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

logProgress Boolean

Gets or sets progress log option.

logVerbose Boolean

Gets or sets verbose log option.

outputTypes List

Gets or sets the runbook output types.

parameters Map

Gets or sets the runbook parameters.

provisioningState String

Gets or sets the provisioning state of the runbook.

publishContentLink Property Map

Gets or sets the published runbook content link.

runbookType String

Gets or sets the type of the runbook.

state String

Gets or sets the state of the runbook.

tags Map

Resource tags.

Supporting Types

ContentHashResponse

Algorithm string

Gets or sets the content hash algorithm used to hash the content.

Value string

Gets or sets expected hash value of the content.

Algorithm string

Gets or sets the content hash algorithm used to hash the content.

Value string

Gets or sets expected hash value of the content.

algorithm String

Gets or sets the content hash algorithm used to hash the content.

value String

Gets or sets expected hash value of the content.

algorithm string

Gets or sets the content hash algorithm used to hash the content.

value string

Gets or sets expected hash value of the content.

algorithm str

Gets or sets the content hash algorithm used to hash the content.

value str

Gets or sets expected hash value of the content.

algorithm String

Gets or sets the content hash algorithm used to hash the content.

value String

Gets or sets expected hash value of the content.

ContentLinkResponse

ContentHash Pulumi.AzureNative.Automation.Inputs.ContentHashResponse

Gets or sets the hash.

Uri string

Gets or sets the uri of the runbook content.

Version string

Gets or sets the version of the content.

ContentHash ContentHashResponse

Gets or sets the hash.

Uri string

Gets or sets the uri of the runbook content.

Version string

Gets or sets the version of the content.

contentHash ContentHashResponse

Gets or sets the hash.

uri String

Gets or sets the uri of the runbook content.

version String

Gets or sets the version of the content.

contentHash ContentHashResponse

Gets or sets the hash.

uri string

Gets or sets the uri of the runbook content.

version string

Gets or sets the version of the content.

content_hash ContentHashResponse

Gets or sets the hash.

uri str

Gets or sets the uri of the runbook content.

version str

Gets or sets the version of the content.

contentHash Property Map

Gets or sets the hash.

uri String

Gets or sets the uri of the runbook content.

version String

Gets or sets the version of the content.

RunbookDraftResponse

CreationTime string

Gets or sets the creation time of the runbook draft.

DraftContentLink Pulumi.AzureNative.Automation.Inputs.ContentLinkResponse

Gets or sets the draft runbook content link.

InEdit bool

Gets or sets whether runbook is in edit mode.

LastModifiedTime string

Gets or sets the last modified time of the runbook draft.

OutputTypes List<string>

Gets or sets the runbook output types.

Parameters Dictionary<string, Pulumi.AzureNative.Automation.Inputs.RunbookParameterResponse>

Gets or sets the runbook draft parameters.

CreationTime string

Gets or sets the creation time of the runbook draft.

DraftContentLink ContentLinkResponse

Gets or sets the draft runbook content link.

InEdit bool

Gets or sets whether runbook is in edit mode.

LastModifiedTime string

Gets or sets the last modified time of the runbook draft.

OutputTypes []string

Gets or sets the runbook output types.

Parameters map[string]RunbookParameterResponse

Gets or sets the runbook draft parameters.

creationTime String

Gets or sets the creation time of the runbook draft.

draftContentLink ContentLinkResponse

Gets or sets the draft runbook content link.

inEdit Boolean

Gets or sets whether runbook is in edit mode.

lastModifiedTime String

Gets or sets the last modified time of the runbook draft.

outputTypes List

Gets or sets the runbook output types.

parameters MapParameterResponse>

Gets or sets the runbook draft parameters.

creationTime string

Gets or sets the creation time of the runbook draft.

draftContentLink ContentLinkResponse

Gets or sets the draft runbook content link.

inEdit boolean

Gets or sets whether runbook is in edit mode.

lastModifiedTime string

Gets or sets the last modified time of the runbook draft.

outputTypes string[]

Gets or sets the runbook output types.

parameters {[key: string]: RunbookParameterResponse}

Gets or sets the runbook draft parameters.

creation_time str

Gets or sets the creation time of the runbook draft.

draft_content_link ContentLinkResponse

Gets or sets the draft runbook content link.

in_edit bool

Gets or sets whether runbook is in edit mode.

last_modified_time str

Gets or sets the last modified time of the runbook draft.

output_types Sequence[str]

Gets or sets the runbook output types.

parameters Mapping[str, RunbookParameterResponse]

Gets or sets the runbook draft parameters.

creationTime String

Gets or sets the creation time of the runbook draft.

draftContentLink Property Map

Gets or sets the draft runbook content link.

inEdit Boolean

Gets or sets whether runbook is in edit mode.

lastModifiedTime String

Gets or sets the last modified time of the runbook draft.

outputTypes List

Gets or sets the runbook output types.

parameters Map

Gets or sets the runbook draft parameters.

RunbookParameterResponse

DefaultValue string

Gets or sets the default value of parameter.

IsMandatory bool

Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

Position int

Get or sets the position of the parameter.

Type string

Gets or sets the type of the parameter.

DefaultValue string

Gets or sets the default value of parameter.

IsMandatory bool

Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

Position int

Get or sets the position of the parameter.

Type string

Gets or sets the type of the parameter.

defaultValue String

Gets or sets the default value of parameter.

isMandatory Boolean

Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

position Integer

Get or sets the position of the parameter.

type String

Gets or sets the type of the parameter.

defaultValue string

Gets or sets the default value of parameter.

isMandatory boolean

Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

position number

Get or sets the position of the parameter.

type string

Gets or sets the type of the parameter.

default_value str

Gets or sets the default value of parameter.

is_mandatory bool

Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

position int

Get or sets the position of the parameter.

type str

Gets or sets the type of the parameter.

defaultValue String

Gets or sets the default value of parameter.

isMandatory Boolean

Gets or sets a Boolean value to indicate whether the parameter is mandatory or not.

position Number

Get or sets the position of the parameter.

type String

Gets or sets the type of the parameter.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0