@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.76 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get a single workbook by its resourceName.
*
* 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 function getWorkbook(args: GetWorkbookArgs, opts?: pulumi.InvokeOptions): Promise<GetWorkbookResult>;
export interface GetWorkbookArgs {
/**
* Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.
*/
canFetchContent?: boolean;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The name of the workbook resource. The value must be an UUID.
*/
resourceName: string;
}
/**
* A workbook definition.
*/
export interface GetWorkbookResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* Workbook category, as defined by the user at creation time.
*/
readonly category: string;
/**
* The description of the workbook.
*/
readonly description?: string;
/**
* The user-defined name (display name) of the workbook.
*/
readonly displayName: string;
/**
* Resource etag
*/
readonly etag?: string;
/**
* Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
*/
readonly id: string;
/**
* Identity used for BYOS
*/
readonly identity?: outputs.applicationinsights.WorkbookResourceResponseIdentity;
/**
* The kind of workbook. Only valid value is shared.
*/
readonly kind?: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* The unique revision id for this workbook definition
*/
readonly revision: string;
/**
* Configuration of this particular workbook. Configuration data is a string containing valid JSON
*/
readonly serializedData: string;
/**
* ResourceId for a source resource.
*/
readonly sourceId?: string;
/**
* The resourceId to the storage account when bring your own storage is used
*/
readonly storageUri?: string;
/**
* Metadata pertaining to creation and last modification of the resource.
*/
readonly systemData: outputs.applicationinsights.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* Date and time in UTC of the last modification that was made to this workbook definition.
*/
readonly timeModified: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* Unique user id of the specific user that owns this workbook.
*/
readonly userId: string;
/**
* Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData
*/
readonly version?: string;
}
/**
* Get a single workbook by its resourceName.
*
* 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 function getWorkbookOutput(args: GetWorkbookOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWorkbookResult>;
export interface GetWorkbookOutputArgs {
/**
* Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.
*/
canFetchContent?: pulumi.Input<boolean>;
/**
* 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>;
}