Partilhar via


@azure/app-configuration package

Classes

AppConfigurationClient

Cliente para o serviço de Configuração de Aplicativo do Azure.

Interfaces

AddConfigurationSettingOptions

Opções usadas ao adicionar um ConfigurationSetting.

AddConfigurationSettingResponse

Resposta da adição de um ConfigurationSetting.

AppConfigurationClientOptions

Fornece opções de configuração para AppConfigurationClient.

ConfigurationSettingId

Campos que identificam exclusivamente uma definição de configuração

ConfigurationSettingsFilter

Permite a filtragem de valores-chave. Referência de sintaxe: https://aka.ms/azconfig/docs/restapisnapshots

ConfigurationSnapshot

Os detalhes do instantâneo incluem nome, filtros, expiresOn, sizeInBytes, status, itemCount e muito mais

CreateSnapshotOptions

Opções usadas ao criar um instantâneo.

CreateSnapshotResponse

Resposta da atualização de um instantâneo.

DeleteConfigurationSettingOptions

Opções para excluir um ConfigurationSetting.

DeleteConfigurationSettingResponse

Resposta da exclusão de um ConfigurationSetting.

EtagEntity

Entidade com etag.

FeatureFlagValue

Valor de um sinalizador de recurso

GetConfigurationHeaders

Cabeçalhos de obter um ConfigurationSetting.

GetConfigurationSettingOptions

Opções para obter um ConfigurationSetting.

GetConfigurationSettingResponse

Resposta da recuperação de um ConfigurationSetting.

GetSnapshotOptions

Opções usadas ao obter um instantâneo.

GetSnapshotResponse

Resposta de obter um instantâneo.

HttpOnlyIfChangedField

Opções usadas para fornecer if-none-match para uma solicitação HTTP

HttpOnlyIfUnchangedField

Opções usadas para fornecer if-match para uma solicitação HTTP

HttpResponseField

Informações relacionadas à resposta HTTP - cabeçalhos e corpo bruto.

HttpResponseFields

Campos que são içados a partir do campo _response do objeto Usado em casos em que campos de resposta HTTP individuais são importantes para o usuário usar em casos de uso comum, como manipulação de códigos de status http 204 ou 304.

ListConfigurationSettingPage

Uma página de definições de configuração e a resposta HTTP correspondente

ListConfigurationSettingsForSnapshotOptions

Opções comuns para APIs no estilo 'lista' no AppConfig usadas para especificar curingas, bem como o cabeçalho de data e hora de aceitação.

ListConfigurationSettingsOptions

Opções para listConfigurationSettings que permitem a filtragem com base em chaves, rótulos e outros campos. Também fornece fields que permite escolher seletivamente quais campos são preenchidos no resultado.

ListLabelsOptions

Opções para listLabels

ListLabelsPage

Uma página de definições de configuração e a resposta HTTP correspondente

ListRevisionsOptions

Opções para listRevisions que permitem a filtragem com base em chaves, etiquetas e outros campos. Também fornece fields que permite escolher seletivamente quais campos são preenchidos no resultado.

ListRevisionsPage

Uma página de definições de configuração e a resposta HTTP correspondente

ListSettingsOptions

Opções comuns para APIs no estilo 'lista' no AppConfig usadas para especificar curingas, bem como o cabeçalho de data e hora de aceitação.

ListSnapshots

Opções comuns para APIs no estilo 'lista' no AppConfig usadas para especificar curingas, bem como o cabeçalho de data e hora de aceitação.

ListSnapshotsOptions

Opções para listConfigurationSettings que permitem a filtragem com base em chaves, rótulos e outros campos. Também fornece fields que permite escolher seletivamente quais campos são preenchidos no resultado.

ListSnapshotsPage

Uma página de definições de configuração e a resposta HTTP correspondente

OptionalFields

Usado quando a API oferece suporte a campos de retorno seletivo.

OptionalLabelsFields

Usado quando a API oferece suporte ao retorno seletivo de campos de rótulos.

OptionalSnapshotFields

Usado quando a API oferece suporte a campos de retorno seletivo.

PageSettings

Uma interface que rastreia as configurações para iteração paginada

RetryOptions

Opções que controlam como repetir solicitações com falha.

SecretReferenceValue

Campos necessários para atualizar ou criar uma nova referência secreta.

SetConfigurationSettingOptions

