SignUpSettings | @azure/arm-apimanagement

Interface representing a SignUpSettings.

Hierarchy

SignUpSettings

Implemented by

SignUpSettingsImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/signUpSettings.ts:67
Create or Update Sign-Up settings.

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

get

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

- Defined in operationsInterfaces/signUpSettings.ts:39
Get Sign Up Settings for the Portal

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

getEntityTag

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

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

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

update

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

- Defined in operationsInterfaces/signUpSettings.ts:53
Update Sign-Up 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: PortalSignupSettings
  
  Update Sign-Up settings.
- Optional options: SignUpSettingsUpdateOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

parameters: PortalSignupSettings

Optional options: SignUpSettingsCreateOrUpdateOptionalParams

Returns Promise<SignUpSettingsCreateOrUpdateResponse>

get

Parameters

resourceGroupName: string

serviceName: string

Optional options: SignUpSettingsGetOptionalParams

Returns Promise<SignUpSettingsGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

Optional options: SignUpSettingsGetEntityTagOptionalParams

Returns Promise<SignUpSettingsGetEntityTagResponse>

update

Parameters

resourceGroupName: string

serviceName: string

ifMatch: string

parameters: PortalSignupSettings

Optional options: SignUpSettingsUpdateOptionalParams

Returns Promise<void>