Skip to content

AAD sample and README revised, and correct indentation #7074

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mssfang merged 6 commits into from
Jan 3, 2020
Merged

AAD sample and README revised, and correct indentation #7074

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f3e2f66
revised aad sample and readme
Jan 1, 2020
27b1143
indentation
Jan 2, 2020
f4a1b19
add ReadmeSamples and update readme automatically
Jan 3, 2020
5661c8f
Merge branch 'master' of https://github.com/Azure/azure-sdk-for-java …
Jan 3, 2020
9da9b5a
fixes spotbugs
Jan 3, 2020
df123e8
try catch final revised
Jan 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 61 additions & 10 deletions sdk/appconfiguration/azure-data-appconfiguration/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,9 @@ az appconfig create --name <config-store-name> --resource-group <resource-group-

In order to interact with the App Configuration service you'll need to create an instance of the Configuration Client class. To make this possible you'll need the connection string of the Configuration Store.

#### Get credentials
#### Use connection string

##### Get credentials

Use the [Azure CLI][azure_cli] snippet below to get the connection string from the Configuration Store.

Expand All @@ -117,7 +119,7 @@ az appconfig credential list --name <config-store-name>

Alternatively, get the connection string from the Azure Portal.

#### Create a Configuration Client
##### Create a Configuration Client

Once you have the value of the connection string you can create the configuration client:

Expand All @@ -135,14 +137,60 @@ ConfigurationAsyncClient client = new ConfigurationClientBuilder()
.buildAsyncClient();
```

You can also use `TokenCredential` to create a configuration client, such as an Azure Active Directory (AAD) token.
Unlike a connection string if you're using an AAD token you must supply the endpoint of AppConfiguration service. The
endpoint can be obtained by going to your App Configuration instance in the Azure portal and navigating to "Overview"
page and look for the "Endpoint" keyword.
#### Use AAD token

Here we demonstrate using [DefaultAzureCredential][default_cred_ref]
to authenticate as a service principal. However, the configuration client
accepts any [azure-identity][azure_identity] credential. See the
[azure-identity][azure_identity] documentation for more information about other
credentials.

##### Create a service principal (optional)
This [Azure CLI][azure_cli] snippet shows how to create a
new service principal. Before using it, replace "your-application-name" with
the appropriate name for your service principal.

Create a service principal:
```Bash
az ad sp create-for-rbac --name http://my-application --skip-assignment
```

> Output:
> ```json
> {
> "appId": "generated app id",
> "displayName": "my-application",
> "name": "http://my-application",
> "password": "random password",
> "tenant": "tenant id"
> }
> ```

Use the output to set **AZURE_CLIENT_ID** ("appId" above), **AZURE_CLIENT_SECRET**
("password" above) and **AZURE_TENANT_ID** ("tenant" above) environment variables.
The following example shows a way to do this in Bash:
```Bash
export AZURE_CLIENT_ID="generated app id"
export AZURE_CLIENT_SECRET="random password"
export AZURE_TENANT_ID="tenant id"
```

Assign one of the applicable [App Configuration roles][app_config_role] to the service principal.

##### Create a client
Once the **AZURE_CLIENT_ID**, **AZURE_CLIENT_SECRET** and
**AZURE_TENANT_ID** environment variables are set,
[DefaultAzureCredential][default_cred_ref] will be able to authenticate the
configuration client.

Constructing the client also requires your configuration store's URL, which you can
get from the Azure CLI or the Azure Portal. In the Azure Portal, the URL can be found listed as the service "Endpoint"

```Java
// An example of using TokenCredential and Endpoint to create a synchronous client
TokenCredential credential = new DefaultAzureCredential();
import com.azure.identity.DefaultAzureCredential;
Copy link
Member

@srnagar srnagar Jan 2, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Prefer to use code embedding for READMEs.

Copy link
Contributor Author

@mssfang mssfang Jan 3, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated.

import com.azure.identity.DefaultAzureCredentialBuilder;

DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();

ConfigurationClient client = new ConfigurationClientBuilder()
.credential(credential)
Expand Down Expand Up @@ -337,23 +385,26 @@ When you submit a pull request, a CLA-bot will automatically determine whether y
This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For more information see the [Code of Conduct FAQ][coc_faq] or contact [[email protected]][coc_contact] with any additional questions or comments.

