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

The following fields are returned by SELECT queries:

get

Sign-Up settings.

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

Methods

The following methods are available for this resource:

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

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
If-Match	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
serviceName	string	The name of the API Management service.
subscriptionId	string	The ID of the target subscription.
If-Match	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

SELECT examples

get

Get Sign Up Settings for the Portal

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

INSERT examples

create_or_update

Create or Update Sign-Up settings.

INSERT INTO azure.api_management.sign_up_settings (
data__properties,
resourceGroupName,
serviceName,
subscriptionId,
If-Match
)
SELECT 
'{{ properties }}',
'{{ resourceGroupName }}',
'{{ serviceName }}',
'{{ subscriptionId }}',
'{{ If-Match }}'
RETURNING
properties
;

Manifest

# Description fields are for documentation purposes
- name: sign_up_settings
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the sign_up_settings resource.
    - name: serviceName
      value: string
      description: Required parameter for the sign_up_settings resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the sign_up_settings resource.
    - name: properties
      value: object
      description: |
        Sign-up settings contract properties.
    - name: If-Match
      value: string
      description: ETag of the Entity. Not required when creating an entity, but required when updating an entity.

UPDATE examples

update

Update Sign-Up settings.

UPDATE azure.api_management.sign_up_settings
SET 
data__properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND serviceName = '{{ serviceName }}' --required
AND If-Match = '{{ If-Match }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required;