guest_usages

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

Overview

Name	guest_usages
Type	Resource
Id	azure.aad_b2c.guest_usages

Fields

vw_guest_usages

Name	Datatype	Description
id	text	An identifier that represents the Guest Usages resource.
name	text	The name of the Guest Usages resource.
location	text	Location of the Guest Usages resource.
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Key-value pairs of additional resource provisioning properties.
tenant_id	text	field from the properties object
type	text	The type of the Guest Usages resource.

guest_usages

Name	Datatype	Description
id	string	An identifier that represents the Guest Usages resource.
name	string	The name of the Guest Usages resource.
location	string	Location of the Guest Usages resource.
properties	object	Guest Usages Resource Properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Key-value pairs of additional resource provisioning properties.
type	string	The type of the Guest Usages resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, resourceName, subscriptionId	Gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets Guest Usages resources under a resource group for the Microsoft.AzureActiveDirectory resource provider
list_by_subscription	SELECT	subscriptionId	Gets Guest Usages resources under a subscription for the Microsoft.AzureActiveDirectory resource provider
create	INSERT	resourceGroupName, resourceName, subscriptionId	Creates a Guest Usages resource, which is used to linking a subscription to an instance of Azure AD External Identities. Learn more.
delete	DELETE	resourceGroupName, resourceName, subscriptionId	Deletes a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
update	UPDATE	resourceGroupName, resourceName, subscriptionId	Updates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider

SELECT examples

Gets Guest Usages resources under a subscription for the Microsoft.AzureActiveDirectory resource provider

vw_guest_usages

SELECT
id,
name,
location,
resourceGroupName,
resourceName,
subscriptionId,
system_data,
tags,
tenant_id,
type
FROM azure.aad_b2c.vw_guest_usages
WHERE subscriptionId = '{{ subscriptionId }}';

guest_usages

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.aad_b2c.guest_usages
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new guest_usages resource.

All Properties

/*+ create */
INSERT INTO azure.aad_b2c.guest_usages (
resourceGroupName,
resourceName,
subscriptionId,
location,
tags,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ location }}',
'{{ tags }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: location
      value: string
    - name: tags
      value: object
    - name: properties
      value:
        - name: tenantId
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a guest_usages resource.

/*+ update */
UPDATE azure.aad_b2c.guest_usages
SET 
tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified guest_usages resource.

/*+ delete */
DELETE FROM azure.aad_b2c.guest_usages
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';