Share via

SignUpSettings interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a SignUpSettings.

Methods

createOrUpdate(string, string, PortalSignupSettings, SignUpSettingsCreateOrUpdateOptionalParams)

Create or Update Sign-Up settings.
get(string, string, SignUpSettingsGetOptionalParams)

Get Sign Up Settings for the Portal
getEntityTag(string, string, SignUpSettingsGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the SignUpSettings.
update(string, string, string, PortalSignupSettings, SignUpSettingsUpdateOptionalParams)

Update Sign-Up settings.

Method Details

createOrUpdate(string, string, PortalSignupSettings, SignUpSettingsCreateOrUpdateOptionalParams)

Create or Update Sign-Up settings.

function createOrUpdate(resourceGroupName: string, serviceName: string, parameters: PortalSignupSettings, options?: SignUpSettingsCreateOrUpdateOptionalParams): Promise<PortalSignupSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

parameters
PortalSignupSettings

Create or update parameters.

options
SignUpSettingsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PortalSignupSettings>

get(string, string, SignUpSettingsGetOptionalParams)

Get Sign Up Settings for the Portal

function get(resourceGroupName: string, serviceName: string, options?: SignUpSettingsGetOptionalParams): Promise<SignUpSettingsGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
SignUpSettingsGetOptionalParams

The options parameters.

Returns

Promise<SignUpSettingsGetResponse>

getEntityTag(string, string, SignUpSettingsGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, options?: SignUpSettingsGetEntityTagOptionalParams): Promise<SignUpSettingsGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
SignUpSettingsGetEntityTagOptionalParams

The options parameters.

Returns

Promise<SignUpSettingsGetEntityTagHeaders>

update(string, string, string, PortalSignupSettings, SignUpSettingsUpdateOptionalParams)

Update Sign-Up settings.

function update(resourceGroupName: string, serviceName: string, ifMatch: string, parameters: PortalSignupSettings, options?: SignUpSettingsUpdateOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

ifMatch

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.

parameters
PortalSignupSettings

Update Sign-Up settings.

options
SignUpSettingsUpdateOptionalParams

The options parameters.

Returns

Promise<void>