AppConfigurationClient class

AppConfigurationClient クラスの新しいインスタンスを初期化します。

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

パラメーター

TokenCredential を使用して、AppConfigurationClient クラスの新しいインスタンスを初期化します。

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

パラメーター

Azure App Configuration サービスに設定を追加します。既に存在する場合は失敗します。

使用例:

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

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

パラメーター

戻り値

準備完了スナップショットをアーカイブする

使用例:

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

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

パラメーター

戻り値

Azure App Configuration サービスのスナップショットの作成を開始します。既に存在する場合は失敗します。

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

パラメーター

戻り値

Azure App Configuration サービスのスナップショットの作成を開始し、完了するまで待機します。既に存在する場合は失敗します。

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

パラメーター

戻り値

Azure App Configuration サービスから設定を削除する

使用例:

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

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

パラメーター

戻り値

Azure App Configuration サービスから設定を取得します。

コード例:

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

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

パラメーター

戻り値

Azure App Configuration サービスからスナップショットを取得する

使用例:

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

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

パラメーター

戻り値

必要に応じて、キー名、ラベル、および受け入れ datetime でフィルター処理された、Azure App Configuration サービスの設定を一覧表示します。

コード例:

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

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

パラメーター

戻り値

名前に基づいてスナップショットの Azure App Configuration サービスの設定を一覧表示します。必要に応じて、キー名、ラベル、および受け入れ datetime でフィルター処理されます。

コード例:

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

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

パラメーター

戻り値

Azure App Configuration サービスからラベルの一覧を取得する

コード例:

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

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

パラメーター

戻り値

キーのセットのリビジョンを一覧表示します。必要に応じて、キー名、ラベル、および受け入れ datetime でフィルター処理します。

コード例:

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

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

パラメーター

戻り値

Azure App Configuration サービスからのすべてのスナップショットを一覧表示する

使用例:

const result = await client.listSnapshots();

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

パラメーター

戻り値

アーカイブされたスナップショットを回復して準備完了状態に戻す

使用例:

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

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

パラメーター

戻り値

Azure App Configuration サービスのキーの値を設定し、オプションの etag を使用できるようにします。

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

パラメーター

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

戻り値

キーの読み取り専用状態を設定またはクリアします。

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

パラメーター

戻り値

外部同期トークンを追加して、サービス要求が -date 値 up-to受け取れるようにします。

function updateSyncToken(syncToken: string)

パラメーター