Skip to content

Commit 2355aa3

Browse files
committed
Update docs metadata
1 parent 6cb7c6c commit 2355aa3

File tree

2 files changed

+128
-0
lines changed

2 files changed

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

0 commit comments

Comments
 (0)