sign_up_settings

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

Overview

Name	sign_up_settings
Type	Resource
Id	azure.api_management.sign_up_settings

Fields

vw_sign_up_settings

Name	Datatype	Description
enabled	text	field from the properties object
resourceGroupName	text	field from the properties object
serviceName	text	field from the properties object
subscriptionId	text	field from the properties object
terms_of_service	text	field from the properties object

sign_up_settings

Name	Datatype	Description
properties	object	Sign-up settings contract properties.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, serviceName, subscriptionId	Get Sign Up Settings for the Portal
create_or_update	INSERT	resourceGroupName, serviceName, subscriptionId	Create or Update Sign-Up settings.
update	UPDATE	If-Match, resourceGroupName, serviceName, subscriptionId	Update Sign-Up settings.

SELECT examples

Get Sign Up Settings for the Portal

vw_sign_up_settings

SELECT
enabled,
resourceGroupName,
serviceName,
subscriptionId,
terms_of_service
FROM azure.api_management.vw_sign_up_settings
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND serviceName = '{{ serviceName }}'
AND subscriptionId = '{{ subscriptionId }}';

sign_up_settings

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: enabled
          value: boolean
        - name: termsOfService
          value:
            - name: text
              value: string
            - name: enabled
              value: boolean
            - name: consentRequired
              value: boolean

UPDATE example

Updates a sign_up_settings resource.

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