azure-native.automation.getRunbook

Azure Native v3.16.0, Mar 20 26

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Viewing docs for Azure Native v3.16.0
published on Friday, Mar 20, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-azure-native

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)
public static Output<GetRunbookResult> getRunbook(GetRunbookArgs args, InvokeOptions options)

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:

AzureApiVersion string: The Azure API version of the resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
SystemData Pulumi.AzureNative.Automation.Outputs.SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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.
RuntimeEnvironment string: Runtime Environment of the runbook execution.
State string: Gets or sets the state of the runbook.
Tags Dictionary<string, string>: Resource tags.

AzureApiVersion string: The Azure API version of the resource.
Id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
Location string: The geo-location where the resource lives
Name string: The name of the resource
SystemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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.
RuntimeEnvironment string: Runtime Environment of the runbook execution.
State string: Gets or sets the state of the runbook.
Tags map[string]string: Resource tags.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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<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.
runtimeEnvironment String: Runtime Environment of the runbook execution.
state String: Gets or sets the state of the runbook.
tags Map<String,String>: Resource tags.

azureApiVersion string: The Azure API version of the resource.
id string: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location string: The geo-location where the resource lives
name string: The name of the resource
systemData SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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.
runtimeEnvironment string: Runtime Environment of the runbook execution.
state string: Gets or sets the state of the runbook.
tags {[key: string]: string}: Resource tags.

azure_api_version str: The Azure API version of the resource.
id str: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location str: The geo-location where the resource lives
name str: The name of the resource
system_data SystemDataResponse: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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.
runtime_environment str: Runtime Environment of the runbook execution.
state str: Gets or sets the state of the runbook.
tags Mapping[str, str]: Resource tags.

azureApiVersion String: The Azure API version of the resource.
id String: Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location String: The geo-location where the resource lives
name String: The name of the resource
systemData Property Map: Azure Resource Manager metadata containing createdBy and modifiedBy information.
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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.
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<String>: Gets or sets the runbook output types.
parameters Map<Property 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.
runtimeEnvironment String: Runtime Environment of the runbook execution.
state String: Gets or sets the state of the runbook.
tags Map<String>: 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 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 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 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 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 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 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<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 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<String>: Gets or sets the runbook output types.
parameters Map<Property 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.

SystemDataResponse

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of resource last modification (UTC)
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of resource last modification (UTC)
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of resource last modification (UTC)
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of resource last modification (UTC)
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.