다음을 통해 공유

AppConfigurationClient class

  • 참조
패키지:
@azure/app-configuration

Azure App Configuration 서비스에 대한 클라이언트입니다.

생성자

AppConfigurationClient(string, AppConfigurationClientOptions)

AppConfigurationClient 클래스의 새 인스턴스를 초기화합니다.
AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

TokenCredential을 사용하여 AppConfigurationClient 클래스의 새 인스턴스를 초기화합니다.

메서드

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

Azure App Configuration 서비스에 설정을 추가합니다. 이미 있는 경우 실패합니다.

사용 예:

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

준비된 스냅샷 보관

사용 예:

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

Azure App Configuration 서비스에 대한 스냅샷 만들기를 시작하고, 이미 있는 경우 실패합니다.
beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Azure App Configuration 서비스에 대한 스냅샷 만들기를 시작하고, 완료될 때까지 기다리며, 이미 있는 경우 실패합니다.
deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Azure App Configuration 서비스에서 설정 삭제

사용 예:

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

Azure App Configuration 서비스에서 설정을 가져옵니다.

예제 코드:

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

Azure App Configuration 서비스에서 스냅샷 가져오기

사용 예:

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

선택적으로 키 이름, 레이블 및 수락 날짜/시간을 기준으로 필터링된 Azure App Configuration 서비스의 설정을 나열합니다.

예제 코드:

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

이름에 따라 스냅샷에 대한 Azure App Configuration 서비스의 설정을 나열하며, 필요에 따라 키 이름, 레이블을 기준으로 필터링하고 datetime을 수락합니다.

예제 코드:

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

Azure App Configuration 서비스에서 레이블 목록 가져오기

예제 코드:

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

키 이름, 레이블 및 수락 날짜/시간을 기준으로 선택적으로 필터링되는 키 집합의 수정 버전을 나열합니다.

예제 코드:

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

Azure App Configuration 서비스의 모든 스냅샷 나열

사용 예:

const result = await client.listSnapshots();
recoverSnapshot(string, UpdateSnapshotOptions)

보관된 스냅샷을 다시 준비 상태로 복구

사용 예:

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

선택적 etag를 허용하는 Azure App Configuration 서비스에서 키 값을 설정합니다.
setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

키의 읽기 전용 상태를 설정하거나 지웁니다.
updateSyncToken(string)

외부 동기화 토큰을 추가하여 서비스 요청이 up-to-date 값을 받도록 합니다.

생성자 세부 정보

AppConfigurationClient(string, AppConfigurationClientOptions)

AppConfigurationClient 클래스의 새 인스턴스를 초기화합니다.

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

매개 변수

connectionString

string

클라이언트가 Azure에 연결하는 데 필요한 연결 문자열입니다.

options
AppConfigurationClientOptions

AppConfigurationClient에 대한 옵션입니다.

AppConfigurationClient(string, TokenCredential, AppConfigurationClientOptions)

TokenCredential을 사용하여 AppConfigurationClient 클래스의 새 인스턴스를 초기화합니다.

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

매개 변수

endpoint

string

