Share via

ConfigurationStore interface

Package:
@azure/arm-appconfiguration

The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.

Extends
TrackedResource

Properties

createMode

Indicates whether the configuration store need to be recovered.
creationDate

The creation date of configuration store. NOTE: This property will not be serialized. It can only be populated by the server.
dataPlaneProxy

Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM).
defaultKeyValueRevisionRetentionPeriodInSeconds

The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores.
disableLocalAuth

Disables all authentication methods other than AAD authentication.
enablePurgeProtection

Property specifying whether protection against purge is enabled for this configuration store.
encryption

The encryption settings of the configuration store.
endpoint

The DNS endpoint where the configuration store API will be available. NOTE: This property will not be serialized. It can only be populated by the server.
identity

The managed identity information, if configured.
privateEndpointConnections

The list of private endpoint connections that are set up for this resource. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state of the configuration store. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Control permission for data plane traffic coming from public networks while private endpoint is enabled.
sku

The sku of the configuration store.
softDeleteRetentionInDays

The amount of time in days that the configuration store will be retained when it is soft deleted.
systemData

Resource system metadata. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
___location

The geo-___location where the resource lives
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

createMode

Indicates whether the configuration store need to be recovered.

createMode?: CreateMode

Property Value

CreateMode

creationDate

The creation date of configuration store. NOTE: This property will not be serialized. It can only be populated by the server.

creationDate?: Date

Property Value

Date

dataPlaneProxy

Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM).

dataPlaneProxy?: DataPlaneProxyProperties

Property Value

DataPlaneProxyProperties

defaultKeyValueRevisionRetentionPeriodInSeconds

The duration in seconds to retain new key value revisions. Defaults to 604800 (7 days) for Free SKU stores and 2592000 (30 days) for Standard SKU stores and Premium SKU stores.

defaultKeyValueRevisionRetentionPeriodInSeconds?: number

Property Value

number

disableLocalAuth

Disables all authentication methods other than AAD authentication.

disableLocalAuth?: boolean

Property Value

boolean

enablePurgeProtection

Property specifying whether protection against purge is enabled for this configuration store.

enablePurgeProtection?: boolean

Property Value

boolean

encryption

The encryption settings of the configuration store.

encryption?: EncryptionProperties

Property Value

EncryptionProperties

endpoint

The DNS endpoint where the configuration store API will be available. NOTE: This property will not be serialized. It can only be populated by the server.

endpoint?: string

Property Value

string

identity

The managed identity information, if configured.

identity?: ResourceIdentity

Property Value

ResourceIdentity

privateEndpointConnections

The list of private endpoint connections that are set up for this resource. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnectionReference[]

Property Value

PrivateEndpointConnectionReference[]

provisioningState

The provisioning state of the configuration store. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

publicNetworkAccess?: string

Property Value

string

sku

The sku of the configuration store.

sku: Sku

Property Value

Sku

softDeleteRetentionInDays

The amount of time in days that the configuration store will be retained when it is soft deleted.

softDeleteRetentionInDays?: number

Property Value

number

systemData

Resource system metadata. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From TrackedResource.id

___location

The geo-___location where the resource lives

___location: string

Property Value

string

Inherited From TrackedResource.___location

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From TrackedResource.name

tags

Resource tags.

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From TrackedResource.type