NamedValue interface

Pacote:

@azure/arm-apimanagement

Interface que representa um NamedValue.

Métodos

beginCreateOrUpdate(string, string, string, NamedValueCreateContract, NamedValueCreateOrUpdateOptionalParams)	Cria ou atualiza o valor nomeado.
beginCreateOrUpdateAndWait(string, string, string, NamedValueCreateContract, NamedValueCreateOrUpdateOptionalParams)	Cria ou atualiza o valor nomeado.
beginRefreshSecret(string, string, string, NamedValueRefreshSecretOptionalParams)	Atualize o segredo do valor nomeado especificado por seu identificador.
beginRefreshSecretAndWait(string, string, string, NamedValueRefreshSecretOptionalParams)	Atualize o segredo do valor nomeado especificado por seu identificador.
beginUpdate(string, string, string, string, NamedValueUpdateParameters, NamedValueUpdateOptionalParams)	Atualizações o valor nomeado específico.
beginUpdateAndWait(string, string, string, string, NamedValueUpdateParameters, NamedValueUpdateOptionalParams)	Atualizações o valor nomeado específico.
delete(string, string, string, string, NamedValueDeleteOptionalParams)	Exclui o valor nomeado específico da instância do serviço de Gerenciamento de API.
get(string, string, string, NamedValueGetOptionalParams)	Obtém os detalhes do valor nomeado especificado por seu identificador.
getEntityTag(string, string, string, NamedValueGetEntityTagOptionalParams)	Obtém a versão do estado da entidade (Etag) do valor nomeado especificado por seu identificador.
listByService(string, string, NamedValueListByServiceOptionalParams)	Lista uma coleção de valores nomeados definidos em uma instância de serviço.
listValue(string, string, string, NamedValueListValueOptionalParams)	Obtém o segredo do valor nomeado especificado por seu identificador.

Detalhes do método

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

Cria ou atualiza o valor nomeado.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

parameters

NamedValueCreateContract

Criar parâmetros.

options

NamedValueCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

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

Cria ou atualiza o valor nomeado.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

parameters

NamedValueCreateContract

Criar parâmetros.

options

NamedValueCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<NamedValueCreateOrUpdateResponse>

beginRefreshSecret(string, string, string, NamedValueRefreshSecretOptionalParams)

Atualize o segredo do valor nomeado especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

options

NamedValueRefreshSecretOptionalParams

Os parâmetros de opções.

Retornos

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

beginRefreshSecretAndWait(string, string, string, NamedValueRefreshSecretOptionalParams)

Atualize o segredo do valor nomeado especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

options

NamedValueRefreshSecretOptionalParams

Os parâmetros de opções.

Retornos

Promise<NamedValueRefreshSecretResponse>

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

Atualizações o valor nomeado específico.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

parameters

NamedValueUpdateParameters

Atualizar parâmetros.

options

NamedValueUpdateOptionalParams

Os parâmetros de opções.

Retornos

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

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

Atualizações o valor nomeado específico.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

parameters

NamedValueUpdateParameters

Atualizar parâmetros.

options

NamedValueUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<NamedValueUpdateResponse>

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

Exclui o valor nomeado específico da instância do serviço de Gerenciamento de API.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

ifMatch

string

ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

options

NamedValueDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

get(string, string, string, NamedValueGetOptionalParams)

Obtém os detalhes do valor nomeado especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

options

NamedValueGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<NamedValueGetResponse>

getEntityTag(string, string, string, NamedValueGetEntityTagOptionalParams)

Obtém a versão do estado da entidade (Etag) do valor nomeado especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

options

NamedValueGetEntityTagOptionalParams

Os parâmetros de opções.

Retornos

Promise<NamedValueGetEntityTagHeaders>

listByService(string, string, NamedValueListByServiceOptionalParams)

Lista uma coleção de valores nomeados definidos em uma instância de serviço.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

options

NamedValueListByServiceOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<NamedValueContract, NamedValueContract[], PageSettings>

listValue(string, string, string, NamedValueListValueOptionalParams)

Obtém o segredo do valor nomeado especificado por seu identificador.

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

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

serviceName

string

O nome do serviço Gerenciamento de API.

namedValueId

string

Identificador do NamedValue.

options

NamedValueListValueOptionalParams

Os parâmetros de opções.

Retornos

Promise<NamedValueListValueResponse>