@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.66 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get a watchlist item.
*
* Uses Azure REST API version 2024-09-01.
*
* Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-04-01-preview, 2023-05-01-preview, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview, 2023-10-01-preview, 2023-11-01, 2023-12-01-preview, 2024-01-01-preview, 2024-03-01, 2024-04-01-preview, 2024-10-01-preview, 2025-01-01-preview, 2025-03-01, 2025-04-01-preview, 2025-06-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native securityinsights [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getWatchlistItem(args: GetWatchlistItemArgs, opts?: pulumi.InvokeOptions): Promise<GetWatchlistItemResult>;
export interface GetWatchlistItemArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
/**
* The watchlist alias
*/
watchlistAlias: string;
/**
* The watchlist item id (GUID)
*/
watchlistItemId: string;
/**
* The name of the workspace.
*/
workspaceName: string;
}
/**
* Represents a Watchlist Item in Azure Security Insights.
*/
export interface GetWatchlistItemResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The time the watchlist item was created
*/
readonly created?: string;
/**
* Describes a user that created the watchlist item
*/
readonly createdBy?: outputs.securityinsights.WatchlistUserInfoResponse;
/**
* key-value pairs for a watchlist item entity mapping
*/
readonly entityMapping?: any;
/**
* Etag of the azure resource
*/
readonly etag?: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* A flag that indicates if the watchlist item is deleted or not
*/
readonly isDeleted?: boolean;
/**
* key-value pairs for a watchlist item
*/
readonly itemsKeyValue: any;
/**
* The name of the resource
*/
readonly name: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.securityinsights.SystemDataResponse;
/**
* The tenantId to which the watchlist item belongs to
*/
readonly tenantId?: string;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* The last time the watchlist item was updated
*/
readonly updated?: string;
/**
* Describes a user that updated the watchlist item
*/
readonly updatedBy?: outputs.securityinsights.WatchlistUserInfoResponse;
/**
* The id (a Guid) of the watchlist item
*/
readonly watchlistItemId?: string;
/**
* The type of the watchlist item
*/
readonly watchlistItemType?: string;
}
/**
* Get a watchlist item.
*
* Uses Azure REST API version 2024-09-01.
*
* Other available API versions: 2023-02-01, 2023-03-01-preview, 2023-04-01-preview, 2023-05-01-preview, 2023-06-01-preview, 2023-07-01-preview, 2023-08-01-preview, 2023-09-01-preview, 2023-10-01-preview, 2023-11-01, 2023-12-01-preview, 2024-01-01-preview, 2024-03-01, 2024-04-01-preview, 2024-10-01-preview, 2025-01-01-preview, 2025-03-01, 2025-04-01-preview, 2025-06-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native securityinsights [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getWatchlistItemOutput(args: GetWatchlistItemOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetWatchlistItemResult>;
export interface GetWatchlistItemOutputArgs {
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* The watchlist alias
*/
watchlistAlias: pulumi.Input<string>;
/**
* The watchlist item id (GUID)
*/
watchlistItemId: pulumi.Input<string>;
/**
* The name of the workspace.
*/
workspaceName: pulumi.Input<string>;
}