CodeGen from PR 23357 in Azure/azure-rest-api-specs

Merge 555a830cde84ac2beb1c7404e1a0e9f6ee1e2a6d into 855e88fcf04c07753bf822e693e4616c4ea67d90
azure-sdk · Mar 29, 2023 · c4aef0c · c4aef0c
1 parent 45ad8ac
commit c4aef0c
Show file tree

Hide file tree

Showing 62 changed files with 5,856 additions and 0 deletions.
diff --git a/eng/versioning/version_client.txt b/eng/versioning/version_client.txt
@@ -402,6 +402,7 @@ com.azure.resourcemanager:azure-resourcemanager-containerservicefleet;1.0.0-beta
 com.azure.resourcemanager:azure-resourcemanager-voiceservices;1.0.0-beta.1;1.0.0-beta.2
 com.azure.resourcemanager:azure-resourcemanager-graphservices;1.0.0-beta.1;1.0.0-beta.2
 com.azure.resourcemanager:azure-resourcemanager-newrelicobservability;1.0.0-beta.1;1.0.0-beta.2
+com.azure.resourcemanager:azure-resourcemanager-help;1.0.0-beta.1;1.0.0-beta.1
 com.azure.tools:azure-sdk-archetype;1.0.0;1.2.0-beta.1
 com.azure.tools:azure-sdk-build-tool;1.0.0-beta.1;1.0.0-beta.2
 

diff --git a/pom.xml b/pom.xml
@@ -88,6 +88,7 @@
     <module>sdk/hdinsight</module>
     <module>sdk/healthbot</module>
     <module>sdk/healthcareapis</module>
+    <module>sdk/help</module>
     <module>sdk/hybridcompute</module>
     <module>sdk/hybridcontainerservice</module>
     <module>sdk/hybridkubernetes</module>

diff --git a/sdk/help/azure-resourcemanager-help/CHANGELOG.md b/sdk/help/azure-resourcemanager-help/CHANGELOG.md
@@ -0,0 +1,5 @@
+# Release History
+
+## 1.0.0-beta.1 (2023-03-29)
+
+- Azure Resource Manager Help client library for Java. This package contains Microsoft Azure SDK for Help 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).
diff --git a/sdk/help/azure-resourcemanager-help/README.md b/sdk/help/azure-resourcemanager-help/README.md
@@ -0,0 +1,105 @@
+# Azure Resource Manager Help client library for Java
+
+Azure Resource Manager Help client library for Java.
+
+This package contains Microsoft Azure SDK for Help 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-help;current})
+```xml
+<dependency>
+    <groupId>com.azure.resourcemanager</groupId>
+    <artifactId>azure-resourcemanager-help</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();
+HelpManager manager = HelpManager
+    .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/help/azure-resourcemanager-help/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 <[email protected]> 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/
diff --git a/sdk/help/azure-resourcemanager-help/SAMPLE.md b/sdk/help/azure-resourcemanager-help/SAMPLE.md
@@ -0,0 +1,153 @@
+# 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.help.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 HelpManager.
+     */
+    public static void exampleWhenNameIsNotAvailableForADiagnosticResource(
+        com.azure.resourcemanager.help.HelpManager 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 HelpManager.
+     */
+    public static void exampleWhenNameIsAvailableForADiagnosticResource(
+        com.azure.resourcemanager.help.HelpManager 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 HelpManager.
+     */
+    public static void createsADiagnosticForAKeyVaultResource(com.azure.resourcemanager.help.HelpManager 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 HelpManager.
+     */
+    public static void getsADiagnosticForAKeyVaultResource(com.azure.resourcemanager.help.HelpManager 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 HelpManager.
+     */
+    public static void listDiscoverySolutionsForAKeyVaultResource(com.azure.resourcemanager.help.HelpManager 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 HelpManager.
+     */
+    public static void listAllOperations(com.azure.resourcemanager.help.HelpManager manager) {
+        manager.operations().list(com.azure.core.util.Context.NONE);
+    }
+}
+```
+
diff --git a/sdk/help/azure-resourcemanager-help/pom.xml b/sdk/help/azure-resourcemanager-help/pom.xml
@@ -0,0 +1,61 @@
+<!--
+ ~ 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-help</artifactId>
+  <version>1.0.0-beta.1</version> <!-- {x-version-update;com.azure.resourcemanager:azure-resourcemanager-help;current} -->
+  <packaging>jar</packaging>
+
+  <name>Microsoft Azure SDK for Help Management</name>
+  <description>This package contains Microsoft Azure SDK for Help 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:[email protected]:Azure/azure-sdk-for-java.git</connection>
+    <developerConnection>scm:git:[email protected]: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.37.0</version> <!-- {x-version-update;com.azure:azure-core;dependency} -->
+    </dependency>
+    <dependency>
+      <groupId>com.azure</groupId>
+      <artifactId>azure-core-management</artifactId>
+      <version>1.10.2</version> <!-- {x-version-update;com.azure:azure-core-management;dependency} -->
+    </dependency>
+  </dependencies>
+</project>