DelegationSettings | @azure/arm-apimanagement

Interface representing a DelegationSettings.

Hierarchy

DelegationSettings

Implemented by

DelegationSettingsImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/delegationSettings.ts:69
Create or Update Delegation settings.

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

get

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

- Defined in operationsInterfaces/delegationSettings.ts:41
Get Delegation Settings for the Portal.

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

getEntityTag

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

- Defined in operationsInterfaces/delegationSettings.ts:30
Gets the entity state (Etag) version of the DelegationSettings.

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

listSecrets

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

- Defined in operationsInterfaces/delegationSettings.ts:81
Gets the secret validation key of the DelegationSettings.

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

update

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

- Defined in operationsInterfaces/delegationSettings.ts:55
Update Delegation 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: PortalDelegationSettings
  
  Update Delegation settings.
- Optional options: DelegationSettingsUpdateOptionalParams
  
  The options parameters.
Returns Promise<void>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

parameters: PortalDelegationSettings

Optional options: DelegationSettingsCreateOrUpdateOptionalParams

Returns Promise<DelegationSettingsCreateOrUpdateResponse>

get

Parameters

resourceGroupName: string

serviceName: string

Optional options: DelegationSettingsGetOptionalParams

Returns Promise<DelegationSettingsGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

Optional options: DelegationSettingsGetEntityTagOptionalParams

Returns Promise<DelegationSettingsGetEntityTagResponse>

listSecrets

Parameters

resourceGroupName: string

serviceName: string

Optional options: DelegationSettingsListSecretsOptionalParams

Returns Promise<DelegationSettingsListSecretsResponse>

update

Parameters

resourceGroupName: string

serviceName: string

ifMatch: string

parameters: PortalDelegationSettings

Optional options: DelegationSettingsUpdateOptionalParams

Returns Promise<void>