Skip to content

Commit 9c15d50

Browse files
committed
Update docs metadata
1 parent 41994c0 commit 9c15d50

File tree

2 files changed

+146
-0
lines changed

2 files changed

+146
-0
lines changed
Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
---
2+
title: Azure Resource Manager Arize AI Observability Eval client library for Java
3+
keywords: Azure, java, SDK, API, azure-resourcemanager-arizeaiobservabilityeval, arizeaiobservabilityeval
4+
ms.date: 03/31/2025
5+
ms.topic: reference
6+
ms.devlang: java
7+
ms.service: arizeaiobservabilityeval
8+
---
9+
# Azure Resource Manager Arize AI Observability Eval client library for Java - version 1.0.0-beta.1
10+
11+
12+
Azure Resource Manager Arize AI Observability Eval client library for Java.
13+
14+
This package contains Microsoft Azure SDK for Arize AI Observability Eval Management SDK. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt).
15+
16+
## We'd love to hear your feedback
17+
18+
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.
19+
20+
If you haven't already, please take a few minutes to [complete this short survey][survey] we have put together.
21+
22+
Thank you in advance for your collaboration. We really appreciate your time!
23+
24+
## Documentation
25+
26+
Various documentation is available to help you get started
27+
28+
- [API reference documentation][docs]
29+
30+
## Getting started
31+
32+
### Prerequisites
33+
34+
- [Java Development Kit (JDK)][jdk] with version 8 or above
35+
- [Azure Subscription][azure_subscription]
36+
37+
### Adding the package to your product
38+
39+
[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager-arizeaiobservabilityeval;current})
40+
```xml
41+
<dependency>
42+
<groupId>com.azure.resourcemanager</groupId>
43+
<artifactId>azure-resourcemanager-arizeaiobservabilityeval</artifactId>
44+
<version>1.0.0-beta.1</version>
45+
</dependency>
46+
```
47+
[//]: # ({x-version-update-end})
48+
49+
### Include the recommended packages
50+
51+
Azure Management Libraries require a `TokenCredential` implementation for authentication and an `HttpClient` implementation for HTTP client.
52+
53+
[Azure Identity][azure_identity] and [Azure Core Netty HTTP][azure_core_http_netty] packages provide the default implementation.
54+
55+
### Authentication
56+
57+
Microsoft Entra ID token authentication relies on the [credential class][azure_identity_credentials] from [Azure Identity][azure_identity] package.
58+
59+
Azure subscription ID can be configured via `AZURE_SUBSCRIPTION_ID` environment variable.
60+
61+
Assuming the use of the `DefaultAzureCredential` credential class, the client can be authenticated using the following code:
62+
63+
```java
64+
AzureProfile profile = new AzureProfile(AzureCloud.AZURE_PUBLIC_CLOUD);
65+
TokenCredential credential = new DefaultAzureCredentialBuilder()
66+
.authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint())
67+
.build();
68+
ArizeAIObservabilityEvalManager manager = ArizeAIObservabilityEvalManager
69+
.authenticate(credential, profile);
70+
```
71+
72+
The sample code assumes global Azure. Please change the `AzureCloud.AZURE_PUBLIC_CLOUD` variable if otherwise.
73+
74+
See [Authentication][authenticate] for more options.
75+
76+
## Key concepts
77+
78+
See [API design][design] for general introduction on design and key concepts on Azure Management Libraries.
79+
80+
## Examples
81+
82+
[Code snippets and samples](https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-arizeaiobservabilityeval_1.0.0-beta.1/sdk/arizeaiobservabilityeval/azure-resourcemanager-arizeaiobservabilityeval/SAMPLE.md)
83+
84+
85+
## Troubleshooting
86+
87+
## Next steps
88+
89+
## Contributing
90+
91+
For details on contributing to this repository, see the [contributing guide][cg].
92+
93+
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>.
94+
95+
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.
96+
97+
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.
98+
99+
<!-- LINKS -->
100+
[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS
101+
[docs]: https://azure.github.io/azure-sdk-for-java/
102+
[jdk]: https://learn.microsoft.com/azure/developer/java/fundamentals/
103+
[azure_subscription]: https://azure.microsoft.com/free/
104+
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-arizeaiobservabilityeval_1.0.0-beta.1/sdk/identity/azure-identity
105+
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-java/tree/azure-resourcemanager-arizeaiobservabilityeval_1.0.0-beta.1/sdk/identity/azure-identity#credentials
106+
[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-arizeaiobservabilityeval_1.0.0-beta.1/sdk/core/azure-core-http-netty
107+
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-arizeaiobservabilityeval_1.0.0-beta.1/sdk/resourcemanager/docs/AUTH.md
108+
[design]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-arizeaiobservabilityeval_1.0.0-beta.1/sdk/resourcemanager/docs/DESIGN.md
109+
[cg]: https://github.com/Azure/azure-sdk-for-java/blob/azure-resourcemanager-arizeaiobservabilityeval_1.0.0-beta.1/CONTRIBUTING.md
110+
[coc]: https://opensource.microsoft.com/codeofconduct/
111+
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
112+
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"Name": "azure-resourcemanager-arizeaiobservabilityeval",
3+
"Version": "1.0.0-beta.1",
4+
"DevVersion": null,
5+
"DirectoryPath": "sdk/arizeaiobservabilityeval/azure-resourcemanager-arizeaiobservabilityeval",
6+
"ServiceDirectory": "arizeaiobservabilityeval",
7+
"ReadMePath": "sdk/arizeaiobservabilityeval/azure-resourcemanager-arizeaiobservabilityeval/README.md",
8+
"ChangeLogPath": "sdk/arizeaiobservabilityeval/azure-resourcemanager-arizeaiobservabilityeval/CHANGELOG.md",
9+
"Group": "com.azure.resourcemanager",
10+
"SdkType": "mgmt",
11+
"IsNewSdk": true,
12+
"ArtifactName": "azure-resourcemanager-arizeaiobservabilityeval",
13+
"ReleaseStatus": "2025-03-31",
14+
"IncludedForValidation": false,
15+
"AdditionalValidationPackages": null,
16+
"ArtifactDetails": {
17+
"safeName": "azureresourcemanagerarizeaiobservabilityeval",
18+
"name": "azure-resourcemanager-arizeaiobservabilityeval",
19+
"releaseInBatch": "${{ parameters.release_azureresourcemanagerarizeaiobservabilityeval }}",
20+
"triggeringPaths": [
21+
"/sdk/arizeaiobservabilityeval/ci.yml"
22+
],
23+
"groupId": "com.azure.resourcemanager"
24+
},
25+
"CIParameters": {
26+
"CIMatrixConfigs": []
27+
},
28+
"Namespaces": [
29+
"com.azure.resourcemanager.arizeaiobservabilityeval",
30+
"com.azure.resourcemanager.arizeaiobservabilityeval.fluent",
31+
"com.azure.resourcemanager.arizeaiobservabilityeval.fluent.models",
32+
"com.azure.resourcemanager.arizeaiobservabilityeval.models"
33+
]
34+
}

0 commit comments

Comments
 (0)