content_packages

Creates, updates, deletes, gets or lists a content_packages resource.

Overview

Name	content_packages
Type	Resource
Id	azure.sentinel.content_packages

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
etag	string	Etag of the azure resource
properties	object	package properties

list

Name	Datatype	Description
etag	string	Etag of the azure resource
properties	object	package properties

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName, packageId		Gets an installed packages by its id.
list	select	subscriptionId, resourceGroupName, workspaceName	$filter, $orderby, $search, $count, $top, $skip, $skipToken	Gets all installed packages.
install	exec	subscriptionId, resourceGroupName, workspaceName, packageId		Install a package to the workspace.
uninstall	exec	subscriptionId, resourceGroupName, workspaceName, packageId		Uninstall a package from the workspace.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
packageId	string	package Id
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The name of the workspace.
$count	boolean	Instructs the server to return only object count without actual body. Optional.
$filter	string	Filters the results, based on a Boolean condition. Optional.
$orderby	string	Sorts the results. Optional.
$search	string	Searches for a substring in the response. Optional.
$skip	integer (int32)	Used to skip n elements in the OData query (offset). Returns a nextLink to the next page of results if there are any left.
$skipToken	string	Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls. Optional.
$top	integer (int32)	Returns only the first n results. Optional.

SELECT examples

get

Gets an installed packages by its id.

SELECT
etag,
properties
FROM azure.sentinel.content_packages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND packageId = '{{ packageId }}' -- required
;

list

Gets all installed packages.

SELECT
etag,
properties
FROM azure.sentinel.content_packages
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
AND $filter = '{{ $filter }}'
AND $orderby = '{{ $orderby }}'
AND $search = '{{ $search }}'
AND $count = '{{ $count }}'
AND $top = '{{ $top }}'
AND $skip = '{{ $skip }}'
AND $skipToken = '{{ $skipToken }}'
;

Lifecycle Methods

install

Install a package to the workspace.

EXEC azure.sentinel.content_packages.install 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@packageId='{{ packageId }}' --required 
@@json=
'{
"etag": "{{ etag }}", 
"properties": "{{ properties }}"
}'
;

uninstall

Uninstall a package from the workspace.

EXEC azure.sentinel.content_packages.uninstall 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required, 
@packageId='{{ packageId }}' --required
;