<!-- LINKS -->
[add_headers_from_context_policy]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core/src/main/java/com/azure/core/http/policy/AddHeadersFromContextPolicy.java
[api_documentation]: https://aka.ms/java-docs
[app_config_store]: https://docs.microsoft.com/azure/azure-app-configuration/quickstart-dotnet-core-app#create-an-app-configuration-store
[app_config_role]: https://github.com/Azure/AppConfiguration/blob/master/docs/REST/authorization/aad.md
[azconfig_docs]: https://docs.microsoft.com/azure/azure-app-configuration
[azure_cli]: https://docs.microsoft.com/cli/azure
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/tree/master/sdk/identity/azure-identity
[azure_subscription]: https://azure.microsoft.com/free
[cla]: https://cla.microsoft.com
[coc]: https://opensource.microsoft.com/codeofconduct/
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
[coc_contact]: mailto:[email protected]
[default_cred_ref]: https://azuresdkdocs.blob.core.windows.net/$web/java/azure-identity/1.0.1/com/azure/identity/DefaultAzureCredential.html
[maven]: https://maven.apache.org/
[package]: https://search.maven.org/artifact/com.azure/azure-data-appconfiguration
[performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning
[rest_api]: https://github.com/Azure/AppConfiguration#rest-api-reference
[samples]: src/samples/java/com/azure/data/appconfiguration
[samples_readme]: src/samples/README.md
[source_code]: src
[spring_quickstart]: https://docs.microsoft.com/azure/azure-app-configuration/quickstart-java-spring-app
[performance_tuning]: https://github.com/Azure/azure-sdk-for-java/wiki/Performance-Tuning
[add_headers_from_context_policy]: https://github.com/Azure/azure-sdk-for-java/blob/master/sdk/core/azure-core/src/main/java/com/azure/core/http/policy/AddHeadersFromContextPolicy.java

![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-java%2Fsdk%2Fappconfiguration%2Fazure-data-appconfiguration%2FREADME.png)
19 changes: 8 additions & 11 deletions ...configuration/src/main/java/com/azure/data/appconfiguration/ConfigurationAsyncClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ public Mono<ConfigurationSetting> setConfigurationSetting(String key, String lab
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<ConfigurationSetting>> setConfigurationSettingWithResponse(ConfigurationSetting setting,
boolean ifUnchanged) {
boolean ifUnchanged) {
try {
return withContext(context -> setConfigurationSetting(setting, ifUnchanged, context));
} catch (RuntimeException ex) {
Expand All @@ -223,7 +223,7 @@ public Mono<Response<ConfigurationSetting>> setConfigurationSettingWithResponse(
}

Mono<Response<ConfigurationSetting>> setConfigurationSetting(ConfigurationSetting setting, boolean ifUnchanged,
Context context) {
Context context) {
// Validate that setting and key is not null. The key is used in the service URL so it cannot be null.
validateSetting(setting);

Expand Down Expand Up @@ -324,8 +324,7 @@ public Mono<ConfigurationSetting> getConfigurationSetting(String key, String lab
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<ConfigurationSetting>> getConfigurationSettingWithResponse(ConfigurationSetting setting,
OffsetDateTime acceptDateTime,
boolean ifChanged) {
OffsetDateTime acceptDateTime, boolean ifChanged) {
try {
return withContext(context -> getConfigurationSetting(setting, acceptDateTime, ifChanged, context));
} catch (RuntimeException ex) {
Expand All @@ -334,9 +333,7 @@ public Mono<Response<ConfigurationSetting>> getConfigurationSettingWithResponse(
}

Mono<Response<ConfigurationSetting>> getConfigurationSetting(ConfigurationSetting setting,
OffsetDateTime acceptDateTime,
boolean onlyIfChanged,
Context context) {
OffsetDateTime acceptDateTime, boolean onlyIfChanged, Context context) {
// Validate that setting and key is not null. The key is used in the service URL so it cannot be null.
validateSetting(setting);

Expand Down Expand Up @@ -419,7 +416,7 @@ public Mono<ConfigurationSetting> deleteConfigurationSetting(String key, String
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<ConfigurationSetting>> deleteConfigurationSettingWithResponse(ConfigurationSetting setting,
boolean ifUnchanged) {
boolean ifUnchanged) {
try {
return withContext(context -> deleteConfigurationSetting(setting, ifUnchanged, context));
} catch (RuntimeException ex) {
Expand All @@ -428,7 +425,7 @@ public Mono<Response<ConfigurationSetting>> deleteConfigurationSettingWithRespon
}

Mono<Response<ConfigurationSetting>> deleteConfigurationSetting(ConfigurationSetting setting, boolean ifUnchanged,
Context context) {
Context context) {
// Validate that setting and key is not null. The key is used in the service URL so it cannot be null.
validateSetting(setting);
final String ifMatchETag = ifUnchanged ? getETagValue(setting.getETag()) : null;
Expand Down Expand Up @@ -498,7 +495,7 @@ public Mono<ConfigurationSetting> setReadOnly(String key, String label, boolean
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<ConfigurationSetting>> setReadOnlyWithResponse(ConfigurationSetting setting,
boolean isReadOnly) {
boolean isReadOnly) {
try {
return withContext(context -> setReadOnly(setting, isReadOnly, context));
} catch (RuntimeException ex) {
Expand All @@ -507,7 +504,7 @@ public Mono<Response<ConfigurationSetting>> setReadOnlyWithResponse(Configuratio
}

Mono<Response<ConfigurationSetting>> setReadOnly(ConfigurationSetting setting, boolean isReadOnly,
Context context) {
Context context) {
// Validate that setting and key is not null. The key is used in the service URL so it cannot be null.
validateSetting(setting);

Expand Down
12 changes: 8 additions & 4 deletions ...-appconfiguration/src/samples/java/com/azure/data/appconfiguration/AadAuthentication.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

package com.azure.data.appconfiguration;

import com.azure.core.credential.TokenCredential;
import com.azure.data.appconfiguration.models.ConfigurationSetting;
import com.azure.identity.DefaultAzureCredential;
import com.azure.identity.DefaultAzureCredentialBuilder;

/**
Expand All @@ -21,9 +21,13 @@ public static void main(String[] args) {
// and navigating to "Overview" page. Looking for the "Endpoint" keyword.
String endpoint = "{endpoint_value}";

// Token Credential could be an AAD token which you can get from Identity
// or other service authentication service.
TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();
// Default token credential could be obtained from Identity service.
// It tries to create a valid credential in the following order:
// EnvironmentCredential
// ManagedIdentityCredential
// SharedTokenCacheCredential
// Fails if none of the credentials above could be created.
DefaultAzureCredential tokenCredential = new DefaultAzureCredentialBuilder().build();

final ConfigurationClient client = new ConfigurationClientBuilder()
.credential(tokenCredential) // AAD authentication
Expand Down