@azure/arm-appconfiguration 2.0.0 → 3.0.0-beta.1

package/review/arm-appconfiguration.api.md

@@ -0,0 +1,665 @@
+## API Report File for "@azure/arm-appconfiguration"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import * as coreAuth from '@azure/core-auth';
+import * as coreClient from '@azure/core-client';
+import { PagedAsyncIterableIterator } from '@azure/core-paging';
+import { PollerLike } from '@azure/core-lro';
+import { PollOperationState } from '@azure/core-lro';
+
+// @public
+export type ActionsRequired = string;
+
+// @public
+export interface ApiKey {
+    readonly connectionString?: string;
+    readonly id?: string;
+    readonly lastModified?: Date;
+    readonly name?: string;
+    readonly readOnly?: boolean;
+    readonly value?: string;
+}
+
+// @public
+export interface ApiKeyListResult {
+    nextLink?: string;
+    value?: ApiKey[];
+}
+
+// @public (undocumented)
+export class AppConfigurationManagementClient extends coreClient.ServiceClient {
+    // (undocumented)
+    $host: string;
+    constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: AppConfigurationManagementClientOptionalParams);
+    // (undocumented)
+    apiVersion: string;
+    // (undocumented)
+    configurationStores: ConfigurationStores;
+    // (undocumented)
+    keyValues: KeyValues;
+    // (undocumented)
+    operations: Operations;
+    // (undocumented)
+    privateEndpointConnections: PrivateEndpointConnections;
+    // (undocumented)
+    privateLinkResources: PrivateLinkResources;
+    // (undocumented)
+    subscriptionId: string;
+}
+
+// @public
+export interface AppConfigurationManagementClientOptionalParams extends coreClient.ServiceClientOptions {
+    $host?: string;
+    apiVersion?: string;
+    endpoint?: string;
+}
+
+// @public
+export interface CheckNameAvailabilityParameters {
+    name: string;
+    type: ConfigurationResourceType;
+}
+
+// @public
+export type ConfigurationResourceType = string;
+
+// @public
+export type ConfigurationStore = TrackedResource & {
+    identity?: ResourceIdentity;
+    sku: Sku;
+    readonly systemData?: SystemData;
+    readonly provisioningState?: ProvisioningState;
+    readonly creationDate?: Date;
+    readonly endpoint?: string;
+    encryption?: EncryptionProperties;
+    readonly privateEndpointConnections?: PrivateEndpointConnectionReference[];
+    publicNetworkAccess?: PublicNetworkAccess;
+    disableLocalAuth?: boolean;
+};
+
+// @public
+export interface ConfigurationStoreListResult {
+    nextLink?: string;
+    value?: ConfigurationStore[];
+}
+
+// @public
+export interface ConfigurationStores {
+    beginCreate(resourceGroupName: string, configStoreName: string, configStoreCreationParameters: ConfigurationStore, options?: ConfigurationStoresCreateOptionalParams): Promise<PollerLike<PollOperationState<ConfigurationStoresCreateResponse>, ConfigurationStoresCreateResponse>>;
+    beginCreateAndWait(resourceGroupName: string, configStoreName: string, configStoreCreationParameters: ConfigurationStore, options?: ConfigurationStoresCreateOptionalParams): Promise<ConfigurationStoresCreateResponse>;
+    beginDelete(resourceGroupName: string, configStoreName: string, options?: ConfigurationStoresDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, configStoreName: string, options?: ConfigurationStoresDeleteOptionalParams): Promise<void>;
+    beginUpdate(resourceGroupName: string, configStoreName: string, configStoreUpdateParameters: ConfigurationStoreUpdateParameters, options?: ConfigurationStoresUpdateOptionalParams): Promise<PollerLike<PollOperationState<ConfigurationStoresUpdateResponse>, ConfigurationStoresUpdateResponse>>;
+    beginUpdateAndWait(resourceGroupName: string, configStoreName: string, configStoreUpdateParameters: ConfigurationStoreUpdateParameters, options?: ConfigurationStoresUpdateOptionalParams): Promise<ConfigurationStoresUpdateResponse>;
+    get(resourceGroupName: string, configStoreName: string, options?: ConfigurationStoresGetOptionalParams): Promise<ConfigurationStoresGetResponse>;
+    list(options?: ConfigurationStoresListOptionalParams): PagedAsyncIterableIterator<ConfigurationStore>;
+    listByResourceGroup(resourceGroupName: string, options?: ConfigurationStoresListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ConfigurationStore>;
+    listKeys(resourceGroupName: string, configStoreName: string, options?: ConfigurationStoresListKeysOptionalParams): PagedAsyncIterableIterator<ApiKey>;
+    regenerateKey(resourceGroupName: string, configStoreName: string, regenerateKeyParameters: RegenerateKeyParameters, options?: ConfigurationStoresRegenerateKeyOptionalParams): Promise<ConfigurationStoresRegenerateKeyResponse>;
+}
+
+// @public
+export interface ConfigurationStoresCreateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ConfigurationStoresCreateResponse = ConfigurationStore;
+
+// @public
+export interface ConfigurationStoresDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface ConfigurationStoresGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationStoresGetResponse = ConfigurationStore;
+
+// @public
+export interface ConfigurationStoresListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type ConfigurationStoresListByResourceGroupNextResponse = ConfigurationStoreListResult;
+
+// @public
+export interface ConfigurationStoresListByResourceGroupOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type ConfigurationStoresListByResourceGroupResponse = ConfigurationStoreListResult;
+
+// @public
+export interface ConfigurationStoresListKeysNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type ConfigurationStoresListKeysNextResponse = ApiKeyListResult;
+
+// @public
+export interface ConfigurationStoresListKeysOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type ConfigurationStoresListKeysResponse = ApiKeyListResult;
+
+// @public
+export interface ConfigurationStoresListNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type ConfigurationStoresListNextResponse = ConfigurationStoreListResult;
+
+// @public
+export interface ConfigurationStoresListOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type ConfigurationStoresListResponse = ConfigurationStoreListResult;
+
+// @public
+export interface ConfigurationStoresRegenerateKeyOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type ConfigurationStoresRegenerateKeyResponse = ApiKey;
+
+// @public
+export interface ConfigurationStoresUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type ConfigurationStoresUpdateResponse = ConfigurationStore;
+
+// @public
+export interface ConfigurationStoreUpdateParameters {
+    disableLocalAuth?: boolean;
+    encryption?: EncryptionProperties;
+    identity?: ResourceIdentity;
+    publicNetworkAccess?: PublicNetworkAccess;
+    sku?: Sku;
+    tags?: {
+        [propertyName: string]: string;
+    };
+}
+
+// @public
+export type ConnectionStatus = string;
+
+// @public
+export type CreatedByType = string;
+
+// @public
+export interface EncryptionProperties {
+    keyVaultProperties?: KeyVaultProperties;
+}
+
+// @public
+export interface ErrorAdditionalInfo {
+    readonly info?: Record<string, unknown>;
+    readonly type?: string;
+}
+
+// @public
+export interface ErrorDetails {
+    readonly additionalInfo?: ErrorAdditionalInfo[];
+    readonly code?: string;
+    readonly message?: string;
+}
+
+// @public
+export interface ErrorResponse {
+    error?: ErrorDetails;
+}
+
+// @public
+export type IdentityType = string;
+
+// @public
+export interface KeyValue {
+    contentType?: string;
+    readonly eTag?: string;
+    readonly id?: string;
+    readonly key?: string;
+    readonly label?: string;
+    readonly lastModified?: Date;
+    readonly locked?: boolean;
+    readonly name?: string;
+    tags?: {
+        [propertyName: string]: string;
+    };
+    readonly type?: string;
+    value?: string;
+}
+
+// @public
+export interface KeyValueListResult {
+    nextLink?: string;
+    value?: KeyValue[];
+}
+
+// @public
+export interface KeyValues {
+    beginDelete(resourceGroupName: string, configStoreName: string, keyValueName: string, options?: KeyValuesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, configStoreName: string, keyValueName: string, options?: KeyValuesDeleteOptionalParams): Promise<void>;
+    createOrUpdate(resourceGroupName: string, configStoreName: string, keyValueName: string, options?: KeyValuesCreateOrUpdateOptionalParams): Promise<KeyValuesCreateOrUpdateResponse>;
+    get(resourceGroupName: string, configStoreName: string, keyValueName: string, options?: KeyValuesGetOptionalParams): Promise<KeyValuesGetResponse>;
+    listByConfigurationStore(resourceGroupName: string, configStoreName: string, options?: KeyValuesListByConfigurationStoreOptionalParams): PagedAsyncIterableIterator<KeyValue>;
+}
+
+// @public
+export interface KeyValuesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    keyValueParameters?: KeyValue;
+}
+
+// @public
+export type KeyValuesCreateOrUpdateResponse = KeyValue;
+
+// @public
+export interface KeyValuesDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface KeyValuesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type KeyValuesGetResponse = KeyValue;
+
+// @public
+export interface KeyValuesListByConfigurationStoreNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type KeyValuesListByConfigurationStoreNextResponse = KeyValueListResult;
+
+// @public
+export interface KeyValuesListByConfigurationStoreOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type KeyValuesListByConfigurationStoreResponse = KeyValueListResult;
+
+// @public
+export interface KeyVaultProperties {
+    identityClientId?: string;
+    keyIdentifier?: string;
+}
+
+// @public
+export enum KnownActionsRequired {
+    // (undocumented)
+    None = "None",
+    // (undocumented)
+    Recreate = "Recreate"
+}
+
+// @public
+export enum KnownConfigurationResourceType {
+    // (undocumented)
+    MicrosoftAppConfigurationConfigurationStores = "Microsoft.AppConfiguration/configurationStores"
+}
+
+// @public
+export enum KnownConnectionStatus {
+    // (undocumented)
+    Approved = "Approved",
+    // (undocumented)
+    Disconnected = "Disconnected",
+    // (undocumented)
+    Pending = "Pending",
+    // (undocumented)
+    Rejected = "Rejected"
+}
+
+// @public
+export enum KnownCreatedByType {
+    // (undocumented)
+    Application = "Application",
+    // (undocumented)
+    Key = "Key",
+    // (undocumented)
+    ManagedIdentity = "ManagedIdentity",
+    // (undocumented)
+    User = "User"
+}
+
+// @public
+export enum KnownIdentityType {
+    // (undocumented)
+    None = "None",
+    // (undocumented)
+    SystemAssigned = "SystemAssigned",
+    // (undocumented)
+    SystemAssignedUserAssigned = "SystemAssigned, UserAssigned",
+    // (undocumented)
+    UserAssigned = "UserAssigned"
+}
+
+// @public
+export enum KnownProvisioningState {
+    // (undocumented)
+    Canceled = "Canceled",
+    // (undocumented)
+    Creating = "Creating",
+    // (undocumented)
+    Deleting = "Deleting",
+    // (undocumented)
+    Failed = "Failed",
+    // (undocumented)
+    Succeeded = "Succeeded",
+    // (undocumented)
+    Updating = "Updating"
+}
+
+// @public
+export enum KnownPublicNetworkAccess {
+    // (undocumented)
+    Disabled = "Disabled",
+    // (undocumented)
+    Enabled = "Enabled"
+}
+
+// @public
+export interface LogSpecification {
+    blobDuration?: string;
+    displayName?: string;
+    name?: string;
+}
+
+// @public
+export interface MetricDimension {
+    displayName?: string;
+    internalName?: string;
+    name?: string;
+}
+
+// @public
+export interface MetricSpecification {
+    aggregationType?: string;
+    dimensions?: MetricDimension[];
+    displayDescription?: string;
+    displayName?: string;
+    fillGapWithZero?: boolean;
+    internalMetricName?: string;
+    name?: string;
+    unit?: string;
+}
+
+// @public
+export interface NameAvailabilityStatus {
+    readonly message?: string;
+    readonly nameAvailable?: boolean;
+    readonly reason?: string;
+}
+
+// @public
+export interface OperationDefinition {
+    display?: OperationDefinitionDisplay;
+    isDataAction?: boolean;
+    name?: string;
+    origin?: string;
+    properties?: OperationProperties;
+}
+
+// @public
+export interface OperationDefinitionDisplay {
+    description?: string;
+    operation?: string;
+    readonly provider?: string;
+    resource?: string;
+}
+
+// @public
+export interface OperationDefinitionListResult {
+    nextLink?: string;
+    value?: OperationDefinition[];
+}
+
+// @public
+export interface OperationProperties {
+    serviceSpecification?: ServiceSpecification;
+}
+
+// @public
+export interface Operations {
+    checkNameAvailability(checkNameAvailabilityParameters: CheckNameAvailabilityParameters, options?: OperationsCheckNameAvailabilityOptionalParams): Promise<OperationsCheckNameAvailabilityResponse>;
+    list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<OperationDefinition>;
+}
+
+// @public
+export interface OperationsCheckNameAvailabilityOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type OperationsCheckNameAvailabilityResponse = NameAvailabilityStatus;
+
+// @public
+export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type OperationsListNextResponse = OperationDefinitionListResult;
+
+// @public
+export interface OperationsListOptionalParams extends coreClient.OperationOptions {
+    skipToken?: string;
+}
+
+// @public
+export type OperationsListResponse = OperationDefinitionListResult;
+
+// @public
+export interface PrivateEndpoint {
+    id?: string;
+}
+
+// @public
+export interface PrivateEndpointConnection {
+    readonly id?: string;
+    readonly name?: string;
+    privateEndpoint?: PrivateEndpoint;
+    privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
+    readonly provisioningState?: ProvisioningState;
+    readonly type?: string;
+}
+
+// @public
+export interface PrivateEndpointConnectionListResult {
+    nextLink?: string;
+    value?: PrivateEndpointConnection[];
+}
+
+// @public
+export interface PrivateEndpointConnectionReference {
+    readonly id?: string;
+    readonly name?: string;
+    privateEndpoint?: PrivateEndpoint;
+    privateLinkServiceConnectionState?: PrivateLinkServiceConnectionState;
+    readonly provisioningState?: ProvisioningState;
+    readonly type?: string;
+}
+
+// @public
+export interface PrivateEndpointConnections {
+    beginCreateOrUpdate(resourceGroupName: string, configStoreName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<PrivateEndpointConnectionsCreateOrUpdateResponse>, PrivateEndpointConnectionsCreateOrUpdateResponse>>;
+    beginCreateOrUpdateAndWait(resourceGroupName: string, configStoreName: string, privateEndpointConnectionName: string, privateEndpointConnection: PrivateEndpointConnection, options?: PrivateEndpointConnectionsCreateOrUpdateOptionalParams): Promise<PrivateEndpointConnectionsCreateOrUpdateResponse>;
+    beginDelete(resourceGroupName: string, configStoreName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>;
+    beginDeleteAndWait(resourceGroupName: string, configStoreName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsDeleteOptionalParams): Promise<void>;
+    get(resourceGroupName: string, configStoreName: string, privateEndpointConnectionName: string, options?: PrivateEndpointConnectionsGetOptionalParams): Promise<PrivateEndpointConnectionsGetResponse>;
+    listByConfigurationStore(resourceGroupName: string, configStoreName: string, options?: PrivateEndpointConnectionsListByConfigurationStoreOptionalParams): PagedAsyncIterableIterator<PrivateEndpointConnection>;
+}
+
+// @public
+export interface PrivateEndpointConnectionsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export type PrivateEndpointConnectionsCreateOrUpdateResponse = PrivateEndpointConnection;
+
+// @public
+export interface PrivateEndpointConnectionsDeleteOptionalParams extends coreClient.OperationOptions {
+    resumeFrom?: string;
+    updateIntervalInMs?: number;
+}
+
+// @public
+export interface PrivateEndpointConnectionsGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateEndpointConnectionsGetResponse = PrivateEndpointConnection;
+
+// @public
+export interface PrivateEndpointConnectionsListByConfigurationStoreNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateEndpointConnectionsListByConfigurationStoreNextResponse = PrivateEndpointConnectionListResult;
+
+// @public
+export interface PrivateEndpointConnectionsListByConfigurationStoreOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateEndpointConnectionsListByConfigurationStoreResponse = PrivateEndpointConnectionListResult;
+
+// @public
+export interface PrivateLinkResource {
+    readonly groupId?: string;
+    readonly id?: string;
+    readonly name?: string;
+    readonly requiredMembers?: string[];
+    readonly requiredZoneNames?: string[];
+    readonly type?: string;
+}
+
+// @public
+export interface PrivateLinkResourceListResult {
+    nextLink?: string;
+    value?: PrivateLinkResource[];
+}
+
+// @public
+export interface PrivateLinkResources {
+    get(resourceGroupName: string, configStoreName: string, groupName: string, options?: PrivateLinkResourcesGetOptionalParams): Promise<PrivateLinkResourcesGetResponse>;
+    listByConfigurationStore(resourceGroupName: string, configStoreName: string, options?: PrivateLinkResourcesListByConfigurationStoreOptionalParams): PagedAsyncIterableIterator<PrivateLinkResource>;
+}
+
+// @public
+export interface PrivateLinkResourcesGetOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateLinkResourcesGetResponse = PrivateLinkResource;
+
+// @public
+export interface PrivateLinkResourcesListByConfigurationStoreNextOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateLinkResourcesListByConfigurationStoreNextResponse = PrivateLinkResourceListResult;
+
+// @public
+export interface PrivateLinkResourcesListByConfigurationStoreOptionalParams extends coreClient.OperationOptions {
+}
+
+// @public
+export type PrivateLinkResourcesListByConfigurationStoreResponse = PrivateLinkResourceListResult;
+
+// @public
+export interface PrivateLinkServiceConnectionState {
+    readonly actionsRequired?: ActionsRequired;
+    description?: string;
+    status?: ConnectionStatus;
+}
+
+// @public
+export type ProvisioningState = string;
+
+// @public
+export type PublicNetworkAccess = string;
+
+// @public
+export interface RegenerateKeyParameters {
+    id?: string;
+}
+
+// @public
+export interface Resource {
+    readonly id?: string;
+    readonly name?: string;
+    readonly type?: string;
+}
+
+// @public
+export interface ResourceIdentity {
+    readonly principalId?: string;
+    readonly tenantId?: string;
+    type?: IdentityType;
+    userAssignedIdentities?: {
+        [propertyName: string]: UserIdentity;
+    };
+}
+
+// @public
+export interface ServiceSpecification {
+    logSpecifications?: LogSpecification[];
+    metricSpecifications?: MetricSpecification[];
+}
+
+// @public
+export interface Sku {
+    name: string;
+}
+
+// @public
+export interface SystemData {
+    createdAt?: Date;
+    createdBy?: string;
+    createdByType?: CreatedByType;
+    lastModifiedAt?: Date;
+    lastModifiedBy?: string;
+    lastModifiedByType?: CreatedByType;
+}
+
+// @public
+export type TrackedResource = Resource & {
+    tags?: {
+        [propertyName: string]: string;
+    };
+    location: string;
+};
+
+// @public
+export interface UserIdentity {
+    readonly clientId?: string;
+    readonly principalId?: string;
+}
+
+// (No @packageDocumentation comment for this package)
+
+```