Skip to content

Commit e50ab64

Browse files
committed
Update docs metadata
1 parent 5b8c21f commit e50ab64

File tree

2 files changed

+130
-0
lines changed

2 files changed

+130
-0
lines changed
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
---
2+
title: Azure Resource Manager ServiceLinker client library for Java
3+
keywords: Azure, java, SDK, API, azure-resourcemanager-servicelinker, servicelinker
4+
author: joshfree
5+
ms.author: jfree
6+
ms.date: 04/21/2022
7+
ms.topic: reference
8+
ms.prod: azure
9+
ms.technology: azure
10+
ms.devlang: java
11+
ms.service: servicelinker
12+
---
13+
# Azure Resource Manager ServiceLinker client library for Java - Version 1.0.0-beta.1
14+
15+
16+
Azure Resource Manager ServiceLinker client library for Java.
17+
18+
This package contains Microsoft Azure SDK for ServiceLinker Management SDK. Microsoft.ServiceLinker provider. 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).
19+
20+
## We'd love to hear your feedback
21+
22+
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.
23+
24+
If you haven't already, please take a few minutes to [complete this short survey][survey] we have put together.
25+
26+
Thank you in advance for your collaboration. We really appreciate your time!
27+
28+
## Documentation
29+
30+
Various documentation is available to help you get started
31+
32+
- [API reference documentation][docs]
33+
34+
## Getting started
35+
36+
### Prerequisites
37+
38+
- [Java Development Kit (JDK)][jdk] with version 8 or above
39+
- [Azure Subscription][azure_subscription]
40+
41+
### Adding the package to your product
42+
43+
[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager-servicelinker;current})
44+
```xml
45+
<dependency>
46+
<groupId>com.azure.resourcemanager</groupId>
47+
<artifactId>azure-resourcemanager-servicelinker</artifactId>
48+
<version>1.0.0-beta.1</version>
49+
</dependency>
50+
```
51+
[//]: # ({x-version-update-end})
52+
53+
### Include the recommended packages
54+
55+
Azure Management Libraries require a `TokenCredential` implementation for authentication and an `HttpClient` implementation for HTTP client.
56+
57+
[Azure Identity][azure_identity] package and [Azure Core Netty HTTP][azure_core_http_netty] package provide the default implementation.
58+
59+
### Authentication
60+
61+
By default, Azure Active Directory token authentication depends on correct configure of following environment variables.
62+
63+
- `AZURE_CLIENT_ID` for Azure client ID.
64+
- `AZURE_TENANT_ID` for Azure tenant ID.
65+
- `AZURE_CLIENT_SECRET` or `AZURE_CLIENT_CERTIFICATE_PATH` for client secret or client certificate.
66+
67+
In addition, Azure subscription ID can be configured via environment variable `AZURE_SUBSCRIPTION_ID`.
68+
69+
With above configuration, `azure` client can be authenticated by following code:
70+
71+
```java
72+
AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
73+
TokenCredential credential = new DefaultAzureCredentialBuilder()
74+
.authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint())
75+
.build();
76+
ServiceLinkerManager manager = ServiceLinkerManager
77+
.authenticate(credential, profile);
78+
```
79+
80+
The sample code assumes global Azure. Please change `AzureEnvironment.AZURE` variable if otherwise.
81+
82+
See [Authentication][authenticate] for more options.
83+
84+
## Key concepts
85+
86+
See [API design][design] for general introduction on design and key concepts on Azure Management Libraries.
87+
88+
## Examples
89+
90+
[Code snippets and samples](https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-servicelinker_1.0.0-beta.1/sdk/servicelinker/azure-resourcemanager-servicelinker/SAMPLE.md)
91+
92+
93+
## Troubleshooting
94+
95+
## Next steps
96+
97+
## Contributing
98+
99+
For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-servicelinker_1.0.0-beta.1/CONTRIBUTING.md).
100+
101+
1. Fork it
102+
1. Create your feature branch (`git checkout -b my-new-feature`)
103+
1. Commit your changes (`git commit -am 'Add some feature'`)
104+
1. Push to the branch (`git push origin my-new-feature`)
105+
1. Create new Pull Request
106+
107+
<!-- LINKS -->
108+
[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS
109+
[docs]: https://azure.github.io/azure-sdk-for-java/
110+
[jdk]: https://docs.microsoft.com/java/azure/jdk/
111+
[azure_subscription]: https://azure.microsoft.com/free/
112+
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-servicelinker_1.0.0-beta.1/sdk/identity/azure-identity
113+
[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-servicelinker_1.0.0-beta.1/sdk/core/azure-core-http-netty
114+
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-servicelinker_1.0.0-beta.1/sdk/resourcemanager/docs/AUTH.md
115+
[design]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-servicelinker_1.0.0-beta.1/sdk/resourcemanager/docs/DESIGN.md
116+
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"Name": "azure-resourcemanager-servicelinker",
3+
"Version": "1.0.0-beta.1",
4+
"DevVersion": null,
5+
"DirectoryPath": "sdk/servicelinker/azure-resourcemanager-servicelinker",
6+
"ServiceDirectory": "servicelinker",
7+
"ReadMePath": "sdk/servicelinker/azure-resourcemanager-servicelinker/README.md",
8+
"ChangeLogPath": "sdk/servicelinker/azure-resourcemanager-servicelinker/CHANGELOG.md",
9+
"Group": "com.azure.resourcemanager",
10+
"SdkType": "mgmt",
11+
"IsNewSdk": true,
12+
"ArtifactName": "azure-resourcemanager-servicelinker",
13+
"ReleaseStatus": "2022-04-15"
14+
}

0 commit comments

Comments
 (0)