Skip to main content

requests

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

Overview

Namerequests
TypeResource
Idazure.customer_lockbox.requests

Fields

The following fields are returned by SELECT queries:

Retrieval of Customer Lockbox request successful.

NameDatatypeDescription
idstringThe Arm resource id of the Lockbox request.
namestringThe name of the Lockbox request.
propertiesobjectThe properties that are associated with a lockbox request.
typestringThe type of the Lockbox request.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectrequestId, subscriptionIdGet Customer Lockbox request
listselectsubscriptionId$filterLists all of the Lockbox requests in the given subscription.

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.

NameDatatypeDescription
requestIdstringThe Lockbox request ID.
subscriptionIdstringThe Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)
$filterstringThe $filter OData query parameter. Only filter by request status is supported, e.g $filter=properties/status eq 'Pending'

SELECT examples

Get Customer Lockbox request

SELECT
id,
name,
properties,
type
FROM azure.customer_lockbox.requests
WHERE requestId = '{{ requestId }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;