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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
enabled	boolean	Allow users to sign up on a developer portal.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
termsOfService	object	Terms of service contract properties.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, subscription_id		Get Sign Up Settings for the Portal.
create_or_update	insert	resource_group_name, service_name, subscription_id		Create or Update Sign-Up settings.
update	update	resource_group_name, service_name, subscription_id		Update Sign-Up settings.
create_or_update	replace	resource_group_name, service_name, subscription_id		Create or Update Sign-Up settings.
get_entity_tag	exec	resource_group_name, service_name, subscription_id		Gets the entity state (Etag) version of the SignUpSettings.

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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string

SELECT examples

get

Get Sign Up Settings for the Portal.

SELECT
id,
name,
enabled,
systemData,
termsOfService,
type
FROM azure.api_management.sign_up_settings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or Update Sign-Up settings.

INSERT INTO azure.api_management.sign_up_settings (
properties,
resource_group_name,
service_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: sign_up_settings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sign_up_settings resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the sign_up_settings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sign_up_settings resource.
  - name: properties
    description: |
      Sign-up settings contract properties.
    value:
      enabled: {{ enabled }}
      termsOfService:
        text: "{{ text }}"
        enabled: {{ enabled }}
        consentRequired: {{ consentRequired }}

UPDATE examples

update

Update Sign-Up settings.

UPDATE azure.api_management.sign_up_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required;

REPLACE examples

create_or_update

Create or Update Sign-Up settings.

REPLACE azure.api_management.sign_up_settings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the SignUpSettings.

EXEC azure.api_management.sign_up_settings.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;