-
Notifications
You must be signed in to change notification settings - Fork 2k
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
[Automation] Generate Fluent Lite from help#package-2023-01-01-preview #34708
Closed
Closed
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 (2023-04-28) | ||
|
||
- Azure Resource Manager selfhelp client library for Java. This package contains Microsoft Azure SDK for selfhelp Management SDK. Help RP provider. Package tag package-2023-01-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,105 @@ | ||
# Azure Resource Manager selfhelp client library for Java | ||
|
||
Azure Resource Manager selfhelp client library for Java. | ||
|
||
This package contains Microsoft Azure SDK for selfhelp Management SDK. Help RP provider. Package tag package-2023-01-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-selfhelp;current}) | ||
```xml | ||
<dependency> | ||
<groupId>com.azure.resourcemanager</groupId> | ||
<artifactId>azure-resourcemanager-selfhelp</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] 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 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 `AZURE_SUBSCRIPTION_ID` environment variable. | ||
|
||
With above configuration, `azure` client can be authenticated using the following code: | ||
|
||
```java | ||
AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE); | ||
TokenCredential credential = new DefaultAzureCredentialBuilder() | ||
.authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint()) | ||
.build(); | ||
SelfhelpManager manager = SelfhelpManager | ||
.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/selfhelp/azure-resourcemanager-selfhelp/SAMPLE.md) | ||
|
||
|
||
## Troubleshooting | ||
|
||
## Next steps | ||
|
||
## Contributing | ||
|
||
For details on contributing to this repository, see the [contributing guide][cg]. | ||
|
||
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 <opencode@microsoft.com> with any additional questions or comments. | ||
|
||
<!-- 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 | ||
[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/ |
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,155 @@ | ||
# Code snippets and samples | ||
|
||
|
||
## Diagnostics | ||
|
||
- [CheckNameAvailability](#diagnostics_checknameavailability) | ||
- [Create](#diagnostics_create) | ||
- [Get](#diagnostics_get) | ||
|
||
## DiscoverySolution | ||
|
||
- [List](#discoverysolution_list) | ||
|
||
## Operations | ||
|
||
- [List](#operations_list) | ||
### Diagnostics_CheckNameAvailability | ||
|
||
```java | ||
import com.azure.resourcemanager.selfhelp.models.CheckNameAvailabilityRequest; | ||
|
||
/** Samples for Diagnostics CheckNameAvailability. */ | ||
public final class DiagnosticsCheckNameAvailabilitySamples { | ||
/* | ||
* x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2023-01-01-preview/examples/CheckNameAvailabilityForDiagnosticWhenNameIsNotAvailable.json | ||
*/ | ||
/** | ||
* Sample code: Example when name is not available for a Diagnostic resource. | ||
* | ||
* @param manager Entry point to SelfhelpManager. | ||
*/ | ||
public static void exampleWhenNameIsNotAvailableForADiagnosticResource( | ||
com.azure.resourcemanager.selfhelp.SelfhelpManager manager) { | ||
manager | ||
.diagnostics() | ||
.checkNameAvailabilityWithResponse( | ||
"subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6", | ||
new CheckNameAvailabilityRequest().withName("sampleName").withType("Microsoft.Help/diagnostics"), | ||
com.azure.core.util.Context.NONE); | ||
} | ||
|
||
/* | ||
* x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2023-01-01-preview/examples/CheckNameAvailabilityForDiagnosticWhenNameIsAvailable.json | ||
*/ | ||
/** | ||
* Sample code: Example when name is available for a Diagnostic resource. | ||
* | ||
* @param manager Entry point to SelfhelpManager. | ||
*/ | ||
public static void exampleWhenNameIsAvailableForADiagnosticResource( | ||
com.azure.resourcemanager.selfhelp.SelfhelpManager manager) { | ||
manager | ||
.diagnostics() | ||
.checkNameAvailabilityWithResponse( | ||
"subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6", | ||
new CheckNameAvailabilityRequest().withName("sampleName").withType("Microsoft.Help/diagnostics"), | ||
com.azure.core.util.Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### Diagnostics_Create | ||
|
||
```java | ||
/** Samples for Diagnostics Create. */ | ||
public final class DiagnosticsCreateSamples { | ||
/* | ||
* x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2023-01-01-preview/examples/CreateDiagnosticForKeyVaultResource.json | ||
*/ | ||
/** | ||
* Sample code: Creates a Diagnostic for a KeyVault resource. | ||
* | ||
* @param manager Entry point to SelfhelpManager. | ||
*/ | ||
public static void createsADiagnosticForAKeyVaultResource( | ||
com.azure.resourcemanager.selfhelp.SelfhelpManager manager) { | ||
manager | ||
.diagnostics() | ||
.define("VMNotWorkingInsight") | ||
.withExistingScope( | ||
"subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read") | ||
.create(); | ||
} | ||
} | ||
``` | ||
|
||
### Diagnostics_Get | ||
|
||
```java | ||
/** Samples for Diagnostics Get. */ | ||
public final class DiagnosticsGetSamples { | ||
/* | ||
* x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2023-01-01-preview/examples/GetDiagnosticForKeyVaultResource.json | ||
*/ | ||
/** | ||
* Sample code: Gets a Diagnostic for a KeyVault resource. | ||
* | ||
* @param manager Entry point to SelfhelpManager. | ||
*/ | ||
public static void getsADiagnosticForAKeyVaultResource(com.azure.resourcemanager.selfhelp.SelfhelpManager manager) { | ||
manager | ||
.diagnostics() | ||
.getWithResponse( | ||
"subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read", | ||
"VMNotWorkingInsight", | ||
com.azure.core.util.Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### DiscoverySolution_List | ||
|
||
```java | ||
/** Samples for DiscoverySolution List. */ | ||
public final class DiscoverySolutionListSamples { | ||
/* | ||
* x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2023-01-01-preview/examples/ListDiscoverySolutionsForKeyVaultResource.json | ||
*/ | ||
/** | ||
* Sample code: List DiscoverySolutions for a KeyVault resource. | ||
* | ||
* @param manager Entry point to SelfhelpManager. | ||
*/ | ||
public static void listDiscoverySolutionsForAKeyVaultResource( | ||
com.azure.resourcemanager.selfhelp.SelfhelpManager manager) { | ||
manager | ||
.discoverySolutions() | ||
.list( | ||
"subscriptions/0d0fcd2e-c4fd-4349-8497-200edb3923c6/resourcegroups/myresourceGroup/providers/Microsoft.KeyVault/vaults/test-keyvault-non-read", | ||
null, | ||
null, | ||
com.azure.core.util.Context.NONE); | ||
} | ||
} | ||
``` | ||
|
||
### Operations_List | ||
|
||
```java | ||
/** Samples for Operations List. */ | ||
public final class OperationsListSamples { | ||
/* | ||
* x-ms-original-file: specification/help/resource-manager/Microsoft.Help/preview/2023-01-01-preview/examples/ListOperations.json | ||
*/ | ||
/** | ||
* Sample code: List All Operations. | ||
* | ||
* @param manager Entry point to SelfhelpManager. | ||
*/ | ||
public static void listAllOperations(com.azure.resourcemanager.selfhelp.SelfhelpManager manager) { | ||
manager.operations().list(com.azure.core.util.Context.NONE); | ||
} | ||
} | ||
``` | ||
|
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,97 @@ | ||
<!-- | ||
~ Copyright (c) Microsoft Corporation. All rights reserved. | ||
~ Licensed under the MIT License. | ||
~ Code generated by Microsoft (R) AutoRest Code Generator. | ||
--> | ||
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> | ||
<modelVersion>4.0.0</modelVersion> | ||
<parent> | ||
<groupId>com.azure</groupId> | ||
<artifactId>azure-client-sdk-parent</artifactId> | ||
<version>1.7.0</version> <!-- {x-version-update;com.azure:azure-client-sdk-parent;current} --> | ||
<relativePath>../../parents/azure-client-sdk-parent</relativePath> | ||
</parent> | ||
|
||
<groupId>com.azure.resourcemanager</groupId> | ||
<artifactId>azure-resourcemanager-selfhelp</artifactId> | ||
<version>1.0.0-beta.1</version> <!-- {x-version-update;com.azure.resourcemanager:azure-resourcemanager-selfhelp;current} --> | ||
<packaging>jar</packaging> | ||
|
||
<name>Microsoft Azure SDK for selfhelp Management</name> | ||
<description>This package contains Microsoft Azure SDK for selfhelp Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Help RP provider. Package tag package-2023-01-01-preview.</description> | ||
<url>https://github.com/Azure/azure-sdk-for-java</url> | ||
|
||
<licenses> | ||
<license> | ||
<name>The MIT License (MIT)</name> | ||
<url>http://opensource.org/licenses/MIT</url> | ||
<distribution>repo</distribution> | ||
</license> | ||
</licenses> | ||
|
||
<scm> | ||
<url>https://github.com/Azure/azure-sdk-for-java</url> | ||
<connection>scm:git:git@github.com:Azure/azure-sdk-for-java.git</connection> | ||
<developerConnection>scm:git:git@github.com:Azure/azure-sdk-for-java.git</developerConnection> | ||
<tag>HEAD</tag> | ||
</scm> | ||
<developers> | ||
<developer> | ||
<id>microsoft</id> | ||
<name>Microsoft</name> | ||
</developer> | ||
</developers> | ||
<properties> | ||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
<jacoco.min.linecoverage>0</jacoco.min.linecoverage> | ||
<jacoco.min.branchcoverage>0</jacoco.min.branchcoverage> | ||
</properties> | ||
<dependencies> | ||
<dependency> | ||
<groupId>com.azure</groupId> | ||
<artifactId>azure-core</artifactId> | ||
<version>1.38.0</version> <!-- {x-version-update;com.azure:azure-core;dependency} --> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.azure</groupId> | ||
<artifactId>azure-core-management</artifactId> | ||
<version>1.11.0</version> <!-- {x-version-update;com.azure:azure-core-management;dependency} --> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.azure</groupId> | ||
<artifactId>azure-core-test</artifactId> | ||
<version>1.16.2</version> <!-- {x-version-update;com.azure:azure-core-test;dependency} --> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>com.azure</groupId> | ||
<artifactId>azure-identity</artifactId> | ||
<version>1.8.2</version> <!-- {x-version-update;com.azure:azure-identity;dependency} --> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.junit.jupiter</groupId> | ||
<artifactId>junit-jupiter-api</artifactId> | ||
<version>5.9.1</version> <!-- {x-version-update;org.junit.jupiter:junit-jupiter-api;external_dependency} --> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.junit.jupiter</groupId> | ||
<artifactId>junit-jupiter-engine</artifactId> | ||
<version>5.9.1</version> <!-- {x-version-update;org.junit.jupiter:junit-jupiter-engine;external_dependency} --> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.mockito</groupId> | ||
<artifactId>mockito-core</artifactId> | ||
<version>4.11.0</version> <!-- {x-version-update;org.mockito:mockito-core;external_dependency} --> | ||
<scope>test</scope> | ||
</dependency> | ||
<dependency> | ||
<groupId>org.slf4j</groupId> | ||
<artifactId>slf4j-simple</artifactId> | ||
<version>1.7.36</version> <!-- {x-version-update;org.slf4j:slf4j-simple;external_dependency} --> | ||
<scope>test</scope> | ||
</dependency> | ||
</dependencies> | ||
</project> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure about the service name(self-help?). Though GO is using selfhelp too, guess that's fine...
https://github.com/Azure/azure-sdk-for-go/blob/3bdc6234b14b48903e1b6c26ef15063c720c4e82/sdk/resourcemanager/selfhelp/armselfhelp/README.md
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Azure/azure-sdk#5817 Please refer to this archborad review issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. I meant the manager name and service description in README. e.g.
SelfHelpManager
. You can ignore this.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks. I will add the pr to the release request issue and let service team decide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, manager name seems better be
SelfHelp...