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-dashboard] update readme #13519

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
1 change: 1 addition & 0 deletions eng/versioning/version_client.txt
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@ com.azure.resourcemanager:azure-resourcemanager-securityinsights;1.0.0-beta.2;1.
com.azure.resourcemanager:azure-resourcemanager-oep;1.0.0-beta.1;1.0.0-beta.2
com.azure.resourcemanager:azure-resourcemanager-dnsresolver;1.0.0-beta.1;1.0.0-beta.2
com.azure.resourcemanager:azure-resourcemanager-mobilenetwork;1.0.0-beta.1;1.0.0-beta.2
com.azure.resourcemanager:azure-resourcemanager-dashboard;1.0.0-beta.1;1.0.0-beta.1
com.azure.tools:azure-sdk-archetype;1.0.0;1.0.0
com.azure.tools:azure-sdk-build-tool;1.0.0-beta.1;1.0.0-beta.2

Expand Down
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -872,6 +872,7 @@
<module>sdk/cosmos</module>
<module>sdk/costmanagement</module>
<module>sdk/customerinsights</module>
<module>sdk/dashboard</module>
<module>sdk/databox</module>
<module>sdk/databoxedge</module>
<module>sdk/databricks</module>
Expand Down
5 changes: 5 additions & 0 deletions sdk/dashboard/azure-resourcemanager-dashboard/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Release History

## 1.0.0-beta.1 (2022-03-24)

- Azure Resource Manager Dashboard client library for Java. This package contains Microsoft Azure SDK for Dashboard Management SDK. The Microsoft.Dashboard Rest API spec. Package tag package-2021-09-01-preview. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt).
102 changes: 102 additions & 0 deletions sdk/dashboard/azure-resourcemanager-dashboard/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# Azure Resource Manager Dashboard client library for Java

Azure Resource Manager Dashboard client library for Java.

This package contains Microsoft Azure SDK for Dashboard Management SDK. The Microsoft.Dashboard Rest API spec. Package tag package-2021-09-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-dashboard;current})
```xml
<dependency>
<groupId>com.azure.resourcemanager</groupId>
<artifactId>azure-resourcemanager-dashboard</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();
DashboardManager manager = DashboardManager
.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/dashboard/azure-resourcemanager-dashboard/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
211 changes: 211 additions & 0 deletions sdk/dashboard/azure-resourcemanager-dashboard/SAMPLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
# Code snippets and samples


## Grafana

- [Create](#grafana_create)
- [Delete](#grafana_delete)
- [GetByResourceGroup](#grafana_getbyresourcegroup)
- [List](#grafana_list)
- [ListByResourceGroup](#grafana_listbyresourcegroup)
- [Update](#grafana_update)

## Operations

- [List](#operations_list)
### Grafana_Create

```java
import com.azure.resourcemanager.dashboard.models.IdentityType;
import com.azure.resourcemanager.dashboard.models.ManagedGrafanaProperties;
import com.azure.resourcemanager.dashboard.models.ManagedIdentity;
import com.azure.resourcemanager.dashboard.models.ProvisioningState;
import com.azure.resourcemanager.dashboard.models.ResourceSku;
import com.azure.resourcemanager.dashboard.models.ZoneRedundancy;
import java.util.HashMap;
import java.util.Map;

