Share via

SignInSettings interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a SignInSettings.

Methods

createOrUpdate(string, string, PortalSigninSettings, SignInSettingsCreateOrUpdateOptionalParams)

Create or Update Sign-In settings.
get(string, string, SignInSettingsGetOptionalParams)

Get Sign In Settings for the Portal
getEntityTag(string, string, SignInSettingsGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the SignInSettings.
update(string, string, string, PortalSigninSettings, SignInSettingsUpdateOptionalParams)

Update Sign-In settings.

Method Details

createOrUpdate(string, string, PortalSigninSettings, SignInSettingsCreateOrUpdateOptionalParams)

Create or Update Sign-In settings.

function createOrUpdate(resourceGroupName: string, serviceName: string, parameters: PortalSigninSettings, options?: SignInSettingsCreateOrUpdateOptionalParams): Promise<PortalSigninSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

parameters
PortalSigninSettings

Create or update parameters.

options
SignInSettingsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PortalSigninSettings>

get(string, string, SignInSettingsGetOptionalParams)

Get Sign In Settings for the Portal

function get(resourceGroupName: string, serviceName: string, options?: SignInSettingsGetOptionalParams): Promise<SignInSettingsGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options
SignInSettingsGetOptionalParams

The options parameters.

Returns

Promise<SignInSettingsGetResponse>

getEntityTag(string, string, SignInSettingsGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, options?: SignInSettingsGetEntityTagOptionalParams): Promise<SignInSettingsGetEntityTagHeaders>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options
SignInSettingsGetEntityTagOptionalParams

The options parameters.

Returns

Promise<SignInSettingsGetEntityTagHeaders>

update(string, string, string, PortalSigninSettings, SignInSettingsUpdateOptionalParams)

Update Sign-In settings.

function update(resourceGroupName: string, serviceName: string, ifMatch: string, parameters: PortalSigninSettings, options?: SignInSettingsUpdateOptionalParams): 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
PortalSigninSettings

Update Sign-In settings.

options
SignInSettingsUpdateOptionalParams

The options parameters.

Returns

Promise<void>