@azure/arm-appconfiguration package

Classes

AppConfigurationManagementClient

Interfaces

ApiKey	An API key used for authenticating with a configuration store endpoint.
AppConfigurationManagementClientOptionalParams	Optional parameters for the client.
AzureFrontDoorProperties	Azure Front Door settings
CheckNameAvailabilityParameters	Parameters used for checking whether a resource name is available.
ConfigurationStore	The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.
ConfigurationStoreProperties	The properties of a configuration store.
ConfigurationStorePropertiesUpdateParameters	The properties for updating a configuration store.
ConfigurationStoreUpdateParameters	The parameters for updating a configuration store.
ConfigurationStoresCreateOptionalParams	Optional parameters.
ConfigurationStoresDeleteOptionalParams	Optional parameters.
ConfigurationStoresGetDeletedOptionalParams	Optional parameters.
ConfigurationStoresGetOptionalParams	Optional parameters.
ConfigurationStoresListByResourceGroupOptionalParams	Optional parameters.
ConfigurationStoresListDeletedOptionalParams	Optional parameters.
ConfigurationStoresListKeysOptionalParams	Optional parameters.
ConfigurationStoresListOptionalParams	Optional parameters.
ConfigurationStoresOperations	Interface representing a ConfigurationStores operations.
ConfigurationStoresPurgeDeletedOptionalParams	Optional parameters.
ConfigurationStoresRegenerateKeyOptionalParams	Optional parameters.
ConfigurationStoresUpdateOptionalParams	Optional parameters.
DataPlaneProxyProperties	The data plane proxy settings for a configuration store.
DeletedConfigurationStore	Deleted configuration store information with extended details.
DeletedConfigurationStoreProperties	Properties of the deleted configuration store.
EncryptionProperties	The encryption settings for a configuration store.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
KeyValue	The key-value resource along with all resource properties.
KeyValueFilter	Enables filtering of key-values.
KeyValueProperties	All key-value properties.
KeyValuesCreateOrUpdateOptionalParams	Optional parameters.
KeyValuesDeleteOptionalParams	Optional parameters.
KeyValuesGetOptionalParams	Optional parameters.
KeyValuesOperations	Interface representing a KeyValues operations.
KeyVaultProperties	Settings concerning key vault encryption for a configuration store.
LogSpecification	Specifications of the Log for Azure Monitoring
ManagedOnBehalfOfConfiguration	Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner.
MetricDimension	Specifications of the Dimension of metrics
MetricSpecification	Specifications of the Metrics for Azure Monitoring
MoboBrokerResource	Managed-On-Behalf-Of broker resource. This resource is created by the Resource Provider to manage some resources on behalf of the user.
NameAvailabilityStatus	The result of a request to check the availability of a resource name.
OperationDefinition	The definition of a configuration store operation.
OperationDefinitionDisplay	The display information for a configuration store operation.
OperationProperties	Extra Operation properties
OperationsCheckNameAvailabilityOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OperationsRegionalCheckNameAvailabilityOptionalParams	Optional parameters.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateEndpoint	Private endpoint which a connection belongs to.
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointConnectionProperties	Properties of a private endpoint connection.
PrivateEndpointConnectionReference	A reference to a related private endpoint connection.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByConfigurationStoreOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	A resource that supports private link capabilities.
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByConfigurationStoreOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	The state of a private link service connection.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegenerateKeyParameters	The parameters used to regenerate an API key.
Replica	The replica resource.
ReplicaProperties	All replica properties.
ReplicasCreateOptionalParams	Optional parameters.
ReplicasDeleteOptionalParams	Optional parameters.
ReplicasGetOptionalParams	Optional parameters.
ReplicasListByConfigurationStoreOptionalParams	Optional parameters.
ReplicasOperations	Interface representing a Replicas operations.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceIdentity	An identity that can be associated with a resource.
RestorePollerOptions
ServiceSpecification	Service specification payload
SimplePollerLike	A simple poller that can be used to poll a long running operation.
Sku	Describes a configuration store SKU.
Snapshot	The snapshot resource.
SnapshotProperties	All snapshot properties.
SnapshotsCreateOptionalParams	Optional parameters.
SnapshotsGetOptionalParams	Optional parameters.
SnapshotsOperations	Interface representing a Snapshots operations.
SystemData	Metadata pertaining to creation and last modification of the resource.
TelemetryProperties	Telemetry settings
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
UserIdentity	A resource identity that is managed by the user of the service.

