Skip to content
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.

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

[AutoPR azure-resourcemanager-appconfiguration] [WIP] Appconfig scenarios #3110

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Release History

## 1.0.0-beta.7 (Unreleased)
## 1.0.0-beta.1 (2022-12-20)

- Azure Resource Manager AppConfiguration client library for Java. This package contains Microsoft Azure SDK for AppConfiguration Management SDK. Package tag package-2022-05-01. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt).

### Features Added

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Various documentation is available to help you get started
<dependency>
<groupId>com.azure.resourcemanager</groupId>
<artifactId>azure-resourcemanager-appconfiguration</artifactId>
<version>1.0.0-beta.6</version>
<version>1.0.0-beta.7</version>
</dependency>
```
[//]: # ({x-version-update-end})
Expand All @@ -41,19 +41,19 @@ Various documentation is available to help you get started

Azure Management Libraries require a `TokenCredential` implementation for authentication and an `HttpClient` implementation for HTTP client.

[Azure Identity][azure_identity] package and [Azure Core Netty HTTP][azure_core_http_netty] package provide the default implementation.
[Azure Identity][azure_identity] and [Azure Core Netty HTTP][azure_core_http_netty] packages provide the default implementation.

### Authentication

By default, Azure Active Directory token authentication depends on correct configure of following environment variables.
By default, Azure Active Directory token authentication depends on correct configuration of the following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` or `AZURE_CLIENT_CERTIFICATE_PATH` for client secret or client certificate.

In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
In addition, Azure subscription ID can be configured via `AZURE_SUBSCRIPTION_ID` environment variable.

With above configuration, `azure` client can be authenticated by following code:
With above configuration, `azure` client can be authenticated using the following code:

```java
AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
Expand Down Expand Up @@ -83,13 +83,13 @@ See [API design][design] for general introduction on design and key concepts on

## Contributing

For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md).
For details on contributing to this repository, see the [contributing guide][cg].

1. Fork it
1. Create your feature branch (`git checkout -b my-new-feature`)
1. Commit your changes (`git commit -am 'Add some feature'`)
1. Push to the branch (`git push origin my-new-feature`)
1. Create new Pull Request
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit <https://cla.microsoft.com>.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

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]> with any additional questions or comments.

<!-- LINKS -->
[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS
Expand All @@ -100,3 +100,6 @@ For details on contributing to this repository, see the [contributing guide](htt
[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core-http-netty
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/AUTH.md
[design]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/DESIGN.md
[cg]: https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md
[coc]: https://opensource.microsoft.com/codeofconduct/
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ public AppConfigurationManager authenticate(TokenCredential credential, AzurePro
.append("-")
.append("com.azure.resourcemanager.appconfiguration")
.append("/")
.append("1.0.0-beta.6");
.append("1.0.0-beta.1");
if (!Configuration.getGlobalConfiguration().get("AZURE_TELEMETRY_DISABLED", false)) {
userAgentBuilder
.append(" (")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,28 +78,28 @@ PagedIterable<ConfigurationStoreInner> listByResourceGroup(
*
* @param resourceGroupName The name of the resource group to which the container registry belongs.
* @param configStoreName The name of the configuration store.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the properties of the specified configuration store.
* @return the properties of the specified configuration store along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ConfigurationStoreInner getByResourceGroup(String resourceGroupName, String configStoreName);
Response<ConfigurationStoreInner> getByResourceGroupWithResponse(
String resourceGroupName, String configStoreName, Context context);

/**
* Gets the properties of the specified configuration store.
*
* @param resourceGroupName The name of the resource group to which the container registry belongs.
* @param configStoreName The name of the configuration store.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the properties of the specified configuration store along with {@link Response}.
* @return the properties of the specified configuration store.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response<ConfigurationStoreInner> getByResourceGroupWithResponse(
String resourceGroupName, String configStoreName, Context context);
ConfigurationStoreInner getByResourceGroup(String resourceGroupName, String configStoreName);

/**
* Creates a configuration store with the specified parameters.
Expand Down Expand Up @@ -330,33 +330,33 @@ PagedIterable<ApiKeyInner> listKeys(
* @param resourceGroupName The name of the resource group to which the container registry belongs.
* @param configStoreName The name of the configuration store.
* @param regenerateKeyParameters The parameters for regenerating an access key.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return an API key used for authenticating with a configuration store endpoint.
* @return an API key used for authenticating with a configuration store endpoint along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
ApiKeyInner regenerateKey(
String resourceGroupName, String configStoreName, RegenerateKeyParameters regenerateKeyParameters);
Response<ApiKeyInner> regenerateKeyWithResponse(
String resourceGroupName,
String configStoreName,
RegenerateKeyParameters regenerateKeyParameters,
Context context);

/**
* Regenerates an access key for the specified configuration store.
*
* @param resourceGroupName The name of the resource group to which the container registry belongs.
* @param configStoreName The name of the configuration store.
* @param regenerateKeyParameters The parameters for regenerating an access key.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return an API key used for authenticating with a configuration store endpoint along with {@link Response}.
* @return an API key used for authenticating with a configuration store endpoint.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response<ApiKeyInner> regenerateKeyWithResponse(
String resourceGroupName,
String configStoreName,
RegenerateKeyParameters regenerateKeyParameters,
Context context);
ApiKeyInner regenerateKey(
String resourceGroupName, String configStoreName, RegenerateKeyParameters regenerateKeyParameters);

/**
* Gets information about the deleted configuration stores in a subscription.
Expand Down Expand Up @@ -387,28 +387,28 @@ Response<ApiKeyInner> regenerateKeyWithResponse(
*
* @param location The location in which uniqueness will be verified.
* @param configStoreName The name of the configuration store.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a deleted Azure app configuration store.
* @return a deleted Azure app configuration store along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
DeletedConfigurationStoreInner getDeleted(String location, String configStoreName);
Response<DeletedConfigurationStoreInner> getDeletedWithResponse(
String location, String configStoreName, Context context);

/**
* Gets a deleted Azure app configuration store.
*
* @param location The location in which uniqueness will be verified.
* @param configStoreName The name of the configuration store.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return a deleted Azure app configuration store along with {@link Response}.
* @return a deleted Azure app configuration store.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response<DeletedConfigurationStoreInner> getDeletedWithResponse(
String location, String configStoreName, Context context);
DeletedConfigurationStoreInner getDeleted(String location, String configStoreName);

/**
* Permanently deletes the specified configuration store.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,13 +53,15 @@ PagedIterable<KeyValueInner> listByConfigurationStore(
* @param configStoreName The name of the configuration store.
* @param keyValueName Identifier of key and label combination. Key and label are joined by $ character. Label is
* optional.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the properties of the specified key-value.
* @return the properties of the specified key-value along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
KeyValueInner get(String resourceGroupName, String configStoreName, String keyValueName);
Response<KeyValueInner> getWithResponse(
String resourceGroupName, String configStoreName, String keyValueName, Context context);

/**
* Gets the properties of the specified key-value.
Expand All @@ -68,15 +70,13 @@ PagedIterable<KeyValueInner> listByConfigurationStore(
* @param configStoreName The name of the configuration store.
* @param keyValueName Identifier of key and label combination. Key and label are joined by $ character. Label is
* optional.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the properties of the specified key-value along with {@link Response}.
* @return the properties of the specified key-value.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response<KeyValueInner> getWithResponse(
String resourceGroupName, String configStoreName, String keyValueName, Context context);
KeyValueInner get(String resourceGroupName, String configStoreName, String keyValueName);

/**
* Creates a key-value.
Expand All @@ -85,13 +85,20 @@ Response<KeyValueInner> getWithResponse(
* @param configStoreName The name of the configuration store.
* @param keyValueName Identifier of key and label combination. Key and label are joined by $ character. Label is
* optional.
* @param keyValueParameters The parameters for creating a key-value.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the key-value resource along with all resource properties.
* @return the key-value resource along with all resource properties along with {@link Response}.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
KeyValueInner createOrUpdate(String resourceGroupName, String configStoreName, String keyValueName);
Response<KeyValueInner> createOrUpdateWithResponse(
String resourceGroupName,
String configStoreName,
String keyValueName,
KeyValueInner keyValueParameters,
Context context);

/**
* Creates a key-value.
Expand All @@ -100,20 +107,13 @@ Response<KeyValueInner> getWithResponse(
* @param configStoreName The name of the configuration store.
* @param keyValueName Identifier of key and label combination. Key and label are joined by $ character. Label is
* optional.
* @param keyValueParameters The parameters for creating a key-value.
* @param context The context to associate with this operation.
* @throws IllegalArgumentException thrown if parameters fail the validation.
* @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
* @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
* @return the key-value resource along with all resource properties along with {@link Response}.
* @return the key-value resource along with all resource properties.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
Response<KeyValueInner> createOrUpdateWithResponse(
String resourceGroupName,
String configStoreName,
String keyValueName,
KeyValueInner keyValueParameters,
Context context);
KeyValueInner createOrUpdate(String resourceGroupName, String configStoreName, String keyValueName);

/**
* Deletes a key-value.
Expand Down
Loading