NamedValue | @azure/arm-apimanagement

Interface representing a NamedValue.

Hierarchy

NamedValue

Implemented by

NamedValueImpl

Index

Methods

beginCreateOrUpdate

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

- Defined in operationsInterfaces/namedValue.ts:79
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>

- Defined in operationsInterfaces/namedValue.ts:99
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>>

- Defined in operationsInterfaces/namedValue.ts:183
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>

- Defined in operationsInterfaces/namedValue.ts:201
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>>

- Defined in operationsInterfaces/namedValue.ts:116
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>

- Defined in operationsInterfaces/namedValue.ts:139
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>

- Defined in operationsInterfaces/namedValue.ts:156
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>

- Defined in operationsInterfaces/namedValue.ts:65
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>

- Defined in operationsInterfaces/namedValue.ts:52
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>

- Defined in operationsInterfaces/namedValue.ts:40
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>

- Defined in operationsInterfaces/namedValue.ts:170
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

Implemented by

Index

Methods

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

Returns Promise<NamedValueGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: NamedValueListByServiceOptionalParams