@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* A workbook definition.
*
* Uses Azure REST API version 2023-06-01.
*
* Other available API versions: 2015-05-01, 2018-06-17-preview, 2020-10-20, 2021-03-08, 2021-08-01, 2022-04-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native applicationinsights [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Workbook extends pulumi.CustomResource {
/**
* Get an existing Workbook resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Workbook;
/**
* Returns true if the given object is an instance of Workbook. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Workbook;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Workbook category, as defined by the user at creation time.
*/
readonly category: pulumi.Output<string>;
/**
* The description of the workbook.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* The user-defined name (display name) of the workbook.
*/
readonly displayName: pulumi.Output<string>;
/**
* Resource etag
*/
readonly etag: pulumi.Output<string | undefined>;
/**
* Identity used for BYOS
*/
readonly identity: pulumi.Output<outputs.applicationinsights.WorkbookResourceResponseIdentity | undefined>;
/**
* The kind of workbook. Only valid value is shared.
*/
readonly kind: pulumi.Output<string | undefined>;
/**
* The geo-location where the resource lives
*/
readonly location: pulumi.Output<string>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* The unique revision id for this workbook definition
*/
readonly revision: pulumi.Output<string>;
/**
* Configuration of this particular workbook. Configuration data is a string containing valid JSON
*/
readonly serializedData: pulumi.Output<string>;
/**
* ResourceId for a source resource.
*/
readonly sourceId: pulumi.Output<string | undefined>;
/**
* The resourceId to the storage account when bring your own storage is used
*/
readonly storageUri: pulumi.Output<string | undefined>;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: pulumi.Output<outputs.applicationinsights.SystemDataResponse>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Date and time in UTC of the last modification that was made to this workbook definition.
*/
readonly timeModified: pulumi.Output<string>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Unique user id of the specific user that owns this workbook.
*/
readonly userId: pulumi.Output<string>;
/**
* Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData
*/
readonly version: pulumi.Output<string | undefined>;
/**
* Create a Workbook resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: WorkbookArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Workbook resource.
*/
export interface WorkbookArgs {
/**
* Workbook category, as defined by the user at creation time.
*/
category: pulumi.Input<string>;
/**
* The description of the workbook.
*/
description?: pulumi.Input<string>;
/**
* The user-defined name (display name) of the workbook.
*/
displayName: pulumi.Input<string>;
/**
* Identity used for BYOS
*/
identity?: pulumi.Input<inputs.applicationinsights.WorkbookResourceIdentityArgs>;
/**
* The kind of workbook. Only valid value is shared.
*/
kind?: pulumi.Input<string | enums.applicationinsights.WorkbookSharedTypeKind>;
/**
* The geo-location where the resource lives
*/
location?: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The name of the workbook resource. The value must be an UUID.
*/
resourceName?: pulumi.Input<string>;
/**
* Configuration of this particular workbook. Configuration data is a string containing valid JSON
*/
serializedData: pulumi.Input<string>;
/**
* ResourceId for a source resource.
*/
sourceId?: pulumi.Input<string>;
/**
* The resourceId to the storage account when bring your own storage is used
*/
storageUri?: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData
*/
version?: pulumi.Input<string>;
}