Skip to content

Commit da37980

Browse files
author
SDKAuto
committed
CodeGen from PR 34550 in Azure/azure-rest-api-specs
Merge b8b785b5d18120df26ef25a2c4777bdd5fc632a2 into 9f69db7532b6706baedc004f2eda762196a3e1eb
1 parent dbc1627 commit da37980

File tree

62 files changed

+5780
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+5780
-0
lines changed

eng/versioning/version_client.txt

+1
Original file line numberDiff line numberDiff line change
@@ -483,6 +483,7 @@ com.azure.resourcemanager:azure-resourcemanager-programmableconnectivity;1.0.0-b
483483
com.azure.resourcemanager:azure-resourcemanager-dell-storage;1.0.0-beta.1;1.0.0-beta.1
484484
com.azure.resourcemanager:azure-resourcemanager-sitemanager;1.0.0-beta.1;1.0.0-beta.1
485485
com.azure.resourcemanager:azure-resourcemanager-mongodbatlas;1.0.0-beta.1;1.0.0-beta.1
486+
com.azure.resourcemanager:azure-resourcemanager-contoso;1.0.0-beta.1;1.0.0-beta.1
486487
com.azure.tools:azure-sdk-archetype;1.0.0;1.2.0-beta.1
487488
com.azure.tools:azure-sdk-build-tool;1.0.0;1.1.0-beta.1
488489
com.azure.v2:azure-client-sdk-parent;2.0.0-beta.1;2.0.0-beta.1

pom.xml