/** Samples for Grafana Create. */
public final class GrafanaCreateSamples {
/*
* x-ms-original-file: specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Create.json
*/
/**
* Sample code: Grafana_Create.
*
* @param manager Entry point to DashboardManager.
*/
public static void grafanaCreate(com.azure.resourcemanager.dashboard.DashboardManager manager) {
manager
.grafanas()
.define("myWorkspace")
.withRegion("West US")
.withExistingResourceGroup("myResourceGroup")
.withTags(mapOf("Environment", "Dev"))
.withSku(new ResourceSku().withName("Standard"))
.withProperties(
new ManagedGrafanaProperties()
.withProvisioningState(ProvisioningState.ACCEPTED)
.withZoneRedundancy(ZoneRedundancy.ENABLED))
.withIdentity(new ManagedIdentity().withType(IdentityType.SYSTEM_ASSIGNED))
.create();
}

@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
```

### Grafana_Delete

```java
import com.azure.core.util.Context;

/** Samples for Grafana Delete. */
public final class GrafanaDeleteSamples {
/*
* x-ms-original-file: specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Delete.json
*/
/**
* Sample code: Grafana_Delete.
*
* @param manager Entry point to DashboardManager.
*/
public static void grafanaDelete(com.azure.resourcemanager.dashboard.DashboardManager manager) {
manager.grafanas().delete("myResourceGroup", "myWorkspace", Context.NONE);
}
}
```

### Grafana_GetByResourceGroup

```java
import com.azure.core.util.Context;

/** Samples for Grafana GetByResourceGroup. */
public final class GrafanaGetByResourceGroupSamples {
/*
* x-ms-original-file: specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Get.json
*/
/**
* Sample code: Grafana_Get.
*
* @param manager Entry point to DashboardManager.
*/
public static void grafanaGet(com.azure.resourcemanager.dashboard.DashboardManager manager) {
manager.grafanas().getByResourceGroupWithResponse("myResourceGroup", "myWorkspace", Context.NONE);
}
}
```

### Grafana_List

```java
import com.azure.core.util.Context;

/** Samples for Grafana List. */
public final class GrafanaListSamples {
/*
* x-ms-original-file: specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_List.json
*/
/**
* Sample code: Grafana_List.
*
* @param manager Entry point to DashboardManager.
*/
public static void grafanaList(com.azure.resourcemanager.dashboard.DashboardManager manager) {
manager.grafanas().list(Context.NONE);
}
}
```

### Grafana_ListByResourceGroup

```java
import com.azure.core.util.Context;

/** Samples for Grafana ListByResourceGroup. */
public final class GrafanaListByResourceGroupSamples {
/*
* x-ms-original-file: specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_ListByResourceGroup.json
*/
/**
* Sample code: Grafana_ListByResourceGroup.
*
* @param manager Entry point to DashboardManager.
*/
public static void grafanaListByResourceGroup(com.azure.resourcemanager.dashboard.DashboardManager manager) {
manager.grafanas().listByResourceGroup("myResourceGroup", Context.NONE);
}
}
```

### Grafana_Update

```java
import com.azure.core.util.Context;
import com.azure.resourcemanager.dashboard.models.ManagedGrafana;
import java.util.HashMap;
import java.util.Map;

/** Samples for Grafana Update. */
public final class GrafanaUpdateSamples {
/*
* x-ms-original-file: specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Grafana_Update.json
*/
/**
* Sample code: Grafana_Update.
*
* @param manager Entry point to DashboardManager.
*/
public static void grafanaUpdate(com.azure.resourcemanager.dashboard.DashboardManager manager) {
ManagedGrafana resource =
manager
.grafanas()
.getByResourceGroupWithResponse("myResourceGroup", "myWorkspace", Context.NONE)
.getValue();
resource.update().withTags(mapOf("Environment", "Dev 2")).apply();
}

@SuppressWarnings("unchecked")
private static <T> Map<String, T> mapOf(Object... inputs) {
Map<String, T> map = new HashMap<>();
for (int i = 0; i < inputs.length; i += 2) {
String key = (String) inputs[i];
T value = (T) inputs[i + 1];
map.put(key, value);
}
return map;
}
}
```

### Operations_List

```java
import com.azure.core.util.Context;

/** Samples for Operations List. */
public final class OperationsListSamples {
/*
* x-ms-original-file: specification/dashboard/resource-manager/Microsoft.Dashboard/preview/2021-09-01-preview/examples/Operations_List.json
*/
/**
* Sample code: Operations_List.
*
* @param manager Entry point to DashboardManager.
*/
public static void operationsList(com.azure.resourcemanager.dashboard.DashboardManager manager) {
manager.operations().list(Context.NONE);
}
}
```

55 changes: 55 additions & 0 deletions sdk/dashboard/azure-resourcemanager-dashboard/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<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-dashboard</artifactId>
<version>1.0.0-beta.1</version> <!-- {x-version-update;com.azure.resourcemanager:azure-resourcemanager-dashboard;current} -->
<packaging>jar</packaging>

<name>Microsoft Azure SDK for Dashboard Management</name>
<description>This package contains Microsoft Azure SDK for Dashboard Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. The Microsoft.Dashboard Rest API spec. Package tag package-2021-09-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.skip>true</jacoco.skip>
</properties>
<dependencies>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core</artifactId>
<version>1.26.0</version> <!-- {x-version-update;com.azure:azure-core;dependency} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core-management</artifactId>
<version>1.5.3</version> <!-- {x-version-update;com.azure:azure-core-management;dependency} -->
</dependency>
</dependencies>
</project>
Loading