Opções usadas ao salvar um ConfigurationSetting.

SetConfigurationSettingResponse

Resposta da definição de um ConfigurationSetting.

SetReadOnlyOptions

Opções para setReadOnly

SetReadOnlyResponse

Resposta ao definir um valor como somente leitura.

SettingLabel

Detalhes do rótulo, com propriedade name que só pode ser preenchida pelo servidor

SnapshotInfo

Campos que identificam exclusivamente um instantâneo

SnapshotResponse

Resposta da adição de um instantâneo.

SyncTokenHeaderField

Campo de cabeçalho do token de sincronização

UpdateSnapshotOptions

Opções usadas ao atualizar um instantâneo.

UpdateSnapshotResponse

Resposta da atualização de um instantâneo.

Aliases de Tipo

AddConfigurationSettingParam

Parâmetros para adicionar uma nova definição de configuração

ConfigurationSetting

Definição de configuração com metadados extras do servidor, indicando seu etag, se ele é atualmente readOnly e quando foi modificado pela última vez.

ConfigurationSettingParam

Campos necessários para atualizar ou criar uma nova definição de configuração

ConfigurationSettingResponse

Resposta base padrão para obter, excluir ou atualizar uma definição de configuração

ConfigurationSnapshotStatus

Define valores para ConfigurationSnapshotStatus.
KnownConfigurationSnapshotStatus pode ser usado de forma intercambiável com ConfigurationSnapshotStatus, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

provisionamento
pronto
arquivado
falhou

SetConfigurationSettingParam

Parâmetros para criar ou atualizar uma nova definição de configuração

SnapshotComposition

Define valores para SnapshotComposition.
KnownSnapshotComposition pode ser usado de forma intercambiável com SnapshotComposition, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

chave
key_label

Enumerações

KnownConfigurationSnapshotStatus

Os valores conhecidos de ConfigurationSnapshotStatus que o serviço aceita.

KnownSnapshotComposition

Os valores conhecidos de SnapshotComposition que o serviço aceita.

Funções

isFeatureFlag(ConfigurationSetting<string>)

Permite saber se ConfigurationSetting é um sinalizador de recurso.

[Verifica se o tipo de conteúdo é featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

isSecretReference(ConfigurationSetting<string>)

Informa se ConfigurationSetting é uma referência secreta.

[Verifica se o tipo de conteúdo é secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

parseFeatureFlag(ConfigurationSetting<string>)

Toma o ConfigurationSetting como entrada e retorna o ConfigurationSetting analisando a cadeia de caracteres de valor.

parseSecretReference(ConfigurationSetting<string>)

Toma o ConfigurationSetting como entrada e retorna o ConfigurationSetting analisando a cadeia de caracteres de valor.

Detalhes de Função

isFeatureFlag(ConfigurationSetting<string>)

Permite saber se ConfigurationSetting é um sinalizador de recurso.

[Verifica se o tipo de conteúdo é featureFlagContentType "application/vnd.microsoft.appconfig.ff+json;charset=utf-8"]

function isFeatureFlag(setting: ConfigurationSetting<string>): setting

Parâmetros

setting

ConfigurationSetting<string>

Devoluções

setting

isSecretReference(ConfigurationSetting<string>)

Informa se ConfigurationSetting é uma referência secreta.

[Verifica se o tipo de conteúdo é secretReferenceContentType "application/vnd.microsoft.appconfig.keyvaultref+json;charset=utf-8"]

function isSecretReference(setting: ConfigurationSetting<string>): setting

Parâmetros

setting

ConfigurationSetting<string>

Devoluções

setting

parseFeatureFlag(ConfigurationSetting<string>)

Toma o ConfigurationSetting como entrada e retorna o ConfigurationSetting analisando a cadeia de caracteres de valor.

function parseFeatureFlag(setting: ConfigurationSetting<string>): ConfigurationSetting<FeatureFlagValue>

Parâmetros

setting

ConfigurationSetting<string>

Devoluções

parseSecretReference(ConfigurationSetting<string>)

Toma o ConfigurationSetting como entrada e retorna o ConfigurationSetting analisando a cadeia de caracteres de valor.

function parseSecretReference(setting: ConfigurationSetting<string>): ConfigurationSetting<SecretReferenceValue>

Parâmetros

setting

ConfigurationSetting<string>

Devoluções