@azure/app-configuration/dist/esm/snapshotReference.d.ts

An isomorphic client library for the Azure App Configuration service.

import type { ConfigurationSetting, ConfigurationSettingParam } from "./models.js";
/**
 * content-type for the snapshot reference.
 */
export declare const snapshotReferenceContentType = "application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8";
/**
 * Necessary fields for updating or creating a new snapshot reference.
 */
export interface SnapshotReferenceValue {
    /**
     * snapshot name.
     */
    snapshotName: string;
}
/**
 * @internal
 */
export declare const SnapshotReferenceHelper: {
    /**
     * Takes the SnapshotReference (JSON) and returns a ConfigurationSetting (with the props encoded in the value).
     */
    toConfigurationSettingParam: (snapshotReference: ConfigurationSettingParam<SnapshotReferenceValue>) => ConfigurationSettingParam;
};
/**
 * Takes the ConfigurationSetting as input and returns the ConfigurationSetting<SnapshotReferenceValue> by parsing the value string.
 */
export declare function parseSnapshotReference(setting: ConfigurationSetting): ConfigurationSetting<SnapshotReferenceValue>;
/**
 * Lets you know if the ConfigurationSetting is a snapshot reference.
 *
 * [Checks if the content type is snapshotReferenceContentType `"application/json; profile=\"https://azconfig.io/mime-profiles/snapshot-ref\"; charset=utf-8"`]
 */
export declare function isSnapshotReference(setting: ConfigurationSetting): setting is ConfigurationSetting & Required<Pick<ConfigurationSetting, "value">>;
//# sourceMappingURL=snapshotReference.d.ts.map