scope_access_review_history_definition_instances
Creates, updates, deletes, gets or lists a scope_access_review_history_definition_instances resource.
Overview
| Name | scope_access_review_history_definition_instances |
| Type | Resource |
| Id | azure.authorization.scope_access_review_history_definition_instances |
Fields
The following fields are returned by SELECT queries:
- list
Describe the result of a successful operation.
| Name | Datatype | Description |
|---|---|---|
id | string | The access review history definition instance id. |
name | string | The access review history definition instance unique id. |
properties | object | Access Review History Definition Instance properties. |
type | string | The resource type. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | scope, historyDefinitionId | Get access review history definition instances by definition Id | |
generate_download_uri | exec | scope, historyDefinitionId, instanceId | Generates a uri which can be used to retrieve review history data. This URI has a TTL of 1 day and can be retrieved by fetching the accessReviewHistoryDefinition object. |
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 |
|---|---|---|
historyDefinitionId | string | The id of the access review history definition. |
instanceId | string | The id of the access review history definition instance to generate a URI for. |
scope | string | The scope of the operation or resource. Valid scopes are: subscription (format: '/subscriptions/{subscriptionId}'), resource group (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}', or resource (format: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/[{parentResourcePath}/]{resourceType}/{resourceName}' |
SELECT examples
- list
Get access review history definition instances by definition Id
SELECT
id,
name,
properties,
type
FROM azure.authorization.scope_access_review_history_definition_instances
WHERE scope = '{{ scope }}' -- required
AND historyDefinitionId = '{{ historyDefinitionId }}' -- required
;
Lifecycle Methods
- generate_download_uri
Generates a uri which can be used to retrieve review history data. This URI has a TTL of 1 day and can be retrieved by fetching the accessReviewHistoryDefinition object.
EXEC azure.authorization.scope_access_review_history_definition_instances.generate_download_uri
@scope='{{ scope }}' --required,
@historyDefinitionId='{{ historyDefinitionId }}' --required,
@instanceId='{{ instanceId }}' --required
;