Partilhar via


AppConfigurationClient class

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

Construtores

AppConfigurationClient(string, AppConfigurationClientOptions)

Inicializa uma nova instância da classe AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

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

Métodos

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue> | AddConfigurationSettingParam<SnapshotReferenceValue>, AddConfigurationSettingOptions)

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

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

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

Arquivar um snapshot pronto

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

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

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

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

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.

checkConfigurationSettings(CheckConfigurationSettingsOptions)

Verifica as definições do serviço de Configuração de Aplicações Azure usando um pedido HEAD, devolvendo apenas cabeçalhos sem o corpo da resposta. Isto é útil para verificar eficientemente se as definições mudaram, comparando ETags.

Código de exemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const pageIterator = client.checkConfigurationSettings({ keyFilter: "MyKey" }).byPage();
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

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

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

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

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

Código de exemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

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

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

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const retrievedSnapshot = await client.getSnapshot("testsnapshot");
console.log("Retrieved snapshot:", retrievedSnapshot);
listConfigurationSettings(ListConfigurationSettingsOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

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

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

Código de exemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

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

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

Código de exemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

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

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

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const snapshots = await client.listSnapshots();

for await (const snapshot of snapshots) {
  console.log(`Found snapshot: ${snapshot.name}`);
}
recoverSnapshot(string, UpdateSnapshotOptions)

Recupere um instantâneo arquivado de volta ao status pronto

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const result = await client.recoverSnapshot("MySnapshot");
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue> | SetConfigurationSettingParam<SnapshotReferenceValue>, SetConfigurationSettingOptions)

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

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Define ou limpa o status somente leitura de uma chave.

updateSyncToken(string)

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

Detalhes do Construtor

AppConfigurationClient(string, AppConfigurationClientOptions)

Inicializa uma nova instância da classe AppConfigurationClient.

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

Parâmetros

connectionString

string

options
AppConfigurationClientOptions

Opções para o AppConfigurationClient.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

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

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

Parâmetros

endpoint

string

