users

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

Overview

Name	users
Type	Resource
Id	azure.api_management.users

Fields

vw_users

Name	Datatype	Description
email	text	field from the properties object
first_name	text	field from the properties object
groups	text	field from the properties object
identities	text	field from the properties object
last_name	text	field from the properties object
note	text	field from the properties object
registration_date	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
state	text	field from the properties object
subscriptionId	text	field from the properties object
userId	text	field from the properties object

users

Name	Datatype	Description
properties	object	User profile.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serviceName, subscriptionId, userId	Gets the details of the user specified by its identifier.
list_by_service	SELECT	resourceGroupName, serviceName, subscriptionId	Lists a collection of registered users in the specified service instance.
create_or_update	INSERT	resourceGroupName, serviceName, subscriptionId, userId	Creates or Updates a user.
delete	DELETE	If-Match, resourceGroupName, serviceName, subscriptionId, userId	Deletes specific user.
update	UPDATE	If-Match, resourceGroupName, serviceName, subscriptionId, userId	Updates the details of the user specified by its identifier.
generate_sso_url	EXEC	resourceGroupName, serviceName, subscriptionId, userId	Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

SELECT examples

Lists a collection of registered users in the specified service instance.

vw_users

SELECT
email,
first_name,
groups,
identities,
last_name,
note,
registration_date,
resourceGroupName,
serviceName,
state,
subscriptionId,
userId
FROM azure.api_management.vw_users
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

users

SELECT
properties
FROM azure.api_management.users
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.api_management.users (
resourceGroupName,
serviceName,
subscriptionId,
userId,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ userId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: email
          value: string
        - name: firstName
          value: string
        - name: lastName
          value: string
        - name: password
          value: string
        - name: appType
          value: string
        - name: confirmation
          value: string
        - name: state
          value: string
        - name: note
          value: string
        - name: identities
          value:
            - - name: provider
                value: string
              - name: id
                value: string

UPDATE example

Updates a users resource.

/*+ update */
UPDATE azure.api_management.users
SET 
properties = '{{ properties }}'
WHERE 
If-Match = '{{ If-Match }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND userId = '{{ userId }}';

DELETE example

Deletes the specified users resource.

/*+ delete */
DELETE FROM azure.api_management.users
WHERE If-Match = '{{ If-Match }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND userId = '{{ userId }}';