+1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@
5656
<module>sdk/containerregistry</module>
5757
<module>sdk/containerservicefleet</module>
5858
<module>sdk/contentsafety</module>
59+
<module>sdk/contoso</module>
5960
<module>sdk/core</module>
6061
<module>sdk/core-v2</module>
6162
<module>sdk/cosmos</module>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Release History
2+
3+
## 1.0.0-beta.1 (2025-05-09)
4+
5+
- Azure Resource Manager Contoso client library for Java. This package contains Microsoft Azure SDK for Contoso Management SDK. Microsoft.Contoso Resource Provider management API. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt).
6+
### Features Added
7+
8+
- Initial release for the azure-resourcemanager-contoso Java SDK.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Azure Resource Manager Contoso client library for Java
2+
3+
Azure Resource Manager Contoso client library for Java.
4+
5+
This package contains Microsoft Azure SDK for Contoso Management SDK. Microsoft.Contoso Resource Provider management API. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt).
6+
7+
## We'd love to hear your feedback
8+
9+
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.
10+
11+
If you haven't already, please take a few minutes to [complete this short survey][survey] we have put together.
12+
13+
Thank you in advance for your collaboration. We really appreciate your time!
14+
15+
## Documentation
16+
17+
Various documentation is available to help you get started
18+
19+
- [API reference documentation][docs]
20+
21+
## Getting started
22+
23+
### Prerequisites
24+
25+
- [Java Development Kit (JDK)][jdk] with version 8 or above
26+
- [Azure Subscription][azure_subscription]
27+
28+
### Adding the package to your product
29+
30+
[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager-contoso;current})
31+
```xml
32+
<dependency>
33+
<groupId>com.azure.resourcemanager</groupId>
34+
<artifactId>azure-resourcemanager-contoso</artifactId>
35+
<version>1.0.0-beta.1</version>
36+
</dependency>
37+
```
38+
[//]: # ({x-version-update-end})
39+
40+
### Include the recommended packages
41+
42+
Azure Management Libraries require a `TokenCredential` implementation for authentication and an `HttpClient` implementation for HTTP client.
43+
44+
[Azure Identity][azure_identity] and [Azure Core Netty HTTP][azure_core_http_netty] packages provide the default implementation.
45+
46+
### Authentication
47+
48+
Microsoft Entra ID token authentication relies on the [credential class][azure_identity_credentials] from [Azure Identity][azure_identity] package.
49+
50+
Azure subscription ID can be configured via `AZURE_SUBSCRIPTION_ID` environment variable.
51+
52+
Assuming the use of the `DefaultAzureCredential` credential class, the client can be authenticated using the following code:
53+
54+
```java
55+
AzureProfile profile = new AzureProfile(AzureCloud.AZURE_PUBLIC_CLOUD);
56+
TokenCredential credential = new DefaultAzureCredentialBuilder()
57+
.authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint())
58+
.build();
59+
ContosoManager manager = ContosoManager
60+
.authenticate(credential, profile);
61+
```
62+
63+
The sample code assumes global Azure. Please change the `AzureCloud.AZURE_PUBLIC_CLOUD` variable if otherwise.
64+
65+
See [Authentication][authenticate] for more options.
66+
67+
## Key concepts
68+
69+
See [API design][design] for general introduction on design and key concepts on Azure Management Libraries.
70+
71+
## Examples
72+
73+
[Code snippets and samples](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/contoso/azure-resourcemanager-contoso/SAMPLE.md)
74+
75+
76+
## Troubleshooting
77+
78+
## Next steps
79+
80+
## Contributing
81+
82+
For details on contributing to this repository, see the [contributing guide][cg].
83+
84+
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>.
85+
86+
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.
87+
88+
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.
89+
90+
<!-- LINKS -->
91+
[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS
92+
[docs]: https://azure.github.io/azure-sdk-for-java/
93+
[jdk]: https://learn.microsoft.com/azure/developer/java/fundamentals/
94+
[azure_subscription]: https://azure.microsoft.com/free/
95+
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity
96+
[azure_identity_credentials]: https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/identity/azure-identity#credentials
97+
[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core-http-netty
98+
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/AUTH.md
99+
[design]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/DESIGN.md
100+
[cg]: https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md
101+
[coc]: https://opensource.microsoft.com/codeofconduct/
102+
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
# Code snippets and samples
2+
3+
4+
## Employees
5+
6+
- [CreateOrUpdate](#employees_createorupdate)
7+
- [Delete](#employees_delete)
8+
- [GetByResourceGroup](#employees_getbyresourcegroup)
9+
- [List](#employees_list)
10+
- [ListByResourceGroup](#employees_listbyresourcegroup)
11+
- [Update](#employees_update)
12+
13+
## Operations
14+
15+
- [List](#operations_list)
16+
### Employees_CreateOrUpdate
17+
18+
```java
19+
/**
20+
* Samples for Operations List.
21+
*/
22+
public final class OperationsListSamples {
23+
/*
24+
* x-ms-original-file: 2021-11-01/Operations_List.json
25+
*/
26+
/**
27+
* Sample code: Operations_List.
28+
*
29+
* @param manager Entry point to ContosoManager.
30+
*/
31+
public static void operationsList(com.azure.resourcemanager.contoso.ContosoManager manager) {
32+
manager.operations().list(com.azure.core.util.Context.NONE);
33+
}
34+
}
35+
```
36+
37+
### Employees_Delete
38+
39+
```java
40+
/**
41+
* Samples for Employees List.
42+
*/
43+
public final class EmployeesListSamples {
44+
/*
45+
* x-ms-original-file: 2021-11-01/Employees_ListBySubscription.json
46+
*/
47+
/**
48+
* Sample code: Employees_ListBySubscription.
49+
*
50+
* @param manager Entry point to ContosoManager.
51+
*/
52+
public static void employeesListBySubscription(com.azure.resourcemanager.contoso.ContosoManager manager) {
53+
manager.employees().list(com.azure.core.util.Context.NONE);
54+
}
55+
}
56+
```
57+
58+
### Employees_GetByResourceGroup
59+
60+
```java
61+
/**
62+
* Samples for Employees GetByResourceGroup.
63+
*/
64+
public final class EmployeesGetByResourceGroupSamples {
65+
/*
66+
* x-ms-original-file: 2021-11-01/Employees_Get.json
67+
*/
68+
/**
69+
* Sample code: Employees_Get.
70+
*
71+
* @param manager Entry point to ContosoManager.
72+
*/
73+
public static void employeesGet(com.azure.resourcemanager.contoso.ContosoManager manager) {
74+
manager.employees()
75+
.getByResourceGroupWithResponse("rgopenapi", "le-8MU--J3W6q8D386p3-iT3", com.azure.core.util.Context.NONE);
76+
}
77+
}
78+
```
79+
80+
### Employees_List
81+
82+
```java
83+
/**
84+
* Samples for Employees ListByResourceGroup.
85+
*/
86+
public final class EmployeesListByResourceGroupSamples {
87+
/*
88+
* x-ms-original-file: 2021-11-01/Employees_ListByResourceGroup.json
89+
*/
90+
/**
91+
* Sample code: Employees_ListByResourceGroup.
92+
*
93+
* @param manager Entry point to ContosoManager.
94+
*/
95+
public static void employeesListByResourceGroup(com.azure.resourcemanager.contoso.ContosoManager manager) {
96+
manager.employees().listByResourceGroup("rgopenapi", com.azure.core.util.Context.NONE);
97+
}
98+
}
99+
```
100+
101+
### Employees_ListByResourceGroup
102+
103+
```java
104+
import com.azure.resourcemanager.contoso.models.Employee;
105+
import com.azure.resourcemanager.contoso.models.EmployeeProperties;
106+
import java.util.HashMap;
107+
import java.util.Map;
108+
109+
/**
110+
* Samples for Employees Update.
111+
*/
112+
public final class EmployeesUpdateSamples {
113+
/*
114+
* x-ms-original-file: 2021-11-01/Employees_Update.json
115+
*/
116+
/**
117+
* Sample code: Employees_Update.
118+
*
119+
* @param manager Entry point to ContosoManager.
120+
*/
121+
public static void employeesUpdate(com.azure.resourcemanager.contoso.ContosoManager manager) {
122+
Employee resource = manager.employees()
123+
.getByResourceGroupWithResponse("rgopenapi", "-XhyNJ--", com.azure.core.util.Context.NONE)
124+
.getValue();
125+
resource.update()
126+
.withTags(mapOf("key7952", "fakeTokenPlaceholder"))
127+
.withProperties(
128+
new EmployeeProperties().withAge(24).withCity("uyfg").withProfile("oapgijcswfkruiuuzbwco".getBytes()))
129+
.apply();
130+
}
131+
132+
// Use "Map.of" if available
133+
@SuppressWarnings("unchecked")
134+
private static <T> Map<String, T> mapOf(Object... inputs) {
135+
Map<String, T> map = new HashMap<>();
136+
for (int i = 0; i < inputs.length; i += 2) {
137+
String key = (String) inputs[i];
138+
T value = (T) inputs[i + 1];
139+
map.put(key, value);
140+
}
141+
return map;
142+
}
143+
}
144+
```
145+
146+
### Employees_Update
147+
148+
```java
149+
import com.azure.resourcemanager.contoso.models.EmployeeProperties;
150+
import java.util.HashMap;
151+
import java.util.Map;
152+
153+
/**
154+
* Samples for Employees CreateOrUpdate.
155+
*/
156+
public final class EmployeesCreateOrUpdateSamples {
157+
/*
158+
* x-ms-original-file: 2021-11-01/Employees_CreateOrUpdate.json
159+
*/
160+
/**
161+
* Sample code: Employees_CreateOrUpdate.
162+
*
163+
* @param manager Entry point to ContosoManager.
164+
*/
165+
public static void employeesCreateOrUpdate(com.azure.resourcemanager.contoso.ContosoManager manager) {
166+
manager.employees()
167+
.define("9KF-f-8b")
168+
.withRegion("itajgxyqozseoygnl")
169+
.withExistingResourceGroup("rgopenapi")
170+
.withTags(mapOf("key2913", "fakeTokenPlaceholder"))
171+
.withProperties(new EmployeeProperties().withAge(30)
172+
.withCity("gydhnntudughbmxlkyzrskcdkotrxn")
173+
.withProfile("ms".getBytes()))
174+
.create();
175+
}
176+
177+
// Use "Map.of" if available
178+
@SuppressWarnings("unchecked")
179+
private static <T> Map<String, T> mapOf(Object... inputs) {
180+
Map<String, T> map = new HashMap<>();
181+
for (int i = 0; i < inputs.length; i += 2) {
182+
String key = (String) inputs[i];
183+
T value = (T) inputs[i + 1];
184+
map.put(key, value);
185+
}
186+
return map;
187+
}
188+
}
189+
```
190+
191+
### Operations_List
192+
193+
```java
194+
/**
195+
* Samples for Employees Delete.
196+
*/
197+
public final class EmployeesDeleteSamples {
198+
/*
199+
* x-ms-original-file: 2021-11-01/Employees_Delete.json
200+
*/
201+
/**
202+
* Sample code: Employees_Delete.
203+
*
204+
* @param manager Entry point to ContosoManager.
205+
*/
206+
public static void employeesDelete(com.azure.resourcemanager.contoso.ContosoManager manager) {
207+
manager.employees().delete("rgopenapi", "5vX--BxSu3ux48rI4O9OQ569", com.azure.core.util.Context.NONE);
208+
}
209+
}
210+
```
211+

0 commit comments

Comments
 (0)