dapr
/
docs
mirror of https://github.com/dapr/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Updated azure app config metadata fields name (#2830) 

* Updated azure app config metadata fields name

Signed-off-by: Pravin Pushkar <ppushkar@microsoft.com>

* Updating index for configuration store

Signed-off-by: Pravin Pushkar <ppushkar@microsoft.com>

Signed-off-by: Pravin Pushkar <ppushkar@microsoft.com>
This commit is contained in:
Pravin Pushkar 2022-09-28 03:27:02 +05:30 committed by GitHub
parent 68c928ffb9
commit 9c3b7dbc46
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
daprdocs/content/en/reference/components-reference/supported-configuration-stores/azure-appconfig-configuration-store.md
View File

@ -20,11 +20,9 @@ spec:
type: configuration.azure.appconfig
version: v1
metadata:
- name: appConfigHost # appConfigHost should be used when
# Azure Authentication mechanism is used.
- name: host # host should be used when Azure Authentication mechanism is used.
value: <HOST>
- name: appConfigConnectionString # appConfigConnectionString should not be used when
# Azure Authentication mechanism is used.
- name: connectionString # connectionString should not be used when Azure Authentication mechanism is used.
value: <CONNECTIONSTRING>
- name: maxRetries
value: # Optional
@ -41,6 +39,8 @@ spec:
value: "[your_service_principal_app_id]"
- name: azureCertificateFile # Optional
value : "[pfx_certificate_file_fully_qualified_local_path]"
- name: subscribePollInterval # Optional
value: #Optional [Expected format example - 1s|1m|1h]
```
@ -52,13 +52,14 @@ The above example uses secrets as plain strings. It is recommended to use a secr
| Field | Required | Details | Example |
|----------------------------|:--------:|---------|---------|
| appConfigConnectionString | Y* | Connection String for the Azure App Configuration instance. No Default. Can be `secretKeyRef` to use a secret reference. *Mutally exclusive with appConfigHost field. *Not to be used when [Azure Authentication](https://docs.dapr.io/developing-applications/integrations/azure/authenticating-azure/) is used | `Endpoint=https://foo.azconfig.io;Id=osOX-l9-s0:sig;Secret=00000000000000000000000000000000000000000000`
| appConfigHost | N* | Endpoint for the Azure App Configuration instance. No Default. *Mutally exclusive with appConfigConnectionString field. *To be used when [Azure Authentication](https://docs.dapr.io/developing-applications/integrations/azure/authenticating-azure/) is used | `https://dapr.azconfig.io`
| connectionString | Y* | Connection String for the Azure App Configuration instance. No Default. Can be `secretKeyRef` to use a secret reference. *Mutally exclusive with host field. *Not to be used when [Azure Authentication](https://docs.dapr.io/developing-applications/integrations/azure/authenticating-azure/) is used | `Endpoint=https://foo.azconfig.io;Id=osOX-l9-s0:sig;Secret=00000000000000000000000000000000000000000000`
| host | N* | Endpoint for the Azure App Configuration instance. No Default. *Mutally exclusive with connectionString field. *To be used when [Azure Authentication](https://docs.dapr.io/developing-applications/integrations/azure/authenticating-azure/) is used | `https://dapr.azconfig.io`
| maxRetries | N | Maximum number of retries before giving up. Defaults to `3` | `5`, `10`
| retryDelay | N | RetryDelay specifies the initial amount of delay to use before retrying an operation. The delay increases exponentially with each retry up to the maximum specified by MaxRetryDelay. Defaults to `4` seconds; `"-1"` disables delay between retries. | `4000000000`
| maxRetryDelay | N | MaxRetryDelay specifies the maximum delay allowed before retrying an operation. Typically the value is greater than or equal to the value specified in RetryDelay. Defaults to `120` seconds; `"-1"` disables the limit | `120000000000`
| subscribePollInterval | N | subscribePollInterval specifies the poll interval for polling the subscribed keys for any changes. Default polling interval is set to `24` hours.
**Note**: either `appConfigHost` or `appConfigConnectionString` must be specified.
**Note**: either `host` or `connectionString` must be specified.
## Authenticating with Connection String
@ -82,7 +83,7 @@ You need an Azure subscription to set up Azure App Configuration.
- For your connection string: navigate to **Settings** > **Access Keys** and copy your Connection string.
1. Add your host or your connection string to an `azappconfig.yaml` file that Dapr can apply.
Set the `appConfigHost` key to `[Endpoint]` or the `appConfigConnectionString` key to the values you saved earlier.
Set the `host` key to `[Endpoint]` or the `connectionString` key to the values you saved earlier.
{{% alert title="Note" color="primary" %}}
In a production-grade application, follow [the secret management]({{< ref component-secrets.md >}}) instructions to securely manage your secrets.

5
daprdocs/data/components/configuration_stores/generic.yaml
View File

@ -3,3 +3,8 @@
state: Alpha
version: v1
since: "1.5"
- component: Azure App Configuration
link: azure-appconfig-configuration-store
state: Alpha
version: v1
since: "1.9"