O ponto de extremidade do serviço de Configuração de Aplicativo (por exemplo, https://sample.azconfig.io).

tokenCredential
TokenCredential

Um objeto que implementa a interface TokenCredential usada para autenticar solicitações para o serviço. Use o pacote @azure/identity para criar uma credencial que atenda às suas necessidades.

options
AppConfigurationClientOptions

Opções para o AppConfigurationClient.

Detalhes do Método

addConfigurationSetting(AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue> | AddConfigurationSettingParam<SnapshotReferenceValue>, AddConfigurationSettingOptions)

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

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const result = await client.addConfigurationSetting({
  key: "MyKey",
  label: "MyLabel",
  value: "MyValue",
});
function addConfigurationSetting(configurationSetting: AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue> | AddConfigurationSettingParam<SnapshotReferenceValue>, options?: AddConfigurationSettingOptions): Promise<AddConfigurationSettingResponse>

Parâmetros

options
AddConfigurationSettingOptions

Parâmetros opcionais para a solicitação.

Regressos

archiveSnapshot(string, UpdateSnapshotOptions)

Arquivar um snapshot pronto

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const result = await client.archiveSnapshot({ name: "MySnapshot" });
function archiveSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

Parâmetros

name

string

O nome do instantâneo.

options
UpdateSnapshotOptions

Parâmetros opcionais para a solicitação.

Regressos

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

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

snapshot
SnapshotInfo

Regressos

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

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

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

snapshot
SnapshotInfo

Regressos

checkConfigurationSettings(CheckConfigurationSettingsOptions)

Verifica as definições do serviço de Configuração de Aplicações Azure usando um pedido HEAD, devolvendo apenas cabeçalhos sem o corpo da resposta. Isto é útil para verificar eficientemente se as definições mudaram, comparando ETags.

Código de exemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const pageIterator = client.checkConfigurationSettings({ keyFilter: "MyKey" }).byPage();
function checkConfigurationSettings(options?: CheckConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

Parâmetros

options
CheckConfigurationSettingsOptions

Parâmetros opcionais para a solicitação.

Regressos

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

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

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const deletedSetting = await client.deleteConfigurationSetting({
  key: "MyKey",
  label: "MyLabel",
});
function deleteConfigurationSetting(id: ConfigurationSettingId, options?: DeleteConfigurationSettingOptions): Promise<DeleteConfigurationSettingResponse>

Parâmetros

id
ConfigurationSettingId

A id da definição de configuração a ser excluída.

options
DeleteConfigurationSettingOptions

Parâmetros opcionais para o pedido (ex: etag, label)

Regressos

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

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

Código de exemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const setting = await client.getConfigurationSetting({ key: "MyKey", label: "MyLabel" });
function getConfigurationSetting(id: ConfigurationSettingId, options?: GetConfigurationSettingOptions): Promise<GetConfigurationSettingResponse>

Parâmetros

id
ConfigurationSettingId

A id da definição de configuração a ser obtida.

options
GetConfigurationSettingOptions

Parâmetros opcionais para a solicitação.

Regressos

getSnapshot(string, GetSnapshotOptions)

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

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const retrievedSnapshot = await client.getSnapshot("testsnapshot");
console.log("Retrieved snapshot:", retrievedSnapshot);
function getSnapshot(name: string, options?: GetSnapshotOptions): Promise<GetSnapshotResponse>

Parâmetros

name

string

O nome do instantâneo.

options
GetSnapshotOptions

Parâmetros opcionais para a solicitação.

Regressos

listConfigurationSettings(ListConfigurationSettingsOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const allSettingsWithLabel = client.listConfigurationSettings({ labelFilter: "MyLabel" });
function listConfigurationSettings(options?: ListConfigurationSettingsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

Parâmetros

options
ListConfigurationSettingsOptions

Parâmetros opcionais para a solicitação.

Regressos

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

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:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({
  snapshotName: "MySnapshot",
});
function listConfigurationSettingsForSnapshot(snapshotName: string, options?: ListConfigurationSettingsForSnapshotOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

Parâmetros

snapshotName

string

options
ListConfigurationSettingsForSnapshotOptions

Parâmetros opcionais para a solicitação.

Regressos

listLabels(ListLabelsOptions)

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

Código de exemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const allSettingsWithLabel = client.listLabels({ nameFilter: "prod*" });
function listLabels(options?: ListLabelsOptions): PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

Parâmetros

options
ListLabelsOptions

Parâmetros opcionais para a solicitação.

Regressos

listRevisions(ListRevisionsOptions)

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

Código de exemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const revisionsIterator = client.listRevisions({ keys: ["MyKey"] });
function listRevisions(options?: ListRevisionsOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

Parâmetros

options
ListRevisionsOptions

Parâmetros opcionais para a solicitação.

Regressos

listSnapshots(ListSnapshotsOptions)

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

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const snapshots = await client.listSnapshots();

for await (const snapshot of snapshots) {
  console.log(`Found snapshot: ${snapshot.name}`);
}
function listSnapshots(options?: ListSnapshotsOptions): PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

Parâmetros

options
ListSnapshotsOptions

Parâmetros opcionais para a solicitação.

Regressos

recoverSnapshot(string, UpdateSnapshotOptions)

Recupere um instantâneo arquivado de volta ao status pronto

Exemplo de uso:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

const result = await client.recoverSnapshot("MySnapshot");
function recoverSnapshot(name: string, options?: UpdateSnapshotOptions): Promise<UpdateSnapshotResponse>

Parâmetros

name

string

O nome do instantâneo.

options
UpdateSnapshotOptions

Parâmetros opcionais para a solicitação.

Regressos

setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue> | SetConfigurationSettingParam<SnapshotReferenceValue>, SetConfigurationSettingOptions)

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> | SetConfigurationSettingParam<SnapshotReferenceValue>, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>

Parâmetros

options
SetConfigurationSettingOptions

Parâmetros opcionais para a solicitação.

Código de exemplo:

import { DefaultAzureCredential } from "@azure/identity";
import { AppConfigurationClient } from "@azure/app-configuration";

// The endpoint for your App Configuration resource
const endpoint = "https://example.azconfig.io";
const credential = new DefaultAzureCredential();
const client = new AppConfigurationClient(endpoint, credential);

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

Regressos

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

Define ou limpa o status somente leitura de uma chave.

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

Parâmetros

id
ConfigurationSettingId

A id da definição de configuração a ser modificada.

readOnly

boolean

Regressos

updateSyncToken(string)

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

syncToken

string

O valor do token de sincronização.