custom_entity_store_assignments

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

Overview

Name	custom_entity_store_assignments
Type	Resource
Id	azure.security.custom_entity_store_assignments

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	describes custom entity store assignment properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_resource_group

OK - Returns a collection of custom entity store assignments

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	describes custom entity store assignment properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list_by_subscription

OK - Returns a collection of custom entity store assignments

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
properties	object	describes custom entity store assignment properties.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, customEntityStoreAssignmentName	api-version	Gets a single custom entity store assignment by name for the provided subscription and resource group.
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version	List custom entity store assignments by a provided subscription and resource group
list_by_subscription	select	subscriptionId	api-version	List custom entity store assignments by provided subscription
create	insert	subscriptionId, resourceGroupName, customEntityStoreAssignmentName	api-version	Creates a custom entity store assignment for the provided subscription, if not already exists.
delete	delete	subscriptionId, resourceGroupName, customEntityStoreAssignmentName	api-version	Delete a custom entity store assignment by name for a provided 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.

Name	Datatype	Description
customEntityStoreAssignmentName	string	Name of the custom entity store assignment. Generated name is GUID.
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
subscriptionId	string	Azure subscription ID
api-version	string	API version for the operation

SELECT examples

get

Gets a single custom entity store assignment by name for the provided subscription and resource group.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.custom_entity_store_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND customEntityStoreAssignmentName = '{{ customEntityStoreAssignmentName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

List custom entity store assignments by a provided subscription and resource group

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.custom_entity_store_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_subscription

List custom entity store assignments by provided subscription

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.custom_entity_store_assignments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
;

INSERT examples

create

Creates a custom entity store assignment for the provided subscription, if not already exists.

INSERT INTO azure.security.custom_entity_store_assignments (
data__properties,
subscriptionId,
resourceGroupName,
customEntityStoreAssignmentName,
api-version
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ customEntityStoreAssignmentName }}',
'{{ api-version }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: custom_entity_store_assignments
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the custom_entity_store_assignments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the custom_entity_store_assignments resource.
    - name: customEntityStoreAssignmentName
      value: string
      description: Required parameter for the custom_entity_store_assignments resource.
    - name: properties
      value: object
      description: |
        describes properties of custom entity store assignment request
    - name: api-version
      value: string
      description: API version for the operation

DELETE examples

delete

Delete a custom entity store assignment by name for a provided subscription

DELETE FROM azure.security.custom_entity_store_assignments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND customEntityStoreAssignmentName = '{{ customEntityStoreAssignmentName }}' --required
AND api-version = '{{ api-version }}'
;