@azure/app-configuration package
Classes
| AppConfigurationClient |
Cliente para o serviço de Configuração de Aplicativos 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 configuração |
| ConfigurationSettingsFilter |
Habilita a filtragem de chave-valor. 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 obtenção de 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 da obtenção de 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 do campo _response do objeto Usado nos casos em que campos de resposta HTTP individuais são importantes para o usuário usar em casos de uso comum, como lidar com códigos de status http 204 ou 304. |
| ListConfigurationSettingPage |
Uma página de configurações e a resposta HTTP correspondente |
| ListConfigurationSettingsForSnapshotOptions |
Opções comuns para APIs de estilo 'list' 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 filtragem com base em chaves, rótulos e outros campos.
Também fornece |
| ListLabelsOptions |
Opções para listLabels |
| ListLabelsPage |
Uma página de configurações e a resposta HTTP correspondente |
| ListRevisionsOptions |
Opções para listRevisions que permitem filtragem com base em chaves, rótulos e outros campos.
Também fornece |
| ListRevisionsPage |
Uma página de configurações e a resposta HTTP correspondente |
| ListSettingsOptions |
Opções comuns para APIs de estilo 'list' no AppConfig usadas para especificar curingas, bem como o cabeçalho de data e hora de aceitação. |
| ListSnapshots |
Opções comuns para APIs de estilo 'list' 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 filtragem com base em chaves, rótulos e outros campos.
Também fornece |
| ListSnapshotsPage |
Uma página de configurações e a resposta HTTP correspondente |
| OptionalFields |
Usado quando a API dá suporte a campos de retorno seletivo. |
| OptionalLabelsFields |
Usado quando a API dá suporte a campos de rótulos de retorno seletivo. |
| OptionalSnapshotFields |
Usado quando a API dá suporte a campos de retorno seletivo. |
| PageSettings |
Uma interface que rastreia as configurações da 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 configuração de um ConfigurationSetting. |
| SetReadOnlyOptions |
Opções para setReadOnly |
| SetReadOnlyResponse |
Resposta ao definir um valor como somente leitura. |
| SettingLabel |
Detalhes do rótulo, com a 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 configuração |
| ConfigurationSetting |
Configuração com metadados extras do servidor, indicando sua etag, se atualmente é readOnly e quando foi modificada pela última vez. |
| ConfigurationSettingParam |
Campos necessários para atualizar ou criar uma nova configuração |
| ConfigurationSettingResponse |
Resposta base padrão para obter, excluir ou atualizar uma configuração |
| ConfigurationSnapshotStatus |
Define valores para ConfigurationSnapshotStatus. Valores conhecidos compatíveis com o serviço
de provisionamento |
| SetConfigurationSettingParam |
Parâmetros para criar ou atualizar uma nova configuração |
| SnapshotComposition |
Define valores para SnapshotComposition. Valores conhecidos compatíveis com o serviço
chave |
Enumerações
| KnownConfigurationSnapshotStatus |
Valores conhecidos de ConfigurationSnapshotStatus que o serviço aceita. |
| KnownSnapshotComposition |
Valores conhecidos de SnapshotComposition que o serviço aceita. |
Funções
| is |
Permite que você saiba se ConfigurationSetting é um sinalizador de recurso. [Verifica se o tipo de conteúdo é featureFlagContentType |
| is |
Permite que você saiba se ConfigurationSetting é uma referência secreta. [Verifica se o tipo de conteúdo é secretReferenceContentType |
| parse |
Usa o ConfigurationSetting como entrada e retorna o ConfigurationSetting analisando a cadeia de caracteres de valor. |
| parse |
Usa o ConfigurationSetting como entrada e retorna o ConfigurationSetting analisando a cadeia de caracteres de valor. |
Detalhes da função
isFeatureFlag(ConfigurationSetting<string>)
Permite que você saiba 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>): settingParâmetros
- setting
-
ConfigurationSetting<string>
Retornos
setting
isSecretReference(ConfigurationSetting<string>)
Permite que você saiba 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>): settingParâmetros
- setting
-
ConfigurationSetting<string>
Retornos
setting
parseFeatureFlag(ConfigurationSetting<string>)
Usa 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>
Retornos
parseSecretReference(ConfigurationSetting<string>)
Usa 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>