Microsoft.CustomerLockbox (preview:2018-02-28)

2025/09/26 • 7 new, 7 deleted methods

Operations_List (new)
Description :  Lists all the available REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CustomerLockbox/operations
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Customer Lockbox operations supported by the Microsoft.StreamAnalytics resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets action name ,
Required: False ,
}
string ,
isDataAction:
{
Description: Gets or sets a value indicating whether it is a data plane action ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this particular operation / action. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly form of the resource type related to this action/operation. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets properties ,
Required: False ,
}
string ,
origin:
{
Description: Gets or sets origin ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Get_TenantOptedIn (new)
Description :  Get Customer Lockbox request
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CustomerLockbox/tenantOptedIn/{tenantId}
{
tenantId:
{
Description: The Azure tenant ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isOptedIn:
{
Description: True if tenant is opted in, false otherwise ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Post_EnableLockbox (new)
Description :  Enable Tenant for Lockbox
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CustomerLockbox/enableLockbox
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Post_DisableLockbox (new)
Description :  Disable Tenant for Lockbox
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CustomerLockbox/disableLockbox
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Requests_Get (new)
Description :  Get Customer Lockbox request
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomerLockbox/requests/{requestId}
{
requestId:
{
Description: The Lockbox request ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The Arm resource id of the Lockbox request. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Lockbox request. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Lockbox request. ,
Required: False ,
}
string ,
properties:
{
Description: The properties that are associated with a lockbox request. ,
Required: False ,
}
{
requestId:
{
Description: The Lockbox request ID. ,
Required: False ,
}
string ,
justification:
{
Description: The justification of the requestor. ,
Required: False ,
}
string ,
status:
{
Description: The status of the request. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: The creation time of the request. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: The expiration time of the request. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the request in hours. ,
Required: False ,
}
string ,
resourceIds:
{
Description: A list of resource IDs associated with the Lockbox request separated by ','. ,
Required: False ,
}
string ,
resourceType:
{
Description: The resource type of the requested resources. ,
Required: False ,
}
string ,
supportRequest:
{
Description: The id of the support request associated. ,
Required: False ,
}
string ,
supportCaseUrl:
{
Description: The url of the support case. ,
Required: False ,
}
string ,
workitemsource:
{
Description: The support case system that was used to initiate the request. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
accessLevel:
{
Description: Access level for requested resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Requests_UpdateStatus (new)
Description :  Update Customer Lockbox request approval status API
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomerLockbox/requests/{requestId}/updateApproval
{
approval:
{
Description: The approval object to update request status. ,
Required: True ,
}
{
status:
{
Description: Approval decision to the Lockbox request. ,
Enum:
{
Approve: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason of the decision ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
requestId:
{
Description: The Lockbox request ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Approval decision to the Lockbox request. ,
Enum:
{
Approve: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason of the decision ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Requests_List (new)
Description :  Lists all of the Lockbox requests in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomerLockbox/requests
{
$filter:
{
Description: The $filter OData query parameter. Only filter by request status is supported, e.g $filter=properties/status eq 'Pending' ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Lockbox requests. Populated by a 'List' operation. ,
Required: False ,
}
[
{
id:
{
Description: The Arm resource id of the Lockbox request. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Lockbox request. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Lockbox request. ,
Required: False ,
}
string ,
properties:
{
Description: The properties that are associated with a lockbox request. ,
Required: False ,
}
{
requestId:
{
Description: The Lockbox request ID. ,
Required: False ,
}
string ,
justification:
{
Description: The justification of the requestor. ,
Required: False ,
}
string ,
status:
{
Description: The status of the request. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: The creation time of the request. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: The expiration time of the request. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the request in hours. ,
Required: False ,
}
string ,
resourceIds:
{
Description: A list of resource IDs associated with the Lockbox request separated by ','. ,
Required: False ,
}
string ,
resourceType:
{
Description: The resource type of the requested resources. ,
Required: False ,
}
string ,
supportRequest:
{
Description: The id of the support request associated. ,
Required: False ,
}
string ,
supportCaseUrl:
{
Description: The url of the support case. ,
Required: False ,
}
string ,
workitemsource:
{
Description: The support case system that was used to initiate the request. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
accessLevel:
{
Description: Access level for requested resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Operations_List (removed)
Description :  Lists all the available REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CustomerLockbox/operations
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Customer Lockbox operations supported by the Microsoft.StreamAnalytics resource provider. ,
Required: False ,
}
[
{
name:
{
Description: Gets or sets action name ,
Required: False ,
}
string ,
isDataAction:
{
Description: Gets or sets a value indicating whether it is a data plane action ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this particular operation / action. ,
Required: False ,
}
{
provider:
{
Description: The localized friendly form of the resource provider name. ,
Required: False ,
}
string ,
resource:
{
Description: The localized friendly form of the resource type related to this action/operation. ,
Required: False ,
}
string ,
operation:
{
Description: The localized friendly name for the operation. ,
Required: False ,
}
string ,
description:
{
Description: The localized friendly description for the operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Gets or sets properties ,
Required: False ,
}
string ,
origin:
{
Description: Gets or sets origin ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Get_TenantOptedIn (removed)
Description :  Get Customer Lockbox request
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.CustomerLockbox/tenantOptedIn/{tenantId}
{
tenantId:
{
Description: The Azure tenant ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isOptedIn:
{
Description: True if tenant is opted in, false otherwise ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Post_EnableLockbox (removed)
Description :  Enable Tenant for Lockbox
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CustomerLockbox/enableLockbox
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Post_DisableLockbox (removed)
Description :  Disable Tenant for Lockbox
Reference :  Link ¶

⚼ Request

POST:  /providers/Microsoft.CustomerLockbox/disableLockbox
{
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Requests_Get (removed)
Description :  Get Customer Lockbox request
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomerLockbox/requests/{requestId}
{
requestId:
{
Description: The Lockbox request ID. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The Arm resource id of the Lockbox request. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Lockbox request. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Lockbox request. ,
Required: False ,
}
string ,
properties:
{
Description: The properties that are associated with a lockbox request. ,
Required: False ,
}
{
requestId:
{
Description: The Lockbox request ID. ,
Required: False ,
}
string ,
justification:
{
Description: The justification of the requestor. ,
Required: False ,
}
string ,
status:
{
Description: The status of the request. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: The creation time of the request. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: The expiration time of the request. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the request in hours. ,
Required: False ,
}
string ,
resourceIds:
{
Description: A list of resource IDs associated with the Lockbox request separated by ','. ,
Required: False ,
}
string ,
resourceType:
{
Description: The resource type of the requested resources. ,
Required: False ,
}
string ,
supportRequest:
{
Description: The id of the support request associated. ,
Required: False ,
}
string ,
supportCaseUrl:
{
Description: The url of the support case. ,
Required: False ,
}
string ,
workitemsource:
{
Description: The support case system that was used to initiate the request. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
accessLevel:
{
Description: Access level for requested resource ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Requests_UpdateStatus (removed)
Description :  Update Customer Lockbox request approval status API
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomerLockbox/requests/{requestId}/updateApproval
{
approval:
{
Description: The approval object to update request status. ,
Required: True ,
}
{
status:
{
Description: Approval decision to the Lockbox request. ,
Enum:
{
Approve: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason of the decision ,
Required: False ,
}
string ,
}
,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
requestId:
{
Description: The Lockbox request ID. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to be used with the HTTP request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
status:
{
Description: Approval decision to the Lockbox request. ,
Enum:
{
Approve: No description available. ,
Deny: No description available. ,
}
,
Required: False ,
}
enum ,
reason:
{
Description: Reason of the decision ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}
Requests_List (removed)
Description :  Lists all of the Lockbox requests in the given subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.CustomerLockbox/requests
{
$filter:
{
Description: The $filter OData query parameter. Only filter by request status is supported, e.g $filter=properties/status eq 'Pending' ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000) ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of Lockbox requests. Populated by a 'List' operation. ,
Required: False ,
}
[
{
id:
{
Description: The Arm resource id of the Lockbox request. ,
Required: False ,
}
string ,
name:
{
Description: The name of the Lockbox request. ,
Required: False ,
}
string ,
type:
{
Description: The type of the Lockbox request. ,
Required: False ,
}
string ,
properties:
{
Description: The properties that are associated with a lockbox request. ,
Required: False ,
}
{
requestId:
{
Description: The Lockbox request ID. ,
Required: False ,
}
string ,
justification:
{
Description: The justification of the requestor. ,
Required: False ,
}
string ,
status:
{
Description: The status of the request. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
createdDateTime:
{
Description: The creation time of the request. ,
Format: date-time ,
Required: False ,
}
string ,
expirationDateTime:
{
Description: The expiration time of the request. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: The duration of the request in hours. ,
Required: False ,
}
string ,
resourceIds:
{
Description: A list of resource IDs associated with the Lockbox request separated by ','. ,
Required: False ,
}
string ,
resourceType:
{
Description: The resource type of the requested resources. ,
Required: False ,
}
string ,
supportRequest:
{
Description: The id of the support request associated. ,
Required: False ,
}
string ,
supportCaseUrl:
{
Description: The url of the support case. ,
Required: False ,
}
string ,
workitemsource:
{
Description: The support case system that was used to initiate the request. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: False ,
}
string ,
accessLevel:
{
Description: Access level for requested resource ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Detailed information about the error encountered. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
additionalInfo:
{
Description: A list of error details about the error. ,
Required: False ,
}
[
{
type:
{
Description: The type of error info. ,
Required: False ,
}
string ,
info:
{
Description: Additional information about the request that is in error state. ,
Required: False ,
}
{
currentStatus:
{
Description: The current status/state of the request quired. ,
Enum:
{
Initializing: No description available. ,
Pending: No description available. ,
Approving: No description available. ,
Denying: No description available. ,
Approved: No description available. ,
Denied: No description available. ,
Expired: No description available. ,
Revoking: No description available. ,
Revoked: No description available. ,
Error: No description available. ,
Unknown: No description available. ,
Completed: No description available. ,
Completing: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
,
}