AppConfigurationClient class

Inicializa uma nova instância da classe AppConfigurationClient.

new AppConfigurationClient(connectionString: string, options?: AppConfigurationClientOptions)

Parâmetros

Inicializa uma nova instância da classe AppConfigurationClient usando um TokenCredential.

new AppConfigurationClient(endpoint: string, tokenCredential: TokenCredential, options?: AppConfigurationClientOptions)

Parâmetros

Adicione uma configuração ao serviço de Configuração de Aplicativo do Azure, falhando se ela já existir.

Exemplo de uso:

const result = await client.addConfigurationSetting({ key: "MyKey", label: "MyLabel", value: "MyValue" });

function addConfigurationSetting(configurationSetting: AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>, options?: AddConfigurationSettingOptions): Promise<AddConfigurationSettingResponse>

Parâmetros

Devoluções

Arquivar um snapshot pronto

Exemplo de uso:

const result = await client.archiveSnapshot({name: "MySnapshot"});

function archiveSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

Parâmetros

Devoluções

Começa a criar um instantâneo para o serviço de Configuração de Aplicativo do Azure, falhará se ele já existir.

function beginCreateSnapshot(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>

Parâmetros

Devoluções

Começa a criar um instantâneo para o serviço de Configuração de Aplicativo do Azure, aguarda até que seja concluído, falha se ele já existir.

function beginCreateSnapshotAndWait(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<CreateSnapshotResponse>

Parâmetros

Devoluções

Excluir uma configuração do serviço de Configuração de Aplicativo do Azure

Exemplo de uso:

const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });

function deleteConfigurationSetting(id: ConfigurationSettingId, options?: DeleteConfigurationSettingOptions): Promise<DeleteConfigurationSettingResponse>

Parâmetros

Devoluções

Obtém uma configuração do serviço de Configuração de Aplicativo do Azure.

Código de exemplo:

const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });

function getConfigurationSetting(id: ConfigurationSettingId, options?: GetConfigurationSettingOptions): Promise<GetConfigurationSettingResponse>

Parâmetros

Devoluções

Obter um instantâneo do serviço de Configuração de Aplicativo do Azure

Exemplo de uso:

const result = await client.getSnapshot("MySnapshot");

function getSnapshot(name: string, options?: GetSnapshotOptions): Promise<GetSnapshotResponse>

Parâmetros

Devoluções

Lista as configurações do serviço de Configuração de Aplicativo do Azure, opcionalmente filtradas por nomes de chave, rótulos e datetime de aceitação.

Código de exemplo:

const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });

function listConfigurationSettings(options?: ListConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

Parâmetros

Devoluções

Lista as configurações do serviço de Configuração de Aplicativo do Azure para instantâneos com base no nome, opcionalmente filtrados por nomes de chave, rótulos e aceitar datetime.

Código de exemplo:

const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });

function listConfigurationSettingsForSnapshot(snapshotName: string, options?: ListConfigurationSettingsForSnapshotOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

Parâmetros

Devoluções

Obter uma lista de rótulos do serviço de Configuração de Aplicativo do Azure

Código de exemplo:

const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });

function listLabels(options?: ListLabelsOptions): PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

Parâmetros

Devoluções

Lista revisões de um conjunto de chaves, opcionalmente filtradas por nomes de chaves, rótulos e aceitar datetime.

Código de exemplo:

const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });

function listRevisions(options?: ListRevisionsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

Parâmetros

Devoluções

Listar todos os instantâneos do serviço de Configuração de Aplicativo do Azure

Exemplo de uso:

const result = await client.listSnapshots();

function listSnapshots(options?: ListSnapshotsOptions): PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

Parâmetros

Devoluções

Recupere um instantâneo arquivado de volta ao status pronto

Exemplo de uso:

const result = await client.recoverSnapshot("MySnapshot");

function recoverSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

Parâmetros

Devoluções

Define o valor de uma chave no serviço de Configuração de Aplicativo do Azure, permitindo uma etag opcional.

function setConfigurationSetting(configurationSetting: SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>

Parâmetros

await client.setConfigurationSetting({ key: "MyKey", value: "MyValue" });

Devoluções

Define ou limpa o status somente leitura de uma chave.

function setReadOnly(id: ConfigurationSettingId, readOnly: boolean, options?: SetReadOnlyOptions): Promise<SetReadOnlyResponse>

Parâmetros

Devoluções

Adiciona um token de sincronização externo para garantir que as solicitações de serviço recebam valores de data up-to.

function updateSyncToken(syncToken: string)

Parâmetros