Get-OMSAPISignature

NAME Get-OMSAPISignature



SYNOPSIS

Builds an OMS authorization to securely communicate to a customer workspace.





SYNTAX

Get-OMSAPISignature [-customerId] <Object> [-sharedKey] <Object> [-date] <Object> [-contentLength] <Object>

[-method] <Object> [-contentType] <Object> [-resource] <Object> [<CommonParameters>]





DESCRIPTION

Leveraging a customer workspaceID and private key for Log Analytics

this function will build the necessary api signature to securely send

json data to the OMS ingestion API for indexing





PARAMETERS

-customerId <Object>

The customer workspace ID that can be found within the settings pane of the

OMS workspace.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-sharedKey <Object>

The primary or secondary private key for the customer OMS workspace

found within the same view as the workspace ID within the settings pane



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-date <Object>

RFC 1123 standard UTC date string converted variable used for ingestion time stamp



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-contentLength <Object>

Body length for payload being sent to the ingestion endpoint



Required? true

Position? 4

Default value

Accept pipeline input? false

Accept wildcard characters? false



-method <Object>

Rest method used (POST)



Required? true

Position? 5

Default value

Accept pipeline input? false

Accept wildcard characters? false



-contentType <Object>

Type of data being sent in the payload to the endpoint (application/json)



Required? true

Position? 6

Default value

Accept pipeline input? false

Accept wildcard characters? false



-resource <Object>

Path to send the logs for ingestion to the rest endpoint



Required? true

Position? 7

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS





RELATED LINKS