@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.07 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Retrieve the runbook identified by runbook name.
*
* Uses Azure REST API version 2023-11-01.
*
* Other available API versions: 2015-10-31, 2018-06-30, 2019-06-01, 2022-08-08, 2023-05-15-preview, 2024-10-23. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native automation [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getRunbook(args: GetRunbookArgs, opts?: pulumi.InvokeOptions): Promise<GetRunbookResult>;
export interface GetRunbookArgs {
/**
* The name of the automation account.
*/
automationAccountName: string;
/**
* Name of an Azure Resource group.
*/
resourceGroupName: string;
/**
* The runbook name.
*/
runbookName: string;
}
/**
* Definition of the runbook type.
*/
export interface GetRunbookResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Gets or sets the creation time.
*/
readonly creationTime?: string;
/**
* Gets or sets the description.
*/
readonly description?: string;
/**
* Gets or sets the draft runbook properties.
*/
readonly draft?: outputs.automation.RunbookDraftResponse;
/**
* Gets or sets the etag of the resource.
*/
readonly etag?: string;
/**
* Fully qualified resource Id for the resource
*/
readonly id: string;
/**
* Gets or sets the job count of the runbook.
*/
readonly jobCount?: number;
/**
* Gets or sets the last modified by.
*/
readonly lastModifiedBy?: string;
/**
* Gets or sets the last modified time.
*/
readonly lastModifiedTime?: string;
/**
* The Azure Region where the resource lives
*/
readonly location?: string;
/**
* Gets or sets the option to log activity trace of the runbook.
*/
readonly logActivityTrace?: number;
/**
* Gets or sets progress log option.
*/
readonly logProgress?: boolean;
/**
* Gets or sets verbose log option.
*/
readonly logVerbose?: boolean;
/**
* The name of the resource
*/
readonly name: string;
/**
* Gets or sets the runbook output types.
*/
readonly outputTypes?: string[];
/**
* Gets or sets the runbook parameters.
*/
readonly parameters?: {
[key: string]: outputs.automation.RunbookParameterResponse;
};
/**
* Gets or sets the provisioning state of the runbook.
*/
readonly provisioningState?: string;
/**
* Gets or sets the type of the runbook.
*/
readonly runbookType?: string;
/**
* Gets or sets the state of the runbook.
*/
readonly state?: string;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource.
*/
readonly type: string;
}
/**
* Retrieve the runbook identified by runbook name.
*
* Uses Azure REST API version 2023-11-01.
*
* Other available API versions: 2015-10-31, 2018-06-30, 2019-06-01, 2022-08-08, 2023-05-15-preview, 2024-10-23. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native automation [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getRunbookOutput(args: GetRunbookOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetRunbookResult>;
export interface GetRunbookOutputArgs {
/**
* The name of the automation account.
*/
automationAccountName: pulumi.Input<string>;
/**
* Name of an Azure Resource group.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The runbook name.
*/
runbookName: pulumi.Input<string>;
}