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

The following fields are returned by SELECT queries:

get

Guest Usages resource successfully retrieved

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	The 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.

list_by_resource_group

List of Guest Usages resources under the resourceGroup successfully retrieved.

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	The 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.

list_by_subscription

List of Guest Usages resources under the subscription successfully retrieved.

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	The 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

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName		Gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
list_by_resource_group	select	subscriptionId, resourceGroupName		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	subscriptionId, resourceGroupName, resourceName		Creates a Guest Usages resource, which is used to linking a subscription to an instance of Azure AD External Identities. Learn more.
update	update	subscriptionId, resourceGroupName, resourceName		Updates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider
delete	delete	subscriptionId, resourceGroupName, resourceName		Deletes a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The initial domain name of the Azure AD B2C tenant.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider

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

list_by_resource_group

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

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

list_by_subscription

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

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

INSERT examples

create

Creates a Guest Usages resource, which is used to linking a subscription to an instance of Azure AD External Identities. Learn more.

INSERT INTO azure.aad_b2c.guest_usages (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: guest_usages
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the guest_usages resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the guest_usages resource.
    - name: resourceName
      value: string
      description: Required parameter for the guest_usages resource.
    - name: location
      value: string
      description: |
        Location of the Guest Usages resource.
    - name: tags
      value: object
      description: |
        Key-value pairs of additional resource provisioning properties.
    - name: properties
      value: object
      description: |
        The Guest Usages Resource Properties

UPDATE examples

update

Updates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider

UPDATE azure.aad_b2c.guest_usages
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider

DELETE FROM azure.aad_b2c.guest_usages
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;