SignInSettings | @azure/arm-apimanagement

Interface representing a SignInSettings.

Hierarchy

SignInSettings

Implemented by

SignInSettingsImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/signInSettings.ts:67
Create or Update Sign-In settings.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- parameters: PortalSigninSettings
  
  Create or update parameters.
- Optional options: SignInSettingsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SignInSettingsCreateOrUpdateResponse>

get

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

- Defined in operationsInterfaces/signInSettings.ts:39
Get Sign In Settings for the Portal

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: SignInSettingsGetOptionalParams
  
  The options parameters.
Returns Promise<SignInSettingsGetResponse>

getEntityTag

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

- Defined in operationsInterfaces/signInSettings.ts:28
Gets the entity state (Etag) version of the SignInSettings.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: SignInSettingsGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<SignInSettingsGetEntityTagResponse>

update

update(resourceGroupName: string, serviceName: string, ifMatch: string, parameters: PortalSigninSettings, options?: SignInSettingsUpdateOptionalParams): Promise<void>

- Defined in operationsInterfaces/signInSettings.ts:53
Update Sign-In settings.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: SignInSettingsUpdateOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

parameters: PortalSigninSettings

Optional options: SignInSettingsCreateOrUpdateOptionalParams

Returns Promise<SignInSettingsCreateOrUpdateResponse>

get

Parameters

resourceGroupName: string

serviceName: string

Optional options: SignInSettingsGetOptionalParams

Returns Promise<SignInSettingsGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

Optional options: SignInSettingsGetEntityTagOptionalParams

Returns Promise<SignInSettingsGetEntityTagResponse>

update

Parameters

resourceGroupName: string

serviceName: string

ifMatch: string

parameters: PortalSigninSettings

Optional options: SignInSettingsUpdateOptionalParams

Returns Promise<void>