add content to resource and spring-data

This commit is contained in:
zhihaoguo 2021-11-21 20:42:46 +08:00
Родитель db0d84e248
Коммит 94d3108529
2 изменённых файлов: 104 добавлений и 4 удалений

Просмотреть файл

@ -1,11 +1,68 @@
== Resource Handling
Connect to Azure Storage using Spring Resource abstraction and Azure Storage libraries.
=== Dependency Setup
[source,xml]
----
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-storage-blob</artifactId>
</dependency>
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-storage-file-share</artifactId>
</dependency>
----
=== Configuration
for full configurations, check appendix
This `spring-cloud-azure-starter-storage-blob` provides the following properties:
|===
|Name | Default | Description
|spring.cloud.azure.storage.blob.enabled | `true` | Whether an Azure Blob Storage Service is enabled
|spring.cloud.azure.storage.blob.endpoint | | Uri to connect Azure Blob Storage
|spring.cloud.azure.storage.blob.account-key | | Privatekey to connect Azure Blob Storage
|spring.cloud.azure.storage.blob.account-name | | Azure Storage Account Name
|===
This `spring-cloud-azure-starter-storage-file-share` provides the following properties:
|===
|Name | Default | Description
|spring.cloud.azure.storage.fileshare.enabled | `true` | Whether Azure File Storage Service is enabled
|spring.cloud.azure.storage.fileshare.endpoint | | Uri to connect Azure File Storage
|spring.cloud.azure.storage.fileshare.account-key | | Privatekey to connect Azure File Storage
|spring.cloud.azure.storage.fileshare.account-name | | Azure Storage Account Name
|===
=== Basic Usage
Provide the properties below in your configuration file.
[source,yaml]
----
spring:
cloud:
azure:
storage:
blob:
account-name: ${STORAGE-ACCOUNT-NAME}
account-key: ${STORAGE-ACCOUNT-PRIVATE-KEY}
endpoint: ${STORAGE-BLOB-ENDPOINT}
fileshare:
account-name: ${STORAGE-ACCOUNT-NAME}
account-key: ${STORAGE-ACCOUNT-PRIVATE-KEY}
endpoint: ${STORAGE-FILESHARE-ENDPOINT}
----
=== Samples
A link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_4.0/storage/spring-cloud-azure-starter-storage-blob/storage-blob-sample[storage-blob-sample] and link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_4.0/storage/spring-cloud-azure-starter-storage-file-share/storage-file-sample[storage-file-sample] are provided to show how to use the `spring-cloud-azure-starter-storage-blob` and `spring-cloud-azure-starter-storage-file-share`.

Просмотреть файл

@ -1,15 +1,58 @@
== Spring Data Support
=== Cosmos DB
=== Cosmos DB Support
brief introduction of the project
[Azure Cosmos DB](https://azure.microsoft.com/services/cosmos-db/) is a globally-distributed database service that allows developers to work with data using a variety of standard APIs, such as SQL, MongoDB, Graph, and Azure Table storage.
Connect to Cosmos DB using Spring Data and CosmosDB libraries.
=== Dependency Setup
[source,xml]
----
<dependency>
<groupId>com.azure.spring</groupId>
<artifactId>spring-cloud-azure-starter-data-cosmos</artifactId>
</dependency>
----
=== Configuration
for full configurations, check appendix
This Spring Cloud Azure Starter provides the following properties:
|===
|Name | Default | Description
|spring.cloud.azure.cosmos.enabled | `true` | Whether Azure Cosmos Service is enabled.
|spring.cloud.azure.cosmos.database | |
|spring.cloud.azure.cosmos.endpoint | | Uri to connect CosmosDB
|spring.cloud.azure.cosmos.key | | PrivateKey to connect CosmosDB
|spring.cloud.azure.cosmos.credential.client-certificate-password | | Password of the certificate file.
|spring.cloud.azure.cosmos.credential.client-certificate-path | | Path of a PEM certificate file to use when performing service principal authentication with Azure.
|spring.cloud.azure.cosmos.credential.client-id | | Client id to use when performing service principal authentication with Azure.
|spring.cloud.azure.cosmos.credential.client-secret | | Client secret to use when performing service principal authentication with Azure.
|spring.cloud.azure.cosmos.credential.managed-identity-client-id | | Client id to use when using managed identity to authenticate with Azure.
|spring.cloud.azure.cosmos.credential.password | | Password to use when performing username/password authentication with Azure.
|spring.cloud.azure.cosmos.credential.username | | Username to use when performing username/password authentication with Azure.
|spring.cloud.azure.cosmos.populate-query-metrics | `false` | Populate Diagnostics Strings and Query metrics
|===
=== Basic Usage
Add below properties and you are good to go.
[source,yaml]
----
spring:
cloud:
azure:
cosmos:
key: ${YOUR_COSMOS_KEY}
endpoint: [YOUR_COSMOS_ENDPOINT]
database: [YOUR_COSMOS_DATABASE]
----
=== Samples
Please refer to link:https://github.com/Azure-Samples/azure-spring-boot-samples/tree/spring-cloud-azure_4.0/cosmos/spring-cloud-azure-starter-data-cosmos[samples for Azure Spring Data Cosmos] for more details.