appconfiguration.azure.com/v1api20220501

Package v1api20220501 contains API Schema definitions for the appconfiguration v1api20220501 API group

Resource Types:

APIVersion (`string` alias)

Value	Description
"2022-05-01"

ConfigurationStore

Generator information: - Generated from: /appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2022-05-01/appconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}

Field Description

metadata
Kubernetes meta/v1.ObjectMeta Refer to the Kubernetes API documentation for the fields of the metadata field.

spec
ConfigurationStore_Spec

`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`createMode` ConfigurationStoreProperties_CreateMode	CreateMode: Indicates whether the configuration store need to be recovered.
`disableLocalAuth` bool	DisableLocalAuth: Disables all authentication methods other than AAD authentication.
`enablePurgeProtection` bool	EnablePurgeProtection: Property specifying whether protection against purge is enabled for this configuration store.
`encryption` EncryptionProperties	Encryption: The encryption settings of the configuration store.
`identity` ResourceIdentity	Identity: The managed identity information, if configured.
`location` string	Location: The geo-location where the resource lives
`operatorSpec` ConfigurationStoreOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`publicNetworkAccess` ConfigurationStoreProperties_PublicNetworkAccess	PublicNetworkAccess: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
`sku` Sku	Sku: The sku of the configuration store.
`softDeleteRetentionInDays` int	SoftDeleteRetentionInDays: The amount of time in days that the configuration store will be retained when it is soft deleted.
`systemData` SystemData	SystemData: Resource system metadata.
`tags` map[string]string	Tags: Resource tags.

status
ConfigurationStore_STATUS

ConfigurationStoreOperatorSecrets

(Appears on:ConfigurationStoreOperatorSpec)

Field	Description
`primaryConnectionString` genruntime.SecretDestination	PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
`primaryKey` genruntime.SecretDestination	PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`primaryKeyID` genruntime.SecretDestination	PrimaryKeyID: indicates where the PrimaryKeyID secret should be placed. If omitted, the secret will not be retrieved from Azure.
`primaryReadOnlyConnectionString` genruntime.SecretDestination	PrimaryReadOnlyConnectionString: indicates where the PrimaryReadOnlyConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
`primaryReadOnlyKey` genruntime.SecretDestination	PrimaryReadOnlyKey: indicates where the PrimaryReadOnlyKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`primaryReadOnlyKeyID` genruntime.SecretDestination	PrimaryReadOnlyKeyID: indicates where the PrimaryReadOnlyKeyID secret should be placed. If omitted, the secret will not be retrieved from Azure.
`secondaryConnectionString` genruntime.SecretDestination	SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
`secondaryKey` genruntime.SecretDestination	SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`secondaryKeyID` genruntime.SecretDestination	SecondaryKeyID: indicates where the SecondaryKeyID secret should be placed. If omitted, the secret will not be retrieved from Azure.
`secondaryReadOnlyConnectionString` genruntime.SecretDestination	SecondaryReadOnlyConnectionString: indicates where the SecondaryReadOnlyConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure.
`secondaryReadOnlyKey` genruntime.SecretDestination	SecondaryReadOnlyKey: indicates where the SecondaryReadOnlyKey secret should be placed. If omitted, the secret will not be retrieved from Azure.
`secondaryReadOnlyKeyID` genruntime.SecretDestination	SecondaryReadOnlyKeyID: indicates where the SecondaryReadOnlyKeyID secret should be placed. If omitted, the secret will not be retrieved from Azure.

ConfigurationStoreOperatorSpec

(Appears on:ConfigurationStore_Spec)

Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

Field	Description
`configMapExpressions` []genruntime/core.DestinationExpression	ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).
`secretExpressions` []genruntime/core.DestinationExpression	SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).
`secrets` ConfigurationStoreOperatorSecrets	Secrets: configures where to place Azure generated secrets.

ConfigurationStoreProperties_CreateMode (`string` alias)

(Appears on:ConfigurationStore_Spec)

Value	Description
"Default"
"Recover"

ConfigurationStoreProperties_CreateMode_STATUS (`string` alias)

(Appears on:ConfigurationStore_STATUS)

Value	Description
"Default"
"Recover"

ConfigurationStoreProperties_ProvisioningState_STATUS (`string` alias)

(Appears on:ConfigurationStore_STATUS)

Value	Description
"Canceled"
"Creating"
"Deleting"
"Failed"
"Succeeded"
"Updating"

ConfigurationStoreProperties_PublicNetworkAccess (`string` alias)

(Appears on:ConfigurationStore_Spec)

Value	Description
"Disabled"
"Enabled"

ConfigurationStoreProperties_PublicNetworkAccess_STATUS (`string` alias)

(Appears on:ConfigurationStore_STATUS)

Value	Description
"Disabled"
"Enabled"

ConfigurationStore_STATUS

(Appears on:ConfigurationStore)

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

Field	Description
`conditions` []genruntime/conditions.Condition	Conditions: The observed state of the resource
`createMode` ConfigurationStoreProperties_CreateMode_STATUS	CreateMode: Indicates whether the configuration store need to be recovered.
`creationDate` string	CreationDate: The creation date of configuration store.
`disableLocalAuth` bool	DisableLocalAuth: Disables all authentication methods other than AAD authentication.
`enablePurgeProtection` bool	EnablePurgeProtection: Property specifying whether protection against purge is enabled for this configuration store.
`encryption` EncryptionProperties_STATUS	Encryption: The encryption settings of the configuration store.
`endpoint` string	Endpoint: The DNS endpoint where the configuration store API will be available.
`id` string	Id: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
`identity` ResourceIdentity_STATUS	Identity: The managed identity information, if configured.
`location` string	Location: The geo-location where the resource lives
`name` string	Name: The name of the resource
`privateEndpointConnections` []PrivateEndpointConnectionReference_STATUS	PrivateEndpointConnections: The list of private endpoint connections that are set up for this resource.
`provisioningState` ConfigurationStoreProperties_ProvisioningState_STATUS	ProvisioningState: The provisioning state of the configuration store.
`publicNetworkAccess` ConfigurationStoreProperties_PublicNetworkAccess_STATUS	PublicNetworkAccess: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
`sku` Sku_STATUS	Sku: The sku of the configuration store.
`softDeleteRetentionInDays` int	SoftDeleteRetentionInDays: The amount of time in days that the configuration store will be retained when it is soft deleted.
`systemData` SystemData_STATUS	SystemData: Resource system metadata.
`tags` map[string]string	Tags: Resource tags.
`type` string	Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

ConfigurationStore_Spec

(Appears on:ConfigurationStore)

Field	Description
`azureName` string	AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.
`createMode` ConfigurationStoreProperties_CreateMode	CreateMode: Indicates whether the configuration store need to be recovered.
`disableLocalAuth` bool	DisableLocalAuth: Disables all authentication methods other than AAD authentication.
`enablePurgeProtection` bool	EnablePurgeProtection: Property specifying whether protection against purge is enabled for this configuration store.
`encryption` EncryptionProperties	Encryption: The encryption settings of the configuration store.
`identity` ResourceIdentity	Identity: The managed identity information, if configured.
`location` string	Location: The geo-location where the resource lives
`operatorSpec` ConfigurationStoreOperatorSpec	OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure
`owner` genruntime.KnownResourceReference	Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource
`publicNetworkAccess` ConfigurationStoreProperties_PublicNetworkAccess	PublicNetworkAccess: Control permission for data plane traffic coming from public networks while private endpoint is enabled.
`sku` Sku	Sku: The sku of the configuration store.
`softDeleteRetentionInDays` int	SoftDeleteRetentionInDays: The amount of time in days that the configuration store will be retained when it is soft deleted.
`systemData` SystemData	SystemData: Resource system metadata.
`tags` map[string]string	Tags: Resource tags.

EncryptionProperties

(Appears on:ConfigurationStore_Spec)

The encryption settings for a configuration store.

Field	Description
`keyVaultProperties` KeyVaultProperties	KeyVaultProperties: Key vault properties.

EncryptionProperties_STATUS

(Appears on:ConfigurationStore_STATUS)

The encryption settings for a configuration store.

Field	Description
`keyVaultProperties` KeyVaultProperties_STATUS	KeyVaultProperties: Key vault properties.

KeyVaultProperties

(Appears on:EncryptionProperties)

Settings concerning key vault encryption for a configuration store.

Field	Description
`identityClientId` string	IdentityClientId: The client id of the identity which will be used to access key vault.
`keyIdentifier` string	KeyIdentifier: The URI of the key vault key used to encrypt data.

KeyVaultProperties_STATUS

(Appears on:EncryptionProperties_STATUS)

Settings concerning key vault encryption for a configuration store.

Field	Description
`identityClientId` string	IdentityClientId: The client id of the identity which will be used to access key vault.
`keyIdentifier` string	KeyIdentifier: The URI of the key vault key used to encrypt data.

PrivateEndpointConnectionReference_STATUS

(Appears on:ConfigurationStore_STATUS)

A reference to a related private endpoint connection.

Field	Description
`id` string	Id: The resource ID.

ResourceIdentity

(Appears on:ConfigurationStore_Spec)

An identity that can be associated with a resource.

Field	Description
`type` ResourceIdentity_Type	Type: 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.
`userAssignedIdentities` []UserAssignedIdentityDetails	UserAssignedIdentities: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

ResourceIdentity_STATUS

(Appears on:ConfigurationStore_STATUS)

An identity that can be associated with a resource.

Field	Description
`principalId` string	PrincipalId: The principal id of the identity. This property will only be provided for a system-assigned identity.
`tenantId` string	TenantId: The tenant id associated with the resource’s identity. This property will only be provided for a system-assigned identity.
`type` ResourceIdentity_Type_STATUS	Type: 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.
`userAssignedIdentities` map[string]./api/appconfiguration/v1api20220501.UserIdentity_STATUS	UserAssignedIdentities: The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

ResourceIdentity_Type (`string` alias)

(Appears on:ResourceIdentity)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

ResourceIdentity_Type_STATUS (`string` alias)

(Appears on:ResourceIdentity_STATUS)

Value	Description
"None"
"SystemAssigned"
"SystemAssigned, UserAssigned"
"UserAssigned"

Sku

(Appears on:ConfigurationStore_Spec)

Describes a configuration store SKU.

Field	Description
`name` string	Name: The SKU name of the configuration store.

Sku_STATUS

(Appears on:ConfigurationStore_STATUS)

Describes a configuration store SKU.

Field	Description
`name` string	Name: The SKU name of the configuration store.

SystemData

(Appears on:ConfigurationStore_Spec)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType	LastModifiedByType: The type of identity that last modified the resource.

SystemData_CreatedByType (`string` alias)

(Appears on:SystemData)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_CreatedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType (`string` alias)

(Appears on:SystemData)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_LastModifiedByType_STATUS (`string` alias)

(Appears on:SystemData_STATUS)

Value	Description
"Application"
"Key"
"ManagedIdentity"
"User"

SystemData_STATUS

(Appears on:ConfigurationStore_STATUS)

Metadata pertaining to creation and last modification of the resource.

Field	Description
`createdAt` string	CreatedAt: The timestamp of resource creation (UTC).
`createdBy` string	CreatedBy: The identity that created the resource.
`createdByType` SystemData_CreatedByType_STATUS	CreatedByType: The type of identity that created the resource.
`lastModifiedAt` string	LastModifiedAt: The timestamp of resource last modification (UTC)
`lastModifiedBy` string	LastModifiedBy: The identity that last modified the resource.
`lastModifiedByType` SystemData_LastModifiedByType_STATUS	LastModifiedByType: The type of identity that last modified the resource.

UserAssignedIdentityDetails

(Appears on:ResourceIdentity)

Information about the user assigned identity for the resource

Field	Description
`reference` genruntime.ResourceReference

UserIdentity_STATUS

(Appears on:ResourceIdentity_STATUS)

A resource identity that is managed by the user of the service.

Field	Description
`clientId` string	ClientId: The client ID of the user-assigned identity.
`principalId` string	PrincipalId: The principal ID of the user-assigned identity.

appconfiguration.azure.com/v1api20220501