forked from Azure/azure-sdk-for-java
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CodeGen from PR 17105 in Azure/azure-rest-api-specs
Merge 7d3b84b656a627f225244453ddd53942addb2898 into 7206f4dbff3a878e33d9a3f87106f4743402ecdd
- Loading branch information
SDKAuto
committed
Dec 22, 2021
1 parent
4c676a2
commit 0cb2ca3
Showing
59 changed files
with
5,989 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Release History | ||
|
||
## 1.0.0-beta.1 (2021-12-22) | ||
|
||
- Azure Resource Manager oep client library for Java. This package contains Microsoft Azure SDK for oep Management SDK. Open Energy Platform Management Service APIs. Package tag package-2021-06-01-preview. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
# Azure Resource Manager oep client library for Java | ||
|
||
Azure Resource Manager oep client library for Java. | ||
|
||
This package contains Microsoft Azure SDK for oep Management SDK. Open Energy Platform Management Service APIs. Package tag package-2021-06-01-preview. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt). | ||
|
||
## We'd love to hear your feedback | ||
|
||
We're always working on improving our products and the way we communicate with our users. So we'd love to learn what's working and how we can do better. | ||
|
||
If you haven't already, please take a few minutes to [complete this short survey][survey] we have put together. | ||
|
||
Thank you in advance for your collaboration. We really appreciate your time! | ||
|
||
## Documentation | ||
|
||
Various documentation is available to help you get started | ||
|
||
- [API reference documentation][docs] | ||
|
||
## Getting started | ||
|
||
### Prerequisites | ||
|
||
- [Java Development Kit (JDK)][jdk] with version 8 or above | ||
- [Azure Subscription][azure_subscription] | ||
|
||
### Adding the package to your product | ||
|
||
[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager-oep;current}) | ||
```xml | ||
<dependency> | ||
<groupId>com.azure.resourcemanager</groupId> | ||
<artifactId>azure-resourcemanager-oep</artifactId> | ||
<version>1.0.0-beta.1</version> | ||
</dependency> | ||
``` | ||
[//]: # ({x-version-update-end}) | ||
|
||
### Include the recommended packages | ||
|
||
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. | ||
|
||
### Authentication | ||
|
||
By default, Azure Active Directory token authentication depends on correct configure of 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`. | ||
|
||
With above configuration, `azure` client can be authenticated by following code: | ||
|
||
```java | ||
AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE); | ||
TokenCredential credential = new DefaultAzureCredentialBuilder() | ||
.authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint()) | ||
.build(); | ||
OepManager manager = OepManager | ||
.authenticate(credential, profile); | ||
``` | ||
|
||
The sample code assumes global Azure. Please change `AzureEnvironment.AZURE` variable if otherwise. | ||
|
||
See [Authentication][authenticate] for more options. | ||
|
||
## Key concepts | ||
|
||
See [API design][design] for general introduction on design and key concepts on Azure Management Libraries. | ||
|
||
## Examples | ||
|
||
[Code snippets and samples](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/oep/azure-resourcemanager-oep/SAMPLE.md) | ||
|
||
|
||
## Troubleshooting | ||
|
||
## Next steps | ||
|
||
## Contributing | ||
|
||
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md). | ||
|
||
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 | ||
|
||
<!-- LINKS --> | ||
[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS | ||
[docs]: https://azure.github.io/azure-sdk-for-java/ | ||
[jdk]: https://docs.microsoft.com/java/azure/jdk/ | ||
[azure_subscription]: https://azure.microsoft.com/free/ | ||
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity | ||
[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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,203 @@ | ||
# Code snippets and samples | ||
|
||
|
||
## EnergyServices | ||
|
||
- [Create](#energyservices_create) | ||
- [Delete](#energyservices_delete) | ||
- [GetByResourceGroup](#energyservices_getbyresourcegroup) | ||
- [List](#energyservices_list) | ||
- [ListByResourceGroup](#energyservices_listbyresourcegroup) | ||
- [Update](#energyservices_update) | ||
|
||
## Locations | ||
|
||
- [CheckNameAvailability](#locations_checknameavailability) | ||
|
||
## Operations | ||
|
||
- [List](#operations_list) | ||
### EnergyServices_Create | ||
|
||
```java | ||
/** Samples for EnergyServices Create. */ | ||
public final class EnergyServicesCreateSamples { | ||
/* | ||
* x-ms-original-file: specification/oep/resource-manager/Microsoft.OpenEnergyPlatform/preview/2021-06-01-preview/examples/OepResource_Create.json | ||
*/ | ||
/** | ||
* Sample code: OepResource_Create. | ||
* | ||
* @param manager Entry point to OepManager. | ||
*/ | ||
public static void oepResourceCreate(com.azure.resourcemanager.oep.OepManager manager) { | ||
manager | ||
.energyServices() | ||
.define("DummyResourceName") | ||
.withRegion((String) null) | ||
.withExistingResourceGroup("DummyResourceGroupName") | ||
.create(); | ||
} | ||
} | ||
``` | ||
|
||
### EnergyServices_Delete | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for EnergyServices Delete. */ | ||
public final class EnergyServicesDeleteSamples { | ||
/* | ||
* x-ms-original-file: specification/oep/resource-manager/Microsoft.OpenEnergyPlatform/preview/2021-06-01-preview/examples/OepResource_Delete.json | ||
*/ | ||
/** | ||
* Sample code: OepResource_Delete. | ||
* | ||
* @param manager Entry point to OepManager. | ||
*/ | ||
public static void oepResourceDelete(com.azure.resourcemanager.oep.OepManager manager) { | ||
manager.energyServices().delete("DummyResourceGroupName", "DummyResourceName", Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### EnergyServices_GetByResourceGroup | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for EnergyServices GetByResourceGroup. */ | ||
public final class EnergyServicesGetByResourceGroupSamples { | ||
/* | ||
* x-ms-original-file: specification/oep/resource-manager/Microsoft.OpenEnergyPlatform/preview/2021-06-01-preview/examples/OepResource_Get.json | ||
*/ | ||
/** | ||
* Sample code: OepResource_Get. | ||
* | ||
* @param manager Entry point to OepManager. | ||
*/ | ||
public static void oepResourceGet(com.azure.resourcemanager.oep.OepManager manager) { | ||
manager | ||
.energyServices() | ||
.getByResourceGroupWithResponse("DummyResourceGroupName", "DummyResourceName", Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### EnergyServices_List | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for EnergyServices List. */ | ||
public final class EnergyServicesListSamples { | ||
/* | ||
* x-ms-original-file: specification/oep/resource-manager/Microsoft.OpenEnergyPlatform/preview/2021-06-01-preview/examples/OepResource_ListBySubscriptionId.json | ||
*/ | ||
/** | ||
* Sample code: OepResource_ListBySubscriptionId. | ||
* | ||
* @param manager Entry point to OepManager. | ||
*/ | ||
public static void oepResourceListBySubscriptionId(com.azure.resourcemanager.oep.OepManager manager) { | ||
manager.energyServices().list(Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### EnergyServices_ListByResourceGroup | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for EnergyServices ListByResourceGroup. */ | ||
public final class EnergyServicesListByResourceGroupSamples { | ||
/* | ||
* x-ms-original-file: specification/oep/resource-manager/Microsoft.OpenEnergyPlatform/preview/2021-06-01-preview/examples/OepResource_ListByResourceGroup.json | ||
*/ | ||
/** | ||
* Sample code: OepResource_ListByResourceGroup. | ||
* | ||
* @param manager Entry point to OepManager. | ||
*/ | ||
public static void oepResourceListByResourceGroup(com.azure.resourcemanager.oep.OepManager manager) { | ||
manager.energyServices().listByResourceGroup("DummyResourceGroupName", Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### EnergyServices_Update | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
import com.azure.resourcemanager.oep.models.EnergyService; | ||
|
||
/** Samples for EnergyServices Update. */ | ||
public final class EnergyServicesUpdateSamples { | ||
/* | ||
* x-ms-original-file: specification/oep/resource-manager/Microsoft.OpenEnergyPlatform/preview/2021-06-01-preview/examples/OepResource_Update.json | ||
*/ | ||
/** | ||
* Sample code: OepResource_Update. | ||
* | ||
* @param manager Entry point to OepManager. | ||
*/ | ||
public static void oepResourceUpdate(com.azure.resourcemanager.oep.OepManager manager) { | ||
EnergyService resource = | ||
manager | ||
.energyServices() | ||
.getByResourceGroupWithResponse("DummyResourceGroupName", "DummyResourceName", Context.NONE) | ||
.getValue(); | ||
resource.update().apply(); | ||
} | ||
} | ||
``` | ||
|
||
### Locations_CheckNameAvailability | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
import com.azure.resourcemanager.oep.models.CheckNameAvailabilityRequest; | ||
|
||
/** Samples for Locations CheckNameAvailability. */ | ||
public final class LocationsCheckNameAvailabilitySamples { | ||
/* | ||
* x-ms-original-file: specification/oep/resource-manager/Microsoft.OpenEnergyPlatform/preview/2021-06-01-preview/examples/Locations_CheckNameAvailability.json | ||
*/ | ||
/** | ||
* Sample code: Locations_CheckNameAvailability. | ||
* | ||
* @param manager Entry point to OepManager. | ||
*/ | ||
public static void locationsCheckNameAvailability(com.azure.resourcemanager.oep.OepManager manager) { | ||
manager | ||
.locations() | ||
.checkNameAvailabilityWithResponse( | ||
new CheckNameAvailabilityRequest().withName("sample-name").withType("Microsoft.OEP/oepResource"), | ||
Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### Operations_List | ||
|
||
```java | ||
import com.azure.core.util.Context; | ||
|
||
/** Samples for Operations List. */ | ||
public final class OperationsListSamples { | ||
/* | ||
* x-ms-original-file: specification/oep/resource-manager/Microsoft.OpenEnergyPlatform/preview/2021-06-01-preview/examples/Operations_List.json | ||
*/ | ||
/** | ||
* Sample code: Operations_List. | ||
* | ||
* @param manager Entry point to OepManager. | ||
*/ | ||
public static void operationsList(com.azure.resourcemanager.oep.OepManager manager) { | ||
manager.operations().listWithResponse(Context.NONE); | ||
} | ||
} | ||
``` | ||
|
Oops, something went wrong.