azure-native.securityinsights.getWatchlist
Explore with Pulumi AI
Get a watchlist, without its watchlist items. Azure REST API version: 2023-02-01.
Other available API versions: 2019-01-01-preview, 2021-03-01-preview, 2021-04-01, 2021-10-01-preview, 2022-01-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.
Using getWatchlist
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 getWatchlist(args: GetWatchlistArgs, opts?: InvokeOptions): Promise<GetWatchlistResult>
function getWatchlistOutput(args: GetWatchlistOutputArgs, opts?: InvokeOptions): Output<GetWatchlistResult>
def get_watchlist(resource_group_name: Optional[str] = None,
watchlist_alias: Optional[str] = None,
workspace_name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetWatchlistResult
def get_watchlist_output(resource_group_name: Optional[pulumi.Input[str]] = None,
watchlist_alias: Optional[pulumi.Input[str]] = None,
workspace_name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetWatchlistResult]
func LookupWatchlist(ctx *Context, args *LookupWatchlistArgs, opts ...InvokeOption) (*LookupWatchlistResult, error)
func LookupWatchlistOutput(ctx *Context, args *LookupWatchlistOutputArgs, opts ...InvokeOption) LookupWatchlistResultOutput
> Note: This function is named LookupWatchlist
in the Go SDK.
public static class GetWatchlist
{
public static Task<GetWatchlistResult> InvokeAsync(GetWatchlistArgs args, InvokeOptions? opts = null)
public static Output<GetWatchlistResult> Invoke(GetWatchlistInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetWatchlistResult> getWatchlist(GetWatchlistArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: azure-native:securityinsights:getWatchlist
arguments:
# arguments dictionary
The following arguments are supported:
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Watchlist
Alias string - The watchlist alias
- Workspace
Name string - The name of the workspace.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Watchlist
Alias string - The watchlist alias
- Workspace
Name string - The name of the workspace.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- watchlist
Alias String - The watchlist alias
- workspace
Name String - The name of the workspace.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- watchlist
Alias string - The watchlist alias
- workspace
Name string - The name of the workspace.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- watchlist_
alias str - The watchlist alias
- workspace_
name str - The name of the workspace.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- watchlist
Alias String - The watchlist alias
- workspace
Name String - The name of the workspace.
getWatchlist Result
The following output properties are available:
- Display
Name string - The display name of the watchlist
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Items
Search stringKey - The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.
- Name string
- The name of the resource
- Provider string
- The provider of the watchlist
- Source string
- The source of the watchlist
- System
Data Pulumi.Azure Native. Security Insights. Outputs. System Data Response - 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"
- Content
Type string - The content type of the raw content. For now, only text/csv is valid
- Created string
- The time the watchlist was created
- Created
By Pulumi.Azure Native. Security Insights. Outputs. Watchlist User Info Response - Describes a user that created the watchlist
- Default
Duration string - The default duration of a watchlist (in ISO 8601 duration format)
- Description string
- A description of the watchlist
- Etag string
- Etag of the azure resource
- Is
Deleted bool - A flag that indicates if the watchlist is deleted or not
- Labels List<string>
- List of labels relevant to this watchlist
- Number
Of intLines To Skip - The number of lines in a csv content to skip before the header
- Raw
Content string - The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
- Tenant
Id string - The tenantId where the watchlist belongs to
- Updated string
- The last time the watchlist was updated
- Updated
By Pulumi.Azure Native. Security Insights. Outputs. Watchlist User Info Response - Describes a user that updated the watchlist
- Upload
Status string - The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
- Watchlist
Alias string - The alias of the watchlist
- Watchlist
Id string - The id (a Guid) of the watchlist
- Watchlist
Type string - The type of the watchlist
- Display
Name string - The display name of the watchlist
- Id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- Items
Search stringKey - The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.
- Name string
- The name of the resource
- Provider string
- The provider of the watchlist
- Source string
- The source of the watchlist
- System
Data SystemData Response - 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"
- Content
Type string - The content type of the raw content. For now, only text/csv is valid
- Created string
- The time the watchlist was created
- Created
By WatchlistUser Info Response - Describes a user that created the watchlist
- Default
Duration string - The default duration of a watchlist (in ISO 8601 duration format)
- Description string
- A description of the watchlist
- Etag string
- Etag of the azure resource
- Is
Deleted bool - A flag that indicates if the watchlist is deleted or not
- Labels []string
- List of labels relevant to this watchlist
- Number
Of intLines To Skip - The number of lines in a csv content to skip before the header
- Raw
Content string - The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
- Tenant
Id string - The tenantId where the watchlist belongs to
- Updated string
- The last time the watchlist was updated
- Updated
By WatchlistUser Info Response - Describes a user that updated the watchlist
- Upload
Status string - The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
- Watchlist
Alias string - The alias of the watchlist
- Watchlist
Id string - The id (a Guid) of the watchlist
- Watchlist
Type string - The type of the watchlist
- display
Name String - The display name of the watchlist
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- items
Search StringKey - The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.
- name String
- The name of the resource
- provider String
- The provider of the watchlist
- source String
- The source of the watchlist
- system
Data SystemData Response - 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"
- content
Type String - The content type of the raw content. For now, only text/csv is valid
- created String
- The time the watchlist was created
- created
By WatchlistUser Info Response - Describes a user that created the watchlist
- default
Duration String - The default duration of a watchlist (in ISO 8601 duration format)
- description String
- A description of the watchlist
- etag String
- Etag of the azure resource
- is
Deleted Boolean - A flag that indicates if the watchlist is deleted or not
- labels List<String>
- List of labels relevant to this watchlist
- number
Of IntegerLines To Skip - The number of lines in a csv content to skip before the header
- raw
Content String - The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
- tenant
Id String - The tenantId where the watchlist belongs to
- updated String
- The last time the watchlist was updated
- updated
By WatchlistUser Info Response - Describes a user that updated the watchlist
- upload
Status String - The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
- watchlist
Alias String - The alias of the watchlist
- watchlist
Id String - The id (a Guid) of the watchlist
- watchlist
Type String - The type of the watchlist
- display
Name string - The display name of the watchlist
- id string
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- items
Search stringKey - The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.
- name string
- The name of the resource
- provider string
- The provider of the watchlist
- source string
- The source of the watchlist
- system
Data SystemData Response - 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"
- content
Type string - The content type of the raw content. For now, only text/csv is valid
- created string
- The time the watchlist was created
- created
By WatchlistUser Info Response - Describes a user that created the watchlist
- default
Duration string - The default duration of a watchlist (in ISO 8601 duration format)
- description string
- A description of the watchlist
- etag string
- Etag of the azure resource
- is
Deleted boolean - A flag that indicates if the watchlist is deleted or not
- labels string[]
- List of labels relevant to this watchlist
- number
Of numberLines To Skip - The number of lines in a csv content to skip before the header
- raw
Content string - The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
- tenant
Id string - The tenantId where the watchlist belongs to
- updated string
- The last time the watchlist was updated
- updated
By WatchlistUser Info Response - Describes a user that updated the watchlist
- upload
Status string - The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
- watchlist
Alias string - The alias of the watchlist
- watchlist
Id string - The id (a Guid) of the watchlist
- watchlist
Type string - The type of the watchlist
- display_
name str - The display name of the watchlist
- id str
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- items_
search_ strkey - The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.
- name str
- The name of the resource
- provider str
- The provider of the watchlist
- source str
- The source of the watchlist
- system_
data SystemData Response - 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"
- content_
type str - The content type of the raw content. For now, only text/csv is valid
- created str
- The time the watchlist was created
- created_
by WatchlistUser Info Response - Describes a user that created the watchlist
- default_
duration str - The default duration of a watchlist (in ISO 8601 duration format)
- description str
- A description of the watchlist
- etag str
- Etag of the azure resource
- is_
deleted bool - A flag that indicates if the watchlist is deleted or not
- labels Sequence[str]
- List of labels relevant to this watchlist
- number_
of_ intlines_ to_ skip - The number of lines in a csv content to skip before the header
- raw_
content str - The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
- tenant_
id str - The tenantId where the watchlist belongs to
- updated str
- The last time the watchlist was updated
- updated_
by WatchlistUser Info Response - Describes a user that updated the watchlist
- upload_
status str - The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
- watchlist_
alias str - The alias of the watchlist
- watchlist_
id str - The id (a Guid) of the watchlist
- watchlist_
type str - The type of the watchlist
- display
Name String - The display name of the watchlist
- id String
- Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
- items
Search StringKey - The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.
- name String
- The name of the resource
- provider String
- The provider of the watchlist
- source String
- The source of the watchlist
- system
Data 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"
- content
Type String - The content type of the raw content. For now, only text/csv is valid
- created String
- The time the watchlist was created
- created
By Property Map - Describes a user that created the watchlist
- default
Duration String - The default duration of a watchlist (in ISO 8601 duration format)
- description String
- A description of the watchlist
- etag String
- Etag of the azure resource
- is
Deleted Boolean - A flag that indicates if the watchlist is deleted or not
- labels List<String>
- List of labels relevant to this watchlist
- number
Of NumberLines To Skip - The number of lines in a csv content to skip before the header
- raw
Content String - The raw content that represents to watchlist items to create. Example : This line will be skipped header1,header2 value1,value2
- tenant
Id String - The tenantId where the watchlist belongs to
- updated String
- The last time the watchlist was updated
- updated
By Property Map - Describes a user that updated the watchlist
- upload
Status String - The status of the Watchlist upload : New, InProgress or Complete. Note : When a Watchlist upload status is InProgress, the Watchlist cannot be deleted
- watchlist
Alias String - The alias of the watchlist
- watchlist
Id String - The id (a Guid) of the watchlist
- watchlist
Type String - The type of the watchlist
Supporting Types
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
WatchlistUserInfoResponse
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0