App Configuration 서비스의 엔드포인트(예: https://sample.azconfig.io)입니다.

tokenCredential
TokenCredential

서비스에 대한 요청을 인증하는 데 사용되는 TokenCredential 인터페이스를 구현하는 개체입니다. @azure/identity 패키지를 사용하여 요구 사항에 맞는 자격 증명을 만듭니다.

options
AppConfigurationClientOptions

AppConfigurationClient에 대한 옵션입니다.

메서드 세부 정보

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

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>

매개 변수

configurationSetting

AddConfigurationSettingParam<string> | AddConfigurationSettingParam<FeatureFlagValue> | AddConfigurationSettingParam<SecretReferenceValue>

구성 설정입니다.

options
AddConfigurationSettingOptions

요청에 대한 선택적 매개 변수입니다.

반환

Promise<AddConfigurationSettingResponse>

archiveSnapshot(string, UpdateSnapshotOptions)

준비된 스냅샷 보관

사용 예:

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

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

매개 변수

name

string

스냅샷의 이름입니다.

options
UpdateSnapshotOptions

요청에 대한 선택적 매개 변수입니다.

반환

Promise<UpdateSnapshotResponse>

beginCreateSnapshot(SnapshotInfo, CreateSnapshotOptions)

Azure App Configuration 서비스에 대한 스냅샷 만들기를 시작하고, 이미 있는 경우 실패합니다.

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

매개 변수

snapshot
SnapshotInfo
options
CreateSnapshotOptions

반환

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

beginCreateSnapshotAndWait(SnapshotInfo, CreateSnapshotOptions)

Azure App Configuration 서비스에 대한 스냅샷 만들기를 시작하고, 완료될 때까지 기다리며, 이미 있는 경우 실패합니다.

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

매개 변수

snapshot
SnapshotInfo
options
CreateSnapshotOptions

반환

Promise<CreateSnapshotResponse>

deleteConfigurationSetting(ConfigurationSettingId, DeleteConfigurationSettingOptions)

Azure App Configuration 서비스에서 설정 삭제

사용 예:

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

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

매개 변수

id
ConfigurationSettingId

삭제할 구성 설정의 ID입니다.

options
DeleteConfigurationSettingOptions

요청에 대한 선택적 매개 변수(예: etag, 레이블)

반환

Promise<DeleteConfigurationSettingResponse>

getConfigurationSetting(ConfigurationSettingId, GetConfigurationSettingOptions)

Azure App Configuration 서비스에서 설정을 가져옵니다.

예제 코드:

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

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

매개 변수

id
ConfigurationSettingId

가져올 구성 설정의 ID입니다.

options
GetConfigurationSettingOptions

요청에 대한 선택적 매개 변수입니다.

반환

Promise<GetConfigurationSettingResponse>

getSnapshot(string, GetSnapshotOptions)

Azure App Configuration 서비스에서 스냅샷 가져오기

사용 예:

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

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

매개 변수

name

string

스냅샷의 이름입니다.

options
GetSnapshotOptions

요청에 대한 선택적 매개 변수입니다.

반환

Promise<GetSnapshotResponse>

listConfigurationSettings(ListConfigurationSettingsOptions)

선택적으로 키 이름, 레이블 및 수락 날짜/시간을 기준으로 필터링된 Azure App Configuration 서비스의 설정을 나열합니다.

예제 코드:

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

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

매개 변수

options
ListConfigurationSettingsOptions

요청에 대한 선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listConfigurationSettingsForSnapshot(string, ListConfigurationSettingsForSnapshotOptions)

이름에 따라 스냅샷에 대한 Azure App Configuration 서비스의 설정을 나열하며, 필요에 따라 키 이름, 레이블을 기준으로 필터링하고 datetime을 수락합니다.

예제 코드:

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

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

매개 변수

snapshotName

string

options
ListConfigurationSettingsForSnapshotOptions

요청에 대한 선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListConfigurationSettingPage, PageSettings>

listLabels(ListLabelsOptions)

Azure App Configuration 서비스에서 레이블 목록 가져오기

예제 코드:

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

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

매개 변수

options
ListLabelsOptions

요청에 대한 선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<SettingLabel, ListLabelsPage, PageSettings>

listRevisions(ListRevisionsOptions)

키 이름, 레이블 및 수락 날짜/시간을 기준으로 선택적으로 필터링되는 키 집합의 수정 버전을 나열합니다.

예제 코드:

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

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

매개 변수

options
ListRevisionsOptions

요청에 대한 선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<ConfigurationSetting<string>, ListRevisionsPage, PageSettings>

listSnapshots(ListSnapshotsOptions)

Azure App Configuration 서비스의 모든 스냅샷 나열

사용 예:

const result = await client.listSnapshots();

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

매개 변수

options
ListSnapshotsOptions

요청에 대한 선택적 매개 변수입니다.

반환

PagedAsyncIterableIterator<ConfigurationSnapshot, ListSnapshotsPage, PageSettings>

recoverSnapshot(string, UpdateSnapshotOptions)

보관된 스냅샷을 다시 준비 상태로 복구

사용 예:

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

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

매개 변수

name

string

스냅샷의 이름입니다.

options
UpdateSnapshotOptions

요청에 대한 선택적 매개 변수입니다.

반환

Promise<UpdateSnapshotResponse>

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

선택적 etag를 허용하는 Azure App Configuration 서비스에서 키 값을 설정합니다.

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

매개 변수

configurationSetting

SetConfigurationSettingParam<string> | SetConfigurationSettingParam<FeatureFlagValue> | SetConfigurationSettingParam<SecretReferenceValue>

구성 값입니다.

options
SetConfigurationSettingOptions

요청에 대한 선택적 매개 변수입니다.

예제 코드:

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

반환

Promise<SetConfigurationSettingResponse>

setReadOnly(ConfigurationSettingId, boolean, SetReadOnlyOptions)

키의 읽기 전용 상태를 설정하거나 지웁니다.

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

매개 변수

id
ConfigurationSettingId

수정할 구성 설정의 ID입니다.

readOnly

boolean

options
SetReadOnlyOptions

반환

Promise<SetReadOnlyResponse>

updateSyncToken(string)

외부 동기화 토큰을 추가하여 서비스 요청이 up-to-date 값을 받도록 합니다.

function updateSyncToken(syncToken: string)

매개 변수

syncToken

string

동기화 토큰 값입니다.