Skip to content

Commit eb47727

Browse files
authored
Configurations: 'specification/orbitalplanetarycomputer/Orbital.Management/tspconfig.yaml', API Version: 2025-02-11-preview, SDK Release Type: beta, and CommitSHA: 'b15e6baad78142745642047f29e7391ea37ab155' in SpecRepo: 'https://github.com/Azure/azure-rest-api-specs' (#45435)
1 parent adb46e2 commit eb47727

File tree

52 files changed

+5691
-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.

52 files changed

+5691
-0
lines changed

eng/versioning/version_client.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -486,6 +486,7 @@ com.azure.resourcemanager:azure-resourcemanager-dell-storage;1.0.0-beta.1;1.0.0-
486486
com.azure.resourcemanager:azure-resourcemanager-sitemanager;1.0.0-beta.1;1.0.0-beta.1
487487
com.azure.resourcemanager:azure-resourcemanager-mongodbatlas;1.0.0-beta.1;1.0.0-beta.1
488488
com.azure.resourcemanager:azure-resourcemanager-purestorageblock;1.0.0-beta.1;1.0.0-beta.1
489+
com.azure.resourcemanager:azure-resourcemanager-planetarycomputer;1.0.0-beta.1;1.0.0-beta.1
489490
com.azure.tools:azure-sdk-archetype;1.0.0;1.2.0-beta.1
490491
com.azure.tools:azure-sdk-build-tool;1.0.0;1.1.0-beta.1
491492
com.azure.v2:azure-client-sdk-parent;2.0.0-beta.1;2.0.0-beta.1

pom.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,7 @@
178178
<module>sdk/peering</module>
179179
<module>sdk/personalizer</module>
180180
<module>sdk/pineconevectordb</module>
181+
<module>sdk/planetarycomputer</module>
181182
<module>sdk/playwrighttesting</module>
182183
<module>sdk/policyinsights</module>
183184
<module>sdk/portalservices</module>
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Release History
2+
3+
## 1.0.0-beta.1 (2025-05-22)
4+
5+
- Azure Resource Manager Planetary Computer client library for Java. This package contains Microsoft Azure SDK for Planetary Computer Management SDK. Microsoft Planetary Computer Pro Resource Provider management API. Package api-version 2025-02-11-preview. 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-planetarycomputer Java SDK.
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Azure Resource Manager Planetary Computer client library for Java
2+
3+
Azure Resource Manager Planetary Computer client library for Java.
4+
5+
This package contains Microsoft Azure SDK for Planetary Computer Management SDK. Microsoft Planetary Computer Pro Resource Provider management API. Package api-version 2025-02-11-preview. 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-planetarycomputer;current})
31+
```xml
32+
<dependency>
33+
<groupId>com.azure.resourcemanager</groupId>
34+
<artifactId>azure-resourcemanager-planetarycomputer</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+
PlanetaryComputerManager manager = PlanetaryComputerManager
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/planetarycomputer/azure-resourcemanager-planetarycomputer/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 <opencode@microsoft.com> 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/
Lines changed: 200 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,200 @@
1+
# Code snippets and samples
2+
3+
4+
## GeoCatalogs
5+
6+
- [Create](#geocatalogs_create)
7+
- [Delete](#geocatalogs_delete)
8+
- [GetByResourceGroup](#geocatalogs_getbyresourcegroup)
9+
- [List](#geocatalogs_list)
10+
- [ListByResourceGroup](#geocatalogs_listbyresourcegroup)
11+
- [Update](#geocatalogs_update)
12+
### GeoCatalogs_Create
13+
14+
```java
15+
/**
16+
* Samples for GeoCatalogs List.
17+
*/
18+
public final class GeoCatalogsListSamples {
19+
/*
20+
* x-ms-original-file: 2025-02-11-preview/GeoCatalogs_ListBySubscription.json
21+
*/
22+
/**
23+
* Sample code: GeoCatalogs_ListBySubscription.
24+
*
25+
* @param manager Entry point to PlanetaryComputerManager.
26+
*/
27+
public static void
28+
geoCatalogsListBySubscription(com.azure.resourcemanager.planetarycomputer.PlanetaryComputerManager manager) {
29+
manager.geoCatalogs().list(com.azure.core.util.Context.NONE);
30+
}
31+
}
32+
```
33+
34+
### GeoCatalogs_Delete
35+
36+
```java
37+
/**
38+
* Samples for GeoCatalogs Delete.
39+
*/
40+
public final class GeoCatalogsDeleteSamples {
41+
/*
42+
* x-ms-original-file: 2025-02-11-preview/GeoCatalogs_Delete.json
43+
*/
44+
/**
45+
* Sample code: GeoCatalogs_Delete.
46+
*
47+
* @param manager Entry point to PlanetaryComputerManager.
48+
*/
49+
public static void geoCatalogsDelete(com.azure.resourcemanager.planetarycomputer.PlanetaryComputerManager manager) {
50+
manager.geoCatalogs().delete("MyResourceGroup", "MyCatalog", com.azure.core.util.Context.NONE);
51+
}
52+
}
53+
```
54+
55+
### GeoCatalogs_GetByResourceGroup
56+
57+
```java
58+
/**
59+
* Samples for GeoCatalogs ListByResourceGroup.
60+
*/
61+
public final class GeoCatalogsListByResourceGroupSamples {
62+
/*
63+
* x-ms-original-file: 2025-02-11-preview/GeoCatalogs_ListByResourceGroup.json
64+
*/
65+
/**
66+
* Sample code: GeoCatalogs_ListByResourceGroup.
67+
*
68+
* @param manager Entry point to PlanetaryComputerManager.
69+
*/
70+
public static void
71+
geoCatalogsListByResourceGroup(com.azure.resourcemanager.planetarycomputer.PlanetaryComputerManager manager) {
72+
manager.geoCatalogs().listByResourceGroup("MyResourceGroup", com.azure.core.util.Context.NONE);
73+
}
74+
}
75+
```
76+
77+
### GeoCatalogs_List
78+
79+
```java
80+
import com.azure.resourcemanager.planetarycomputer.models.GeoCatalog;
81+
import com.azure.resourcemanager.planetarycomputer.models.ManagedServiceIdentityType;
82+
import com.azure.resourcemanager.planetarycomputer.models.ManagedServiceIdentityUpdate;
83+
import com.azure.resourcemanager.planetarycomputer.models.UserAssignedIdentity;
84+
import java.util.HashMap;
85+
import java.util.Map;
86+
87+
/**
88+
* Samples for GeoCatalogs Update.
89+
*/
90+
public final class GeoCatalogsUpdateSamples {
91+
/*
92+
* x-ms-original-file: 2025-02-11-preview/GeoCatalogs_Update.json
93+
*/
94+
/**
95+
* Sample code: GeoCatalogs_Update.
96+
*
97+
* @param manager Entry point to PlanetaryComputerManager.
98+
*/
99+
public static void geoCatalogsUpdate(com.azure.resourcemanager.planetarycomputer.PlanetaryComputerManager manager) {
100+
GeoCatalog resource = manager.geoCatalogs()
101+
.getByResourceGroupWithResponse("MyResourceGroup", "MyCatalog", com.azure.core.util.Context.NONE)
102+
.getValue();
103+
resource.update()
104+
.withTags(mapOf("MyTag", "MyValue"))
105+
.withIdentity(new ManagedServiceIdentityUpdate().withType(ManagedServiceIdentityType.USER_ASSIGNED)
106+
.withUserAssignedIdentities(mapOf(
107+
"/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyManagedIdentity",
108+
new UserAssignedIdentity())))
109+
.apply();
110+
}
111+
112+
// Use "Map.of" if available
113+
@SuppressWarnings("unchecked")
114+
private static <T> Map<String, T> mapOf(Object... inputs) {
115+
Map<String, T> map = new HashMap<>();
116+
for (int i = 0; i < inputs.length; i += 2) {
117+
String key = (String) inputs[i];
118+
T value = (T) inputs[i + 1];
119+
map.put(key, value);
120+
}
121+
return map;
122+
}
123+
}
124+
```
125+
126+
### GeoCatalogs_ListByResourceGroup
127+
128+
```java
129+
/**
130+
* Samples for GeoCatalogs GetByResourceGroup.
131+
*/
132+
public final class GeoCatalogsGetByResourceGroupSamples {
133+
/*
134+
* x-ms-original-file: 2025-02-11-preview/GeoCatalogs_Get.json
135+
*/
136+
/**
137+
* Sample code: GeoCatalogs_Get.
138+
*
139+
* @param manager Entry point to PlanetaryComputerManager.
140+
*/
141+
public static void geoCatalogsGet(com.azure.resourcemanager.planetarycomputer.PlanetaryComputerManager manager) {
142+
manager.geoCatalogs()
143+
.getByResourceGroupWithResponse("MyResourceGroup", "MyCatalog", com.azure.core.util.Context.NONE);
144+
}
145+
}
146+
```
147+
148+
### GeoCatalogs_Update
149+
150+
```java
151+
import com.azure.resourcemanager.planetarycomputer.models.AutoGeneratedDomainNameLabelScope;
152+
import com.azure.resourcemanager.planetarycomputer.models.CatalogTier;
153+
import com.azure.resourcemanager.planetarycomputer.models.GeoCatalogProperties;
154+
import com.azure.resourcemanager.planetarycomputer.models.ManagedServiceIdentity;
155+
import com.azure.resourcemanager.planetarycomputer.models.ManagedServiceIdentityType;
156+
import com.azure.resourcemanager.planetarycomputer.models.UserAssignedIdentity;
157+
import java.util.HashMap;
158+
import java.util.Map;
159+
160+
/**
161+
* Samples for GeoCatalogs Create.
162+
*/
163+
public final class GeoCatalogsCreateSamples {
164+
/*
165+
* x-ms-original-file: 2025-02-11-preview/GeoCatalogs_Create.json
166+
*/
167+
/**
168+
* Sample code: GeoCatalogs_Create.
169+
*
170+
* @param manager Entry point to PlanetaryComputerManager.
171+
*/
172+
public static void geoCatalogsCreate(com.azure.resourcemanager.planetarycomputer.PlanetaryComputerManager manager) {
173+
manager.geoCatalogs()
174+
.define("MyCatalog")
175+
.withRegion("eastus")
176+
.withExistingResourceGroup("MyResourceGroup")
177+
.withTags(mapOf("MyTag", "MyValue"))
178+
.withProperties(new GeoCatalogProperties().withTier(CatalogTier.BASIC)
179+
.withAutoGeneratedDomainNameLabelScope(AutoGeneratedDomainNameLabelScope.NO_REUSE))
180+
.withIdentity(new ManagedServiceIdentity().withType(ManagedServiceIdentityType.USER_ASSIGNED)
181+
.withUserAssignedIdentities(mapOf(
182+
"/subscriptions/cd9b6cdf-dcf0-4dca-ab19-82be07b74704/resourceGroups/MyResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyManagedIdentity",
183+
new UserAssignedIdentity())))
184+
.create();
185+
}
186+
187+
// Use "Map.of" if available
188+
@SuppressWarnings("unchecked")
189+
private static <T> Map<String, T> mapOf(Object... inputs) {
190+
Map<String, T> map = new HashMap<>();
191+
for (int i = 0; i < inputs.length; i += 2) {
192+
String key = (String) inputs[i];
193+
T value = (T) inputs[i + 1];
194+
map.put(key, value);
195+
}
196+
return map;
197+
}
198+
}
199+
```
200+

0 commit comments

Comments
 (0)