@azure/arm-appconfiguration package

Classes

AppConfigurationManagementClient

Interfaces

ApiKey	An API key used for authenticating with a configuration store endpoint.
ApiKeyListResult	The result of a request to list API keys.
AppConfigurationManagementClientOptionalParams	Optional parameters.
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.
ConfigurationStoreListResult	The result of a request to list configuration stores.
ConfigurationStoreUpdateParameters	The parameters for updating a configuration store.
ConfigurationStores	Interface representing a ConfigurationStores.
ConfigurationStoresCreateOptionalParams	Optional parameters.
ConfigurationStoresDeleteOptionalParams	Optional parameters.
ConfigurationStoresGetDeletedOptionalParams	Optional parameters.
ConfigurationStoresGetOptionalParams	Optional parameters.
ConfigurationStoresListByResourceGroupNextOptionalParams	Optional parameters.
ConfigurationStoresListByResourceGroupOptionalParams	Optional parameters.
ConfigurationStoresListDeletedNextOptionalParams	Optional parameters.
ConfigurationStoresListDeletedOptionalParams	Optional parameters.
ConfigurationStoresListKeysNextOptionalParams	Optional parameters.
ConfigurationStoresListKeysOptionalParams	Optional parameters.
ConfigurationStoresListNextOptionalParams	Optional parameters.
ConfigurationStoresListOptionalParams	Optional parameters.
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.
DeletedConfigurationStoreListResult	List of deleted configuration stores
EncryptionProperties	The encryption settings for a configuration store.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorDetails	The details of the error.
ErrorResponse	Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.
ErrorResponseAutoGenerated	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
KeyValue	The key-value resource along with all resource properties.
KeyValueFilter	Enables filtering of key-values.
KeyValueListResult	The result of a request to list key-values.
KeyValues	Interface representing a KeyValues.
KeyValuesCreateOrUpdateOptionalParams	Optional parameters.
KeyValuesDeleteOptionalParams	Optional parameters.
KeyValuesGetOptionalParams	Optional parameters.
KeyVaultProperties	Settings concerning key vault encryption for a configuration store.
LogSpecification	Specifications of the Log for Azure Monitoring
MetricDimension	Specifications of the Dimension of metrics
MetricSpecification	Specifications of the Metrics for Azure Monitoring
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.
OperationDefinitionListResult	The result of a request to list configuration store operations.
OperationProperties	Extra Operation properties
Operations	Interface representing a Operations.
OperationsCheckNameAvailabilityOptionalParams	Optional parameters.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
OperationsRegionalCheckNameAvailabilityOptionalParams	Optional parameters.
PrivateEndpoint	Private endpoint which a connection belongs to.
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointConnectionListResult	A list of private endpoint connections
PrivateEndpointConnectionReference	A reference to a related private endpoint connection.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByConfigurationStoreNextOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByConfigurationStoreOptionalParams	Optional parameters.
PrivateLinkResource	A resource that supports private link capabilities.
PrivateLinkResourceListResult	A list of private link resources.
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByConfigurationStoreNextOptionalParams	Optional parameters.
PrivateLinkResourcesListByConfigurationStoreOptionalParams	Optional parameters.
PrivateLinkServiceConnectionState	The state of a private link service connection.
RegenerateKeyParameters	The parameters used to regenerate an API key.
Replica	The replica resource.
ReplicaListResult	The result of a request to list replicas.
Replicas	Interface representing a Replicas.
ReplicasCreateOptionalParams	Optional parameters.
ReplicasDeleteHeaders	Defines headers for Replicas_delete operation.
ReplicasDeleteOptionalParams	Optional parameters.
ReplicasGetOptionalParams	Optional parameters.
ReplicasListByConfigurationStoreNextOptionalParams	Optional parameters.
ReplicasListByConfigurationStoreOptionalParams	Optional parameters.
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.
ServiceSpecification	Service specification payload
Sku	Describes a configuration store SKU.
Snapshot	The snapshot resource.
Snapshots	Interface representing a Snapshots.
SnapshotsCreateOptionalParams	Optional parameters.
SnapshotsGetOptionalParams	Optional parameters.
SystemData	Metadata pertaining to creation and last modification of the resource.
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	Defines values for ActionsRequired. 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	Defines values for AuthenticationMode. 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 Azure Resource Manager (ARM), requiring user to have data plane action permissions (Available via App Configuration Data Owner/ App Configuration Data Reader).
CompositionType	Defines values for CompositionType. 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	Defines values for ConfigurationResourceType. 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
ConfigurationStoresCreateResponse	Contains response data for the create operation.
ConfigurationStoresGetDeletedResponse	Contains response data for the getDeleted operation.
ConfigurationStoresGetResponse	Contains response data for the get operation.
ConfigurationStoresListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
ConfigurationStoresListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
ConfigurationStoresListDeletedNextResponse	Contains response data for the listDeletedNext operation.
ConfigurationStoresListDeletedResponse	Contains response data for the listDeleted operation.
ConfigurationStoresListKeysNextResponse	Contains response data for the listKeysNext operation.
ConfigurationStoresListKeysResponse	Contains response data for the listKeys operation.
ConfigurationStoresListNextResponse	Contains response data for the listNext operation.
ConfigurationStoresListResponse	Contains response data for the list operation.
ConfigurationStoresRegenerateKeyResponse	Contains response data for the regenerateKey operation.
ConfigurationStoresUpdateResponse	Contains response data for the update operation.
ConnectionStatus	Defines values for ConnectionStatus. 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
CreateMode	Defines values for CreateMode.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
IdentityType	Defines values for IdentityType. 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
KeyValuesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
KeyValuesGetResponse	Contains response data for the get operation.
OperationsCheckNameAvailabilityResponse	Contains response data for the checkNameAvailability operation.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
OperationsRegionalCheckNameAvailabilityResponse	Contains response data for the regionalCheckNameAvailability operation.
PrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListByConfigurationStoreNextResponse	Contains response data for the listByConfigurationStoreNext operation.
PrivateEndpointConnectionsListByConfigurationStoreResponse	Contains response data for the listByConfigurationStore operation.
PrivateLinkDelegation	Defines values for PrivateLinkDelegation. KnownPrivateLinkDelegation can be used interchangeably with PrivateLinkDelegation, this enum contains the known values that the service supports. Known values supported by the service Enabled: Azure Resource Manager (ARM) private endpoint is required if the resource requires private link. Disabled: Request is denied if the resource requires private link.
PrivateLinkResourcesGetResponse	Contains response data for the get operation.
PrivateLinkResourcesListByConfigurationStoreNextResponse	Contains response data for the listByConfigurationStoreNext operation.
PrivateLinkResourcesListByConfigurationStoreResponse	Contains response data for the listByConfigurationStore operation.
ProvisioningState	Defines values for ProvisioningState. 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	Defines values for PublicNetworkAccess. 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	Defines values for ReplicaProvisioningState. 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
ReplicasCreateResponse	Contains response data for the create operation.
ReplicasGetResponse	Contains response data for the get operation.
ReplicasListByConfigurationStoreNextResponse	Contains response data for the listByConfigurationStoreNext operation.
ReplicasListByConfigurationStoreResponse	Contains response data for the listByConfigurationStore operation.
SnapshotStatus	Defines values for SnapshotStatus. 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
SnapshotsCreateResponse	Contains response data for the create operation.
SnapshotsGetResponse	Contains response data for the get operation.

Enums

KnownActionsRequired	Known values of ActionsRequired that the service accepts.
KnownAuthenticationMode	Known values of AuthenticationMode that the service accepts.
KnownCompositionType	Known values of CompositionType that the service accepts.
KnownConfigurationResourceType	Known values of ConfigurationResourceType that the service accepts.
KnownConnectionStatus	Known values of ConnectionStatus that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownIdentityType	Known values of IdentityType that the service accepts.
KnownPrivateLinkDelegation	Known values of PrivateLinkDelegation that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownReplicaProvisioningState	Known values of ReplicaProvisioningState that the service accepts.
KnownSnapshotStatus	Known values of SnapshotStatus that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.