DelegationSettings interface

Package:

@azure/arm-apimanagement

Interface representing a DelegationSettings.

Methods

createOrUpdate(string, string, PortalDelegationSettings, DelegationSettingsCreateOrUpdateOptionalParams)	Create or Update Delegation settings.
get(string, string, DelegationSettingsGetOptionalParams)	Get Delegation Settings for the Portal.
getEntityTag(string, string, DelegationSettingsGetEntityTagOptionalParams)	Gets the entity state (Etag) version of the DelegationSettings.
listSecrets(string, string, DelegationSettingsListSecretsOptionalParams)	Gets the secret validation key of the DelegationSettings.
update(string, string, string, PortalDelegationSettings, DelegationSettingsUpdateOptionalParams)	Update Delegation settings.

Method Details

createOrUpdate(string, string, PortalDelegationSettings, DelegationSettingsCreateOrUpdateOptionalParams)

Create or Update Delegation settings.

function createOrUpdate(resourceGroupName: string, serviceName: string, parameters: PortalDelegationSettings, options?: DelegationSettingsCreateOrUpdateOptionalParams): Promise<PortalDelegationSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

parameters

PortalDelegationSettings

Create or update parameters.

options

DelegationSettingsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<PortalDelegationSettings>

get(string, string, DelegationSettingsGetOptionalParams)

Get Delegation Settings for the Portal.

function get(resourceGroupName: string, serviceName: string, options?: DelegationSettingsGetOptionalParams): Promise<DelegationSettingsGetResponse>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options

DelegationSettingsGetOptionalParams

The options parameters.

Returns

Promise<DelegationSettingsGetResponse>

getEntityTag(string, string, DelegationSettingsGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, options?: DelegationSettingsGetEntityTagOptionalParams): Promise<DelegationSettingsGetEntityTagHeaders>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options

DelegationSettingsGetEntityTagOptionalParams

The options parameters.

Returns

Promise<DelegationSettingsGetEntityTagHeaders>

listSecrets(string, string, DelegationSettingsListSecretsOptionalParams)

Gets the secret validation key of the DelegationSettings.

function listSecrets(resourceGroupName: string, serviceName: string, options?: DelegationSettingsListSecretsOptionalParams): Promise<PortalSettingValidationKeyContract>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options

DelegationSettingsListSecretsOptionalParams

The options parameters.

Returns

Promise<PortalSettingValidationKeyContract>

update(string, string, string, PortalDelegationSettings, DelegationSettingsUpdateOptionalParams)

Update Delegation settings.

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

PortalDelegationSettings

Update Delegation settings.

options

DelegationSettingsUpdateOptionalParams

The options parameters.

Returns

Promise<void>