AppConfigurationClient class
Cliente para o serviço de Configuração de Aplicativos do Azure.
Construtores
| App |
Inicializa uma nova instância da classe AppConfigurationClient. |
| App |
Inicializa uma nova instância da classe AppConfigurationClient usando um TokenCredential. |
Métodos
| add |
Adicione uma configuração ao serviço de Configuração de Aplicativos do Azure, falhando se ela já existir. Uso de exemplo: |
| archive |
Arquivar um instantâneo pronto Uso de exemplo: |
| begin |
Começa a criar um instantâneo para o serviço de Configuração de Aplicativos do Azure, caso ele já exista. |
| begin |
Começa a criar um instantâneo para o serviço de Configuração de Aplicativos do Azure, aguarda até que ele seja concluído, falha se ele já existir. |
| delete |
Excluir uma configuração do serviço de Configuração de Aplicativos do Azure Uso de exemplo: |
| get |
Obtém uma configuração do serviço de Configuração de Aplicativos do Azure. Código de exemplo: |
| get |
Obter um instantâneo do serviço de Configuração de Aplicativos do Azure Uso de exemplo: |
| list |
Lista as configurações do serviço de Configuração de Aplicativos do Azure, opcionalmente filtradas por nomes de chave, rótulos e datetime de aceitação. Código de exemplo: |
| list |
Lista as configurações do serviço de Configuração de Aplicativos do Azure para instantâneos com base no nome, opcionalmente filtrados por nomes de chave, rótulos e datetime de aceitação. Código de exemplo: |
| list |
Obter uma lista de rótulos do serviço de Configuração de Aplicativos do Azure Código de exemplo: |
| list |
Lista as revisões de um conjunto de chaves, opcionalmente filtradas por nomes de chave, rótulos e datetime de aceitação. Código de exemplo: |
| list |
Listar todos os instantâneos do serviço de Configuração de Aplicativos do Azure Uso de exemplo: |
| recover |
Recuperar um instantâneo arquivado de volta ao status pronto Uso de exemplo: |
| set |
Define o valor de uma chave no serviço de Configuração de Aplicativos do Azure, permitindo uma etag opcional. |
| set |
Define ou limpa o status somente leitura de uma chave. |
| update |
Adiciona um token de sincronização externa 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
Cadeia de conexão necessária para um cliente se conectar ao Azure.
- 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 no 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>, AddConfigurationSettingOptions)
Adicione uma configuração ao serviço de Configuração de Aplicativos do Azure, falhando se ela já existir.
Uso de exemplo:
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
- configurationSetting
-
AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>
Uma configuração.
- options
- AddConfigurationSettingOptions
Parâmetros opcionais para a solicitação.
Retornos
Promise<AddConfigurationSettingResponse>
archiveSnapshot(string, UpdateSnapshotOptions)
Arquivar um instantâneo pronto
Uso de exemplo:
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.
Retornos
Promise<UpdateSnapshotResponse>
beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)
Começa a criar um instantâneo para o serviço de Configuração de Aplicativos do Azure, caso ele já exista.
function beginCreateSnapshot(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<SimplePollerLike<OperationState<CreateSnapshotResponse>, CreateSnapshotResponse>>Parâmetros
- snapshot
- SnapshotInfo
- options
- CreateSnapshotOptions
Retornos
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 Aplicativos do Azure, aguarda até que ele seja concluído, falha se ele já existir.
function beginCreateSnapshotAndWait(snapshot: SnapshotInfo, options?: CreateSnapshotOptions): Promise<CreateSnapshotResponse>Parâmetros
- snapshot
- SnapshotInfo
- options
- CreateSnapshotOptions
Retornos
Promise<CreateSnapshotResponse>
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)
Excluir uma configuração do serviço de Configuração de Aplicativos do Azure
Uso de exemplo:
const deletedSetting = await client.deleteConfigurationSetting({ key: "MyKey", label: "MyLabel" });
function deleteConfigurationSetting(id: ConfigurationSettingId, options?: DeleteConfigurationSettingOptions): Promise<DeleteConfigurationSettingResponse>Parâmetros
A ID da configuração a ser excluída.
Parâmetros opcionais para a solicitação (ex: etag, label)
Retornos
Promise<DeleteConfigurationSettingResponse>
getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)
Obtém uma configuração do serviço de Configuração de Aplicativos 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
A ID da configuração a ser obtido.
- options
- GetConfigurationSettingOptions
Parâmetros opcionais para a solicitação.
Retornos
Promise<GetConfigurationSettingResponse>
getSnapshot(string, GetSnapshotOptions)
Obter um instantâneo do serviço de Configuração de Aplicativos do Azure
Uso de exemplo:
const result = await client.getSnapshot("MySnapshot");
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.
Retornos
Promise<GetSnapshotResponse>
listConfigurationSettings(ListConfigurationSettingsOptions)
Lista as configurações do serviço de Configuração de Aplicativos 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
- options
- ListConfigurationSettingsOptions
Parâmetros opcionais para a solicitação.
Retornos
listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)
Lista as configurações do serviço de Configuração de Aplicativos do Azure para instantâneos com base no nome, opcionalmente filtrados por nomes de chave, rótulos e datetime de aceitação.
Código de exemplo:
const allSettingsWithLabel = client.listConfigurationSettingsForSnashots({ snapshotName: "MySnapshot" });
function listConfigurationSettingsForSnapshot(snapshotName: string, options?: ListConfigurationSettingsForSnapshotOptions): PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>Parâmetros
- snapshotName
-
string
Parâmetros opcionais para a solicitação.
Retornos
listLabels(ListLabelsOptions)
Obter uma lista de rótulos do serviço de Configuração de Aplicativos do Azure
Código de exemplo:
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.
Retornos
listRevisions(ListRevisionsOptions)
Lista as revisões de um conjunto de chaves, opcionalmente filtradas por nomes de chave, rótulos e datetime de aceitação.
Código de exemplo:
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.
Retornos
listSnapshots(ListSnapshotsOptions)
Listar todos os instantâneos do serviço de Configuração de Aplicativos do Azure
Uso de exemplo:
const result = await client.listSnapshots();
function listSnapshots(options?: ListSnapshotsOptions): PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>Parâmetros
- options
- ListSnapshotsOptions
Parâmetros opcionais para a solicitação.
Retornos
recoverSnapshot(string, UpdateSnapshotOptions)
Recuperar um instantâneo arquivado de volta ao status pronto
Uso de exemplo:
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.
Retornos
Promise<UpdateSnapshotResponse>
setConfigurationSetting(SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, SetConfigurationSettingOptions)
Define o valor de uma chave no serviço de Configuração de Aplicativos do Azure, permitindo uma etag opcional.
function setConfigurationSetting(configurationSetting: SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>, options?: SetConfigurationSettingOptions): Promise<SetConfigurationSettingResponse>Parâmetros
- configurationSetting
-
SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>
Um valor de configuração.
- options
- SetConfigurationSettingOptions
Parâmetros opcionais para a solicitação.
Código de exemplo:
await client.setConfigurationSetting({ key: "MyKey", value: "MyValue" });
Retornos
Promise<SetConfigurationSettingResponse>
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
A ID da configuração a ser modificada.
- readOnly
-
boolean
- options
- SetReadOnlyOptions
Retornos
Promise<SetReadOnlyResponse>
updateSyncToken(string)
Adiciona um token de sincronização externa 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.