Sign Up Settings - Update

Update Sign-Up settings.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/portalsettings/signup?api-version=2019-01-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

api-version
query True
  • string

Version of the API to be used with the client request.

Request Header

Name Required Type Description
If-Match True
  • 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.

Request Body

Name Type Description
properties.enabled
  • boolean

Allow users to sign up on a developer portal.

properties.termsOfService

Terms of service contract properties.

Responses

Name Type Description
204 No Content

Sign-Up settings was updated successfully.

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementPortalSettingsUpdateSignUp

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/portalsettings/signup?api-version=2019-01-01
If-Match: *
{
  "properties": {
    "enabled": true,
    "termsOfService": {
      "enabled": true,
      "text": "Terms of service text.",
      "consentRequired": true
    }
  }
}

Sample Response

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

PortalSignupSettings

Sign-Up settings for a developer portal.

TermsOfServiceProperties

Terms of service contract properties.

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.

PortalSignupSettings

Sign-Up settings for a developer portal.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.enabled
  • boolean

Allow users to sign up on a developer portal.

properties.termsOfService

Terms of service contract properties.

type
  • string

Resource type for API Management resource.

TermsOfServiceProperties

Terms of service contract properties.

Name Type Description
consentRequired
  • boolean

Ask user for consent to the terms of service.

enabled
  • boolean

Display terms of service during a sign-up process.

text
  • string

A terms of service text.