NamedValueImpl | @azure/arm-apimanagement

Class containing NamedValue operations.

Hierarchy

NamedValueImpl

Implements

NamedValue

Index

Constructors

constructor

Methods

Constructors

constructor

new NamedValueImpl(client: ApiManagementClientContext): NamedValueImpl

- Defined in operations/namedValue.ts:43
Initialize a new instance of the class NamedValue class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns NamedValueImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, namedValueId: string, parameters: NamedValueCreateContract, options?: NamedValueCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<NamedValueCreateOrUpdateResponse>, NamedValueCreateOrUpdateResponse>>

Implementation of NamedValue.beginCreateOrUpdate
- Defined in operations/namedValue.ts:187
Creates or updates named value.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- parameters: NamedValueCreateContract
  
  Create parameters.
- Optional options: NamedValueCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<NamedValueCreateOrUpdateResponse>, NamedValueCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, namedValueId: string, parameters: NamedValueCreateContract, options?: NamedValueCreateOrUpdateOptionalParams): Promise<NamedValueCreateOrUpdateResponse>

Implementation of NamedValue.beginCreateOrUpdateAndWait
- Defined in operations/namedValue.ts:258
Creates or updates named value.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- parameters: NamedValueCreateContract
  
  Create parameters.
- Optional options: NamedValueCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<NamedValueCreateOrUpdateResponse>

beginRefreshSecret

beginRefreshSecret(resourceGroupName: string, serviceName: string, namedValueId: string, options?: NamedValueRefreshSecretOptionalParams): Promise<PollerLike<PollOperationState<NamedValueRefreshSecretResponse>, NamedValueRefreshSecretResponse>>

Implementation of NamedValue.beginRefreshSecret
- Defined in operations/namedValue.ts:433
Refresh the secret of the named value specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- Optional options: NamedValueRefreshSecretOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<NamedValueRefreshSecretResponse>, NamedValueRefreshSecretResponse>>

beginRefreshSecretAndWait

beginRefreshSecretAndWait(resourceGroupName: string, serviceName: string, namedValueId: string, options?: NamedValueRefreshSecretOptionalParams): Promise<NamedValueRefreshSecretResponse>

Implementation of NamedValue.beginRefreshSecretAndWait
- Defined in operations/namedValue.ts:502
Refresh the secret of the named value specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- Optional options: NamedValueRefreshSecretOptionalParams
  
  The options parameters.
Returns Promise<NamedValueRefreshSecretResponse>

beginUpdate

beginUpdate(resourceGroupName: string, serviceName: string, namedValueId: string, ifMatch: string, parameters: NamedValueUpdateParameters, options?: NamedValueUpdateOptionalParams): Promise<PollerLike<PollOperationState<NamedValueUpdateResponse>, NamedValueUpdateResponse>>

Implementation of NamedValue.beginUpdate
- Defined in operations/namedValue.ts:285
Updates the specific named value.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- 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: NamedValueUpdateParameters
  
  Update parameters.
- Optional options: NamedValueUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<NamedValueUpdateResponse>, NamedValueUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, serviceName: string, namedValueId: string, ifMatch: string, parameters: NamedValueUpdateParameters, options?: NamedValueUpdateOptionalParams): Promise<NamedValueUpdateResponse>

Implementation of NamedValue.beginUpdateAndWait
- Defined in operations/namedValue.ts:366
Updates the specific named value.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- 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: NamedValueUpdateParameters
  
  Update parameters.
- Optional options: NamedValueUpdateOptionalParams
  
  The options parameters.
Returns Promise<NamedValueUpdateResponse>

delete

delete(resourceGroupName: string, serviceName: string, namedValueId: string, ifMatch: string, options?: NamedValueDeleteOptionalParams): Promise<void>

Implementation of NamedValue.delete
- Defined in operations/namedValue.ts:394
Deletes specific named value from the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- 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.
- Optional options: NamedValueDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, namedValueId: string, options?: NamedValueGetOptionalParams): Promise<NamedValueGetResponse>

Implementation of NamedValue.get
- Defined in operations/namedValue.ts:167
Gets the details of the named value specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- Optional options: NamedValueGetOptionalParams
  
  The options parameters.
Returns Promise<NamedValueGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, namedValueId: string, options?: NamedValueGetEntityTagOptionalParams): Promise<NamedValueGetEntityTagResponse>

Implementation of NamedValue.getEntityTag
- Defined in operations/namedValue.ts:148
Gets the entity state (Etag) version of the named value specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- Optional options: NamedValueGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<NamedValueGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: NamedValueListByServiceOptionalParams): PagedAsyncIterableIterator<NamedValueContract>

Implementation of NamedValue.listByService
- Defined in operations/namedValue.ts:59
Lists a collection of named values defined within a service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: NamedValueListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<NamedValueContract>

listValue

listValue(resourceGroupName: string, serviceName: string, namedValueId: string, options?: NamedValueListValueOptionalParams): Promise<NamedValueListValueResponse>

Implementation of NamedValue.listValue
- Defined in operations/namedValue.ts:414
Gets the secret of the named value specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- namedValueId: string
  
  Identifier of the NamedValue.
- Optional options: NamedValueListValueOptionalParams
  
  The options parameters.
Returns Promise<NamedValueListValueResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns NamedValueImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

namedValueId: string

parameters: NamedValueCreateContract

Optional options: NamedValueCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<NamedValueCreateOrUpdateResponse>, NamedValueCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

namedValueId: string

parameters: NamedValueCreateContract

Optional options: NamedValueCreateOrUpdateOptionalParams

Returns Promise<NamedValueCreateOrUpdateResponse>

beginRefreshSecret

Parameters

resourceGroupName: string

serviceName: string

namedValueId: string

Optional options: NamedValueRefreshSecretOptionalParams

Returns Promise<PollerLike<PollOperationState<NamedValueRefreshSecretResponse>, NamedValueRefreshSecretResponse>>

beginRefreshSecretAndWait

Parameters

resourceGroupName: string

serviceName: string

namedValueId: string

Optional options: NamedValueRefreshSecretOptionalParams

Returns Promise<NamedValueRefreshSecretResponse>

beginUpdate

Parameters

resourceGroupName: string

serviceName: string

namedValueId: string

ifMatch: string

parameters: NamedValueUpdateParameters

Optional options: NamedValueUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<NamedValueUpdateResponse>, NamedValueUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

namedValueId: string

ifMatch: string

parameters: NamedValueUpdateParameters

Optional options: NamedValueUpdateOptionalParams

Returns Promise<NamedValueUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

namedValueId: string

ifMatch: string

Optional options: NamedValueDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

namedValueId: string

Optional options: NamedValueGetOptionalParams

Returns Promise<NamedValueGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

namedValueId: string

Optional options: NamedValueGetEntityTagOptionalParams