appconfiguration.azure.com/v20240601
APIVersion
| Value | Description |
|---|---|
| “2024-06-01” |
ConfigurationStore
Generator information: - Generated from: /appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/stable/2024-06-01/appconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
Used by: ConfigurationStoreList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | ConfigurationStore_Spec Optional |
|
| status | ConfigurationStore_STATUS Optional |
ConfigurationStore_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| createMode | Indicates whether the configuration store need to be recovered. | ConfigurationStoreProperties_CreateMode Optional |
| dataPlaneProxy | Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). | DataPlaneProxyProperties Optional |
| 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. | int Optional |
| disableLocalAuth | Disables all authentication methods other than AAD authentication. | bool Optional |
| enablePurgeProtection | Property specifying whether protection against purge is enabled for this configuration store. | bool Optional |
| encryption | The encryption settings of the configuration store. | EncryptionProperties Optional |
| identity | The managed identity information, if configured. | ResourceIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ConfigurationStoreOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| publicNetworkAccess | Control permission for data plane traffic coming from public networks while private endpoint is enabled. | ConfigurationStoreProperties_PublicNetworkAccess Optional |
| sku | The sku of the configuration store. | Sku Required |
| softDeleteRetentionInDays | The amount of time in days that the configuration store will be retained when it is soft deleted. | int Optional |
| tags | Resource tags. | map[string]string Optional |
ConfigurationStore_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createMode | Indicates whether the configuration store need to be recovered. | ConfigurationStoreProperties_CreateMode_STATUS Optional |
| creationDate | The creation date of configuration store. | string Optional |
| dataPlaneProxy | Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). | DataPlaneProxyProperties_STATUS Optional |
| 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. | int Optional |
| disableLocalAuth | Disables all authentication methods other than AAD authentication. | bool Optional |
| enablePurgeProtection | Property specifying whether protection against purge is enabled for this configuration store. | bool Optional |
| encryption | The encryption settings of the configuration store. | EncryptionProperties_STATUS Optional |
| endpoint | The DNS endpoint where the configuration store API will be available. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The managed identity information, if configured. | ResourceIdentity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | The list of private endpoint connections that are set up for this resource. | PrivateEndpointConnectionReference_STATUS[] Optional |
| provisioningState | The provisioning state of the configuration store. | ConfigurationStoreProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccess | Control permission for data plane traffic coming from public networks while private endpoint is enabled. | ConfigurationStoreProperties_PublicNetworkAccess_STATUS Optional |
| sku | The sku of the configuration store. | Sku_STATUS Optional |
| softDeleteRetentionInDays | The amount of time in days that the configuration store will be retained when it is soft deleted. | int Optional |
| systemData | Resource system metadata. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
ConfigurationStoreList
Generator information: - Generated from: /appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/stable/2024-06-01/appconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | ConfigurationStore[] Optional |
KeyValue
Generator information: - Generated from: /appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/stable/2024-06-01/appconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}
Used by: KeyValueList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | KeyValue_Spec Optional |
|
| status | KeyValue_STATUS Optional |
KeyValue_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| contentType | The content type of the key-value’s value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | KeyValueOperatorSpec Optional |
| 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 appconfiguration.azure.com/ConfigurationStore resource | genruntime.KnownResourceReference Required |
| tags | A dictionary of tags that can help identify what a key-value may be applicable for. | map[string]string Optional |
| value | The value of the key-value. | string Optional |
KeyValue_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| contentType | The content type of the key-value’s value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. | string Optional |
| eTag | An ETag indicating the state of a key-value within a configuration store. | string Optional |
| id | The resource ID. | string Optional |
| key | The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value. | string Optional |
| label | A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value. | string Optional |
| lastModified | The last time a modifying operation was performed on the given key-value. | string Optional |
| locked | A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked. | bool Optional |
| name | The name of the resource. | string Optional |
| tags | A dictionary of tags that can help identify what a key-value may be applicable for. | map[string]string Optional |
| type | The type of the resource. | string Optional |
| value | The value of the key-value. | string Optional |
KeyValueList
Generator information: - Generated from: /appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/stable/2024-06-01/appconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/keyValues/{keyValueName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | KeyValue[] Optional |
Replica
Generator information: - Generated from: /appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/stable/2024-06-01/appconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}
Used by: ReplicaList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Replica_Spec Optional |
|
| status | Replica_STATUS Optional |
Replica_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| location | The location of the replica. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ReplicaOperatorSpec Optional |
| 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 appconfiguration.azure.com/ConfigurationStore resource | genruntime.KnownResourceReference Required |
Replica_STATUS
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endpoint | The URI of the replica where the replica API will be available. | string Optional |
| id | The resource ID. | string Optional |
| location | The location of the replica. | string Optional |
| name | The name of the replica. | string Optional |
| provisioningState | The provisioning state of the replica. | ReplicaProperties_ProvisioningState_STATUS Optional |
| systemData | Resource system metadata. | SystemData_STATUS Optional |
| type | The type of the resource. | string Optional |
ReplicaList
Generator information: - Generated from: /appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/stable/2024-06-01/appconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/replicas/{replicaName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Replica[] Optional |
Snapshot
Generator information: - Generated from: /appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/stable/2024-06-01/appconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/snapshots/{snapshotName}
Used by: SnapshotList.
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ObjectMeta | ||
| spec | Snapshot_Spec Optional |
|
| status | Snapshot_STATUS Optional |
Snapshot_Spec
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| 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. |
SnapshotProperties_CompositionType Optional |
| filters | A list of filters used to filter the key-values included in the snapshot. | KeyValueFilter[] Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SnapshotOperatorSpec Optional |
| 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 appconfiguration.azure.com/ConfigurationStore resource | genruntime.KnownResourceReference Required |
| retentionPeriod | The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. | int Optional |
| tags | The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags. | map[string]string Optional |
Snapshot_STATUS
| Property | Description | 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. |
SnapshotProperties_CompositionType_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| created | The time that the snapshot was created. | string Optional |
| etag | A value representing the current state of the snapshot. | string Optional |
| expires | The time that the snapshot will expire. | string Optional |
| filters | A list of filters used to filter the key-values included in the snapshot. | KeyValueFilter_STATUS[] Optional |
| id | The resource ID. | string Optional |
| itemsCount | The amount of key-values in the snapshot. | int Optional |
| name | The name of the snapshot. | string Optional |
| provisioningState | The provisioning state of the snapshot. | SnapshotProperties_ProvisioningState_STATUS Optional |
| retentionPeriod | The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. | int Optional |
| size | The size in bytes of the snapshot. | int Optional |
| status | The current status of the snapshot. | SnapshotProperties_Status_STATUS Optional |
| tags | The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags. | map[string]string Optional |
| type | The type of the resource. | string Optional |
SnapshotList
Generator information: - Generated from: /appconfiguration/resource-manager/Microsoft.AppConfiguration/AppConfiguration/stable/2024-06-01/appconfiguration.json - ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/snapshots/{snapshotName}
| Property | Description | Type |
|---|---|---|
| metav1.TypeMeta | ||
| metav1.ListMeta | ||
| items | Snapshot[] Optional |
ConfigurationStore_Spec
Used by: ConfigurationStore.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| createMode | Indicates whether the configuration store need to be recovered. | ConfigurationStoreProperties_CreateMode Optional |
| dataPlaneProxy | Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). | DataPlaneProxyProperties Optional |
| 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. | int Optional |
| disableLocalAuth | Disables all authentication methods other than AAD authentication. | bool Optional |
| enablePurgeProtection | Property specifying whether protection against purge is enabled for this configuration store. | bool Optional |
| encryption | The encryption settings of the configuration store. | EncryptionProperties Optional |
| identity | The managed identity information, if configured. | ResourceIdentity Optional |
| location | The geo-location where the resource lives | string Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ConfigurationStoreOperatorSpec Optional |
| 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 | genruntime.KnownResourceReference Required |
| publicNetworkAccess | Control permission for data plane traffic coming from public networks while private endpoint is enabled. | ConfigurationStoreProperties_PublicNetworkAccess Optional |
| sku | The sku of the configuration store. | Sku Required |
| softDeleteRetentionInDays | The amount of time in days that the configuration store will be retained when it is soft deleted. | int Optional |
| tags | Resource tags. | map[string]string Optional |
ConfigurationStore_STATUS
The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.
Used by: ConfigurationStore.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| createMode | Indicates whether the configuration store need to be recovered. | ConfigurationStoreProperties_CreateMode_STATUS Optional |
| creationDate | The creation date of configuration store. | string Optional |
| dataPlaneProxy | Property specifying the configuration of data plane proxy for Azure Resource Manager (ARM). | DataPlaneProxyProperties_STATUS Optional |
| 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. | int Optional |
| disableLocalAuth | Disables all authentication methods other than AAD authentication. | bool Optional |
| enablePurgeProtection | Property specifying whether protection against purge is enabled for this configuration store. | bool Optional |
| encryption | The encryption settings of the configuration store. | EncryptionProperties_STATUS Optional |
| endpoint | The DNS endpoint where the configuration store API will be available. | string Optional |
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} | string Optional |
| identity | The managed identity information, if configured. | ResourceIdentity_STATUS Optional |
| location | The geo-location where the resource lives | string Optional |
| name | The name of the resource | string Optional |
| privateEndpointConnections | The list of private endpoint connections that are set up for this resource. | PrivateEndpointConnectionReference_STATUS[] Optional |
| provisioningState | The provisioning state of the configuration store. | ConfigurationStoreProperties_ProvisioningState_STATUS Optional |
| publicNetworkAccess | Control permission for data plane traffic coming from public networks while private endpoint is enabled. | ConfigurationStoreProperties_PublicNetworkAccess_STATUS Optional |
| sku | The sku of the configuration store. | Sku_STATUS Optional |
| softDeleteRetentionInDays | The amount of time in days that the configuration store will be retained when it is soft deleted. | int Optional |
| systemData | Resource system metadata. | SystemData_STATUS Optional |
| tags | Resource tags. | map[string]string Optional |
| type | The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” | string Optional |
KeyValue_Spec
Used by: KeyValue.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| contentType | The content type of the key-value’s value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | KeyValueOperatorSpec Optional |
| 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 appconfiguration.azure.com/ConfigurationStore resource | genruntime.KnownResourceReference Required |
| tags | A dictionary of tags that can help identify what a key-value may be applicable for. | map[string]string Optional |
| value | The value of the key-value. | string Optional |
KeyValue_STATUS
Used by: KeyValue.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| contentType | The content type of the key-value’s value. Providing a proper content-type can enable transformations of values when they are retrieved by applications. | string Optional |
| eTag | An ETag indicating the state of a key-value within a configuration store. | string Optional |
| id | The resource ID. | string Optional |
| key | The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value. | string Optional |
| label | A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value. | string Optional |
| lastModified | The last time a modifying operation was performed on the given key-value. | string Optional |
| locked | A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked. | bool Optional |
| name | The name of the resource. | string Optional |
| tags | A dictionary of tags that can help identify what a key-value may be applicable for. | map[string]string Optional |
| type | The type of the resource. | string Optional |
| value | The value of the key-value. | string Optional |
Replica_Spec
Used by: Replica.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| location | The location of the replica. | string Optional |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | ReplicaOperatorSpec Optional |
| 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 appconfiguration.azure.com/ConfigurationStore resource | genruntime.KnownResourceReference Required |
Replica_STATUS
Used by: Replica.
| Property | Description | Type |
|---|---|---|
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| endpoint | The URI of the replica where the replica API will be available. | string Optional |
| id | The resource ID. | string Optional |
| location | The location of the replica. | string Optional |
| name | The name of the replica. | string Optional |
| provisioningState | The provisioning state of the replica. | ReplicaProperties_ProvisioningState_STATUS Optional |
| systemData | Resource system metadata. | SystemData_STATUS Optional |
| type | The type of the resource. | string Optional |
Snapshot_Spec
Used by: Snapshot.
| Property | Description | Type |
|---|---|---|
| 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. | string Optional |
| 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. |
SnapshotProperties_CompositionType Optional |
| filters | A list of filters used to filter the key-values included in the snapshot. | KeyValueFilter[] Required |
| operatorSpec | The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure | SnapshotOperatorSpec Optional |
| 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 appconfiguration.azure.com/ConfigurationStore resource | genruntime.KnownResourceReference Required |
| retentionPeriod | The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. | int Optional |
| tags | The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags. | map[string]string Optional |
Snapshot_STATUS
Used by: Snapshot.
| Property | Description | 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. |
SnapshotProperties_CompositionType_STATUS Optional |
| conditions | The observed state of the resource | conditions.Condition[] Optional |
| created | The time that the snapshot was created. | string Optional |
| etag | A value representing the current state of the snapshot. | string Optional |
| expires | The time that the snapshot will expire. | string Optional |
| filters | A list of filters used to filter the key-values included in the snapshot. | KeyValueFilter_STATUS[] Optional |
| id | The resource ID. | string Optional |
| itemsCount | The amount of key-values in the snapshot. | int Optional |
| name | The name of the snapshot. | string Optional |
| provisioningState | The provisioning state of the snapshot. | SnapshotProperties_ProvisioningState_STATUS Optional |
| retentionPeriod | The amount of time, in seconds, that a snapshot will remain in the archived state before expiring. This property is only writable during the creation of a snapshot. If not specified, the default lifetime of key-value revisions will be used. | int Optional |
| size | The size in bytes of the snapshot. | int Optional |
| status | The current status of the snapshot. | SnapshotProperties_Status_STATUS Optional |
| tags | The tags of the snapshot. NOTE: These are data plane tags, not Azure Resource Manager (ARM) tags. | map[string]string Optional |
| type | The type of the resource. | string Optional |
ConfigurationStoreOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: ConfigurationStore_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
| secrets | configures where to place Azure generated secrets. | ConfigurationStoreOperatorSecrets Optional |
ConfigurationStoreProperties_CreateMode
Used by: ConfigurationStore_Spec.
| Value | Description |
|---|---|
| “Default” | |
| “Recover” |
ConfigurationStoreProperties_CreateMode_STATUS
Used by: ConfigurationStore_STATUS.
| Value | Description |
|---|---|
| “Default” | |
| “Recover” |
ConfigurationStoreProperties_ProvisioningState_STATUS
Used by: ConfigurationStore_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
ConfigurationStoreProperties_PublicNetworkAccess
Used by: ConfigurationStore_Spec.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
ConfigurationStoreProperties_PublicNetworkAccess_STATUS
Used by: ConfigurationStore_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
DataPlaneProxyProperties
The data plane proxy settings for a configuration store.
Used by: ConfigurationStore_Spec.
| Property | Description | Type |
|---|---|---|
| authenticationMode | The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. | DataPlaneProxyProperties_AuthenticationMode Optional |
| privateLinkDelegation | The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link. | DataPlaneProxyProperties_PrivateLinkDelegation Optional |
DataPlaneProxyProperties_STATUS
The data plane proxy settings for a configuration store.
Used by: ConfigurationStore_STATUS.
| Property | Description | Type |
|---|---|---|
| authenticationMode | The data plane proxy authentication mode. This property manages the authentication mode of request to the data plane resources. | DataPlaneProxyProperties_AuthenticationMode_STATUS Optional |
| privateLinkDelegation | The data plane proxy private link delegation. This property manages if a request from delegated Azure Resource Manager (ARM) private link is allowed when the data plane resource requires private link. | DataPlaneProxyProperties_PrivateLinkDelegation_STATUS Optional |
EncryptionProperties
The encryption settings for a configuration store.
Used by: ConfigurationStore_Spec.
| Property | Description | Type |
|---|---|---|
| keyVaultProperties | Key vault properties. | KeyVaultProperties Optional |
EncryptionProperties_STATUS
The encryption settings for a configuration store.
Used by: ConfigurationStore_STATUS.
| Property | Description | Type |
|---|---|---|
| keyVaultProperties | Key vault properties. | KeyVaultProperties_STATUS Optional |
KeyValueFilter
Enables filtering of key-values.
Used by: Snapshot_Spec.
| Property | Description | Type |
|---|---|---|
| key | Filters key-values by their key field. | string Required |
| label | Filters key-values by their label field. | string Optional |
KeyValueFilter_STATUS
Enables filtering of key-values.
Used by: Snapshot_STATUS.
| Property | Description | Type |
|---|---|---|
| key | Filters key-values by their key field. | string Required |
| label | Filters key-values by their label field. | string Optional |
KeyValueOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: KeyValue_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
PrivateEndpointConnectionReference_STATUS
A reference to a related private endpoint connection.
Used by: ConfigurationStore_STATUS.
| Property | Description | Type |
|---|---|---|
| id | The resource ID. | string Optional |
| name | The name of the resource. | string Optional |
| privateEndpoint | The resource of private endpoint. | PrivateEndpoint_STATUS Optional |
| privateLinkServiceConnectionState | A collection of information about the state of the connection between service consumer and provider. | PrivateLinkServiceConnectionState_STATUS Optional |
| provisioningState | The provisioning status of the private endpoint connection. | PrivateEndpointConnectionProperties_ProvisioningState_STATUS Optional |
| type | The type of the resource. | string Optional |
ReplicaOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Replica_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
ReplicaProperties_ProvisioningState_STATUS
Used by: Replica_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” |
ResourceIdentity
An identity that can be associated with a resource.
Used by: ConfigurationStore_Spec.
| Property | Description | 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. |
ResourceIdentity_Type Optional |
| 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}’. | UserAssignedIdentityDetails[] Optional |
ResourceIdentity_STATUS
An identity that can be associated with a resource.
Used by: ConfigurationStore_STATUS.
| Property | Description | Type |
|---|---|---|
| principalId | The principal id of the identity. This property will only be provided for a system-assigned identity. | string Optional |
| tenantId | The tenant id associated with the resource’s identity. This property will only be provided for a system-assigned identity. | string Optional |
| 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. |
ResourceIdentity_Type_STATUS Optional |
| 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}’. | map[string]UserIdentity_STATUS Optional |
Sku
Describes a configuration store SKU.
Used by: ConfigurationStore_Spec.
| Property | Description | Type |
|---|---|---|
| name | The SKU name of the configuration store. | string Required |
Sku_STATUS
Describes a configuration store SKU.
Used by: ConfigurationStore_STATUS.
| Property | Description | Type |
|---|---|---|
| name | The SKU name of the configuration store. | string Optional |
SnapshotOperatorSpec
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
Used by: Snapshot_Spec.
| Property | Description | Type |
|---|---|---|
| configMapExpressions | configures where to place operator written dynamic ConfigMaps (created with CEL expressions). | core.DestinationExpression[] Optional |
| secretExpressions | configures where to place operator written dynamic secrets (created with CEL expressions). | core.DestinationExpression[] Optional |
SnapshotProperties_CompositionType
Used by: Snapshot_Spec.
| Value | Description |
|---|---|
| “Key” | |
| “Key_Label” |
SnapshotProperties_CompositionType_STATUS
Used by: Snapshot_STATUS.
| Value | Description |
|---|---|
| “Key” | |
| “Key_Label” |
SnapshotProperties_ProvisioningState_STATUS
Used by: Snapshot_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
SnapshotProperties_Status_STATUS
Used by: Snapshot_STATUS.
| Value | Description |
|---|---|
| “Archived” | |
| “Failed” | |
| “Provisioning” | |
| “Ready” |
SystemData_STATUS
Metadata pertaining to creation and last modification of the resource.
Used by: ConfigurationStore_STATUS, and Replica_STATUS.
| Property | Description | Type |
|---|---|---|
| createdAt | The timestamp of resource creation (UTC). | string Optional |
| createdBy | The identity that created the resource. | string Optional |
| createdByType | The type of identity that created the resource. | SystemData_CreatedByType_STATUS Optional |
| lastModifiedAt | The timestamp of resource last modification (UTC) | string Optional |
| lastModifiedBy | The identity that last modified the resource. | string Optional |
| lastModifiedByType | The type of identity that last modified the resource. | SystemData_LastModifiedByType_STATUS Optional |
ConfigurationStoreOperatorSecrets
Used by: ConfigurationStoreOperatorSpec.
| Property | Description | Type |
|---|---|---|
| primaryConnectionString | indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKey | indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryKeyID | indicates where the PrimaryKeyID secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryReadOnlyConnectionString | indicates where the PrimaryReadOnlyConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryReadOnlyKey | indicates where the PrimaryReadOnlyKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| primaryReadOnlyKeyID | indicates where the PrimaryReadOnlyKeyID secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryConnectionString | indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKey | indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryKeyID | indicates where the SecondaryKeyID secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryReadOnlyConnectionString | indicates where the SecondaryReadOnlyConnectionString secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryReadOnlyKey | indicates where the SecondaryReadOnlyKey secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
| secondaryReadOnlyKeyID | indicates where the SecondaryReadOnlyKeyID secret should be placed. If omitted, the secret will not be retrieved from Azure. | genruntime.SecretDestination Optional |
DataPlaneProxyProperties_AuthenticationMode
Used by: DataPlaneProxyProperties.
| Value | Description |
|---|---|
| “Local” | |
| “Pass-through” |
DataPlaneProxyProperties_AuthenticationMode_STATUS
Used by: DataPlaneProxyProperties_STATUS.
| Value | Description |
|---|---|
| “Local” | |
| “Pass-through” |
DataPlaneProxyProperties_PrivateLinkDelegation
Used by: DataPlaneProxyProperties.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
DataPlaneProxyProperties_PrivateLinkDelegation_STATUS
Used by: DataPlaneProxyProperties_STATUS.
| Value | Description |
|---|---|
| “Disabled” | |
| “Enabled” |
KeyVaultProperties
Settings concerning key vault encryption for a configuration store.
Used by: EncryptionProperties.
| Property | Description | Type |
|---|---|---|
| identityClientId | The client id of the identity which will be used to access key vault. | string Optional |
| keyIdentifier | The URI of the key vault key used to encrypt data. | string Optional |
KeyVaultProperties_STATUS
Settings concerning key vault encryption for a configuration store.
Used by: EncryptionProperties_STATUS.
| Property | Description | Type |
|---|---|---|
| identityClientId | The client id of the identity which will be used to access key vault. | string Optional |
| keyIdentifier | The URI of the key vault key used to encrypt data. | string Optional |
PrivateEndpoint_STATUS
Private endpoint which a connection belongs to.
Used by: PrivateEndpointConnectionReference_STATUS.
| Property | Description | Type |
|---|---|---|
| id | The resource Id for private endpoint | string Optional |
PrivateEndpointConnectionProperties_ProvisioningState_STATUS
Used by: PrivateEndpointConnectionReference_STATUS.
| Value | Description |
|---|---|
| “Canceled” | |
| “Creating” | |
| “Deleting” | |
| “Failed” | |
| “Succeeded” | |
| “Updating” |
PrivateLinkServiceConnectionState_STATUS
The state of a private link service connection.
Used by: PrivateEndpointConnectionReference_STATUS.
| Property | Description | Type |
|---|---|---|
| actionsRequired | Any action that is required beyond basic workflow (approve/ reject/ disconnect) | PrivateLinkServiceConnectionState_ActionsRequired_STATUS Optional |
| description | The private link service connection description. | string Optional |
| status | The private link service connection status. | PrivateLinkServiceConnectionState_Status_STATUS Optional |
ResourceIdentity_Type
Used by: ResourceIdentity.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
ResourceIdentity_Type_STATUS
Used by: ResourceIdentity_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “SystemAssigned” | |
| “SystemAssigned, UserAssigned” | |
| “UserAssigned” |
SystemData_CreatedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
SystemData_LastModifiedByType_STATUS
Used by: SystemData_STATUS.
| Value | Description |
|---|---|
| “Application” | |
| “Key” | |
| “ManagedIdentity” | |
| “User” |
UserAssignedIdentityDetails
Information about the user assigned identity for the resource
Used by: ResourceIdentity.
| Property | Description | Type |
|---|---|---|
| reference | genruntime.ResourceReference Optional |
UserIdentity_STATUS
A resource identity that is managed by the user of the service.
Used by: ResourceIdentity_STATUS.
| Property | Description | Type |
|---|---|---|
| clientId | The client ID of the user-assigned identity. | string Optional |
| principalId | The principal ID of the user-assigned identity. | string Optional |
PrivateLinkServiceConnectionState_ActionsRequired_STATUS
Used by: PrivateLinkServiceConnectionState_STATUS.
| Value | Description |
|---|---|
| “None” | |
| “Recreate” |
PrivateLinkServiceConnectionState_Status_STATUS
Used by: PrivateLinkServiceConnectionState_STATUS.
| Value | Description |
|---|---|
| “Approved” | |
| “Disconnected” | |
| “Pending” | |
| “Rejected” |