NamedValue interface

Package:

@azure/arm-apimanagement

Interface representing a NamedValue.

Methods

beginCreateOrUpdate(string, string, string, NamedValueCreateContract, NamedValueCreateOrUpdateOptionalParams)	Creates or updates named value.
beginCreateOrUpdateAndWait(string, string, string, NamedValueCreateContract, NamedValueCreateOrUpdateOptionalParams)	Creates or updates named value.
beginRefreshSecret(string, string, string, NamedValueRefreshSecretOptionalParams)	Refresh the secret of the named value specified by its identifier.
beginRefreshSecretAndWait(string, string, string, NamedValueRefreshSecretOptionalParams)	Refresh the secret of the named value specified by its identifier.
beginUpdate(string, string, string, string, NamedValueUpdateParameters, NamedValueUpdateOptionalParams)	Updates the specific named value.
beginUpdateAndWait(string, string, string, string, NamedValueUpdateParameters, NamedValueUpdateOptionalParams)	Updates the specific named value.
delete(string, string, string, string, NamedValueDeleteOptionalParams)	Deletes specific named value from the API Management service instance.
get(string, string, string, NamedValueGetOptionalParams)	Gets the details of the named value specified by its identifier.
getEntityTag(string, string, string, NamedValueGetEntityTagOptionalParams)	Gets the entity state (Etag) version of the named value specified by its identifier.
listByService(string, string, NamedValueListByServiceOptionalParams)	Lists a collection of named values defined within a service instance.
listValue(string, string, string, NamedValueListValueOptionalParams)	Gets the secret of the named value specified by its identifier.

Method Details

beginCreateOrUpdate(string, string, string, NamedValueCreateContract, NamedValueCreateOrUpdateOptionalParams)

Creates or updates named value.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, namedValueId: string, parameters: NamedValueCreateContract, options?: NamedValueCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NamedValueCreateOrUpdateResponse>, NamedValueCreateOrUpdateResponse>>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

namedValueId

string

Identifier of the NamedValue.

parameters

NamedValueCreateContract

Create parameters.

options

NamedValueCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NamedValueCreateOrUpdateResponse>, NamedValueCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, NamedValueCreateContract, NamedValueCreateOrUpdateOptionalParams)

Creates or updates named value.

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

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

namedValueId

string

Identifier of the NamedValue.

parameters

NamedValueCreateContract

Create parameters.

options

NamedValueCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<NamedValueCreateOrUpdateResponse>

beginRefreshSecret(string, string, string, NamedValueRefreshSecretOptionalParams)

Refresh the secret of the named value specified by its identifier.

function beginRefreshSecret(resourceGroupName: string, serviceName: string, namedValueId: string, options?: NamedValueRefreshSecretOptionalParams): Promise<SimplePollerLike<OperationState<NamedValueRefreshSecretResponse>, NamedValueRefreshSecretResponse>>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

namedValueId

string

Identifier of the NamedValue.

options

NamedValueRefreshSecretOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NamedValueRefreshSecretResponse>, NamedValueRefreshSecretResponse>>

beginRefreshSecretAndWait(string, string, string, NamedValueRefreshSecretOptionalParams)

Refresh the secret of the named value specified by its identifier.

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

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

namedValueId

string

Identifier of the NamedValue.

options

NamedValueRefreshSecretOptionalParams

The options parameters.

Returns

Promise<NamedValueRefreshSecretResponse>

beginUpdate(string, string, string, string, NamedValueUpdateParameters, NamedValueUpdateOptionalParams)

Updates the specific named value.

function beginUpdate(resourceGroupName: string, serviceName: string, namedValueId: string, ifMatch: string, parameters: NamedValueUpdateParameters, options?: NamedValueUpdateOptionalParams): Promise<SimplePollerLike<OperationState<NamedValueUpdateResponse>, NamedValueUpdateResponse>>

Parameters

resourceGroupName

string

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

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.

options

NamedValueUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<NamedValueUpdateResponse>, NamedValueUpdateResponse>>

beginUpdateAndWait(string, string, string, string, NamedValueUpdateParameters, NamedValueUpdateOptionalParams)

Updates the specific named value.

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

Parameters

resourceGroupName

string

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

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.

options

NamedValueUpdateOptionalParams

The options parameters.

Returns

Promise<NamedValueUpdateResponse>

delete(string, string, string, string, NamedValueDeleteOptionalParams)

Deletes specific named value from the API Management service instance.

function delete(resourceGroupName: string, serviceName: string, namedValueId: string, ifMatch: string, options?: NamedValueDeleteOptionalParams): 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.

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.

options

NamedValueDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, NamedValueGetOptionalParams)

Gets the details of the named value specified by its identifier.

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

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

namedValueId

string

Identifier of the NamedValue.

options

NamedValueGetOptionalParams

The options parameters.

Returns

Promise<NamedValueGetResponse>

getEntityTag(string, string, string, NamedValueGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the named value specified by its identifier.

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

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

namedValueId

string

Identifier of the NamedValue.

options

NamedValueGetEntityTagOptionalParams

The options parameters.

Returns

Promise<NamedValueGetEntityTagHeaders>

listByService(string, string, NamedValueListByServiceOptionalParams)

Lists a collection of named values defined within a service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: NamedValueListByServiceOptionalParams): PagedAsyncIterableIterator<NamedValueContract, NamedValueContract[], PageSettings>

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

options

NamedValueListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<NamedValueContract, NamedValueContract[], PageSettings>

listValue(string, string, string, NamedValueListValueOptionalParams)

Gets the secret of the named value specified by its identifier.

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

Parameters

resourceGroupName

string

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

serviceName

string

The name of the API Management service.

namedValueId

string

Identifier of the NamedValue.

options

NamedValueListValueOptionalParams

The options parameters.

Returns

Promise<NamedValueListValueResponse>