Type Aliases

ActionsRequired	Any action that is required beyond basic workflow (approve/ reject/ disconnect) KnownActionsRequired can be used interchangeably with ActionsRequired, this enum contains the known values that the service supports. Known values supported by the service None Recreate
AuthenticationMode	The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. KnownAuthenticationMode can be used interchangeably with AuthenticationMode, this enum contains the known values that the service supports. Known values supported by the service Local: The local authentication mode. Users are not required to have data plane permissions if local authentication is not disabled. Pass-through: The pass-through authentication mode. User identity will be passed through from ARM, requiring user to have data plane action permissions (Available via App Configuration Data Owner/ App Configuration Data Reader).
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CompositionType	The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label. KnownCompositionType can be used interchangeably with CompositionType, this enum contains the known values that the service supports. Known values supported by the service Key Key_Label
ConfigurationResourceType	The resource type to check for name availability. KnownConfigurationResourceType can be used interchangeably with ConfigurationResourceType, this enum contains the known values that the service supports. Known values supported by the service Microsoft.AppConfiguration/configurationStores
ConnectionStatus	The private link service connection status. KnownConnectionStatus can be used interchangeably with ConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected Disconnected
ContinuablePage	An interface that describes a page of results.
CreateMode	Indicates whether the configuration store need to be recovered.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
IdentityType	The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities. KnownIdentityType can be used interchangeably with IdentityType, this enum contains the known values that the service supports. Known values supported by the service None SystemAssigned UserAssigned SystemAssigned, UserAssigned
PrivateLinkDelegation	The data plane proxy private link delegation. This property manages if a request from delegated ARM private link is allowed when the data plane resource requires private link. KnownPrivateLinkDelegation can be used interchangeably with PrivateLinkDelegation, this enum contains the known values that the service supports. Known values supported by the service Enabled: ARM private endpoint is required if the resource requires private link. Disabled: Request is denied if the resource requires private link.
ProvisioningState	The provisioning state of the configuration store. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Updating Deleting Succeeded Failed Canceled
PublicNetworkAccess	Control permission for data plane traffic coming from public networks while private endpoint is enabled. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
ReplicaProvisioningState	The provisioning state of the replica. KnownReplicaProvisioningState can be used interchangeably with ReplicaProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Creating Succeeded Deleting Failed Canceled
SnapshotStatus	The current status of the snapshot. KnownSnapshotStatus can be used interchangeably with SnapshotStatus, this enum contains the known values that the service supports. Known values supported by the service Provisioning Ready Archived Failed

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionsRequired	Any action that is required beyond basic workflow (approve/ reject/ disconnect)
KnownAuthenticationMode	The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources.
KnownCompositionType	The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label.
KnownConfigurationResourceType	The resource type to check for name availability.
KnownConnectionStatus	The private link service connection status.
KnownCreatedByType	The kind of entity that created the resource.
KnownIdentityType	The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.
KnownPrivateLinkDelegation	The data plane proxy private link delegation. This property manages if a request from delegated ARM private link is allowed when the data plane resource requires private link.
KnownProvisioningState	The provisioning state of the configuration store.
KnownPublicNetworkAccess	Control permission for data plane traffic coming from public networks while private endpoint is enabled.
KnownReplicaProvisioningState	The provisioning state of the replica.
KnownSnapshotStatus	The current status of the snapshot.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(AppConfigurationManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(AppConfigurationManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: AppConfigurationManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

AppConfigurationManagementClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>