Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ReleasePR azure-resourcemanager-apicenter] Added new version 2024-03-01 of API Center resource manager. #35267

Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions eng/versioning/version_client.txt
Original file line number Diff line number Diff line change
Expand Up @@ -412,6 +412,7 @@ com.azure.resourcemanager:azure-resourcemanager-newrelicobservability;1.0.0;1.1.
com.azure.resourcemanager:azure-resourcemanager-qumulo;1.0.0;1.1.0-beta.1
com.azure.resourcemanager:azure-resourcemanager-selfhelp;1.0.0-beta.1;1.0.0-beta.2
com.azure.resourcemanager:azure-resourcemanager-networkcloud;1.0.0-beta.1;1.0.0-beta.2
com.azure.resourcemanager:azure-resourcemanager-apicenter;1.0.0-beta.1;1.0.0-beta.1
com.azure.tools:azure-sdk-archetype;1.0.0;1.2.0-beta.1
com.azure.tools:azure-sdk-build-tool;1.0.0-beta.1;1.0.0-beta.2

Expand Down
1 change: 1 addition & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
<module>sdk/alertsmanagement</module>
<module>sdk/anomalydetector</module>
<module>sdk/aot</module>
<module>sdk/apicenter</module>
<module>sdk/apimanagement</module>
<module>sdk/appcomplianceautomation</module>
<module>sdk/appconfiguration</module>
Expand Down
5 changes: 5 additions & 0 deletions sdk/apicenter/azure-resourcemanager-apicenter/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Release History

## 1.0.0-beta.1 (2023-06-02)

- Azure Resource Manager apicenter client library for Java. This package contains Microsoft Azure SDK for apicenter Management SDK. Azure API Center Resource Provider. Package tag package-2023-07-01-preview. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt).
105 changes: 105 additions & 0 deletions sdk/apicenter/azure-resourcemanager-apicenter/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# Azure Resource Manager apicenter client library for Java

Azure Resource Manager apicenter client library for Java.

This package contains Microsoft Azure SDK for apicenter Management SDK. Azure API Center Resource Provider. Package tag package-2023-07-01-preview. For documentation on how to use this package, please see [Azure Management Libraries for Java](https://aka.ms/azsdk/java/mgmt).

## We'd love to hear your feedback

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.

If you haven't already, please take a few minutes to [complete this short survey][survey] we have put together.

Thank you in advance for your collaboration. We really appreciate your time!

## Documentation

Various documentation is available to help you get started

- [API reference documentation][docs]

## Getting started

### Prerequisites

- [Java Development Kit (JDK)][jdk] with version 8 or above
- [Azure Subscription][azure_subscription]

### Adding the package to your product

[//]: # ({x-version-update-start;com.azure.resourcemanager:azure-resourcemanager-apicenter;current})
```xml
<dependency>
<groupId>com.azure.resourcemanager</groupId>
<artifactId>azure-resourcemanager-apicenter</artifactId>
<version>1.0.0-beta.1</version>
</dependency>
```
[//]: # ({x-version-update-end})

### Include the recommended packages

Azure Management Libraries require a `TokenCredential` implementation for authentication and an `HttpClient` implementation for HTTP client.

[Azure Identity][azure_identity] and [Azure Core Netty HTTP][azure_core_http_netty] packages provide the default implementation.

### Authentication

By default, Azure Active Directory token authentication depends on correct configuration of the following environment variables.

- `AZURE_CLIENT_ID` for Azure client ID.
- `AZURE_TENANT_ID` for Azure tenant ID.
- `AZURE_CLIENT_SECRET` or `AZURE_CLIENT_CERTIFICATE_PATH` for client secret or client certificate.

In addition, Azure subscription ID can be configured via `AZURE_SUBSCRIPTION_ID` environment variable.

With above configuration, `azure` client can be authenticated using the following code:

```java
AzureProfile profile = new AzureProfile(AzureEnvironment.AZURE);
TokenCredential credential = new DefaultAzureCredentialBuilder()
.authorityHost(profile.getEnvironment().getActiveDirectoryEndpoint())
.build();
ApicenterManager manager = ApicenterManager
.authenticate(credential, profile);
```

The sample code assumes global Azure. Please change `AzureEnvironment.AZURE` variable if otherwise.

See [Authentication][authenticate] for more options.

## Key concepts

See [API design][design] for general introduction on design and key concepts on Azure Management Libraries.

## Examples

[Code snippets and samples](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/apicenter/azure-resourcemanager-apicenter/SAMPLE.md)


## Troubleshooting

## Next steps

## Contributing

For details on contributing to this repository, see the [contributing guide][cg].

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

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.

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.

<!-- LINKS -->
[survey]: https://microsoft.qualtrics.com/jfe/form/SV_ehN0lIk2FKEBkwd?Q_CHL=DOCS
[docs]: https://azure.github.io/azure-sdk-for-java/
[jdk]: https://docs.microsoft.com/java/azure/jdk/
[azure_subscription]: https://azure.microsoft.com/free/
[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity
[azure_core_http_netty]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core-http-netty
[authenticate]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/AUTH.md
[design]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/resourcemanager/docs/DESIGN.md
[cg]: https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md
[coc]: https://opensource.microsoft.com/codeofconduct/
[coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/
164 changes: 164 additions & 0 deletions sdk/apicenter/azure-resourcemanager-apicenter/SAMPLE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
# Code snippets and samples


## Operations

- [List](#operations_list)

## Services

- [CreateOrUpdate](#services_createorupdate)
- [Delete](#services_delete)
- [GetByResourceGroup](#services_getbyresourcegroup)
- [List](#services_list)
- [ListByResourceGroup](#services_listbyresourcegroup)
- [Update](#services_update)
### Operations_List

```java
/** Samples for Operations List. */
public final class OperationsListSamples {
/*
* x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2023-07-01-preview/examples/Operations_List.json
*/
/**
* Sample code: Operations_List.
*
* @param manager Entry point to ApicenterManager.
*/
public static void operationsList(com.azure.resourcemanager.apicenter.ApicenterManager manager) {
manager.operations().list(com.azure.core.util.Context.NONE);
}
}
```

### Services_CreateOrUpdate

```java
/** Samples for Services CreateOrUpdate. */
public final class ServicesCreateOrUpdateSamples {
/*
* x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2023-07-01-preview/examples/Services_CreateOrUpdate.json
*/
/**
* Sample code: Services_Create.
*
* @param manager Entry point to ApicenterManager.
*/
public static void servicesCreate(com.azure.resourcemanager.apicenter.ApicenterManager manager) {
manager
.services()
.define("contoso")
.withRegion((String) null)
.withExistingResourceGroup("contoso-resources")
.create();
}
}
```

### Services_Delete

```java
/** Samples for Services Delete. */
public final class ServicesDeleteSamples {
/*
* x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2023-07-01-preview/examples/Services_Delete.json
*/
/**
* Sample code: Services_Delete.
*
* @param manager Entry point to ApicenterManager.
*/
public static void servicesDelete(com.azure.resourcemanager.apicenter.ApicenterManager manager) {
manager
.services()
.deleteByResourceGroupWithResponse("contoso-resources", "contoso", com.azure.core.util.Context.NONE);
}
}
```

### Services_GetByResourceGroup

```java
/** Samples for Services GetByResourceGroup. */
public final class ServicesGetByResourceGroupSamples {
/*
* x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2023-07-01-preview/examples/Services_Get.json
*/
/**
* Sample code: Services_Get.
*
* @param manager Entry point to ApicenterManager.
*/
public static void servicesGet(com.azure.resourcemanager.apicenter.ApicenterManager manager) {
manager
.services()
.getByResourceGroupWithResponse("contoso-resources", "contoso", com.azure.core.util.Context.NONE);
}
}
```

### Services_List

```java
/** Samples for Services List. */
public final class ServicesListSamples {
/*
* x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2023-07-01-preview/examples/Services_ListBySubscription.json
*/
/**
* Sample code: Services_ListBySubscription.
*
* @param manager Entry point to ApicenterManager.
*/
public static void servicesListBySubscription(com.azure.resourcemanager.apicenter.ApicenterManager manager) {
manager.services().list(com.azure.core.util.Context.NONE);
}
}
```

### Services_ListByResourceGroup

```java
/** Samples for Services ListByResourceGroup. */
public final class ServicesListByResourceGroupSamples {
/*
* x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2023-07-01-preview/examples/Services_ListByResourceGroup.json
*/
/**
* Sample code: Services_ListByResourceGroup.
*
* @param manager Entry point to ApicenterManager.
*/
public static void servicesListByResourceGroup(com.azure.resourcemanager.apicenter.ApicenterManager manager) {
manager.services().listByResourceGroup("contoso-resources", com.azure.core.util.Context.NONE);
}
}
```

### Services_Update

```java
import com.azure.resourcemanager.apicenter.models.Service;

/** Samples for Services Update. */
public final class ServicesUpdateSamples {
/*
* x-ms-original-file: specification/apicenter/resource-manager/Microsoft.ApiCenter/preview/2023-07-01-preview/examples/Services_Update.json
*/
/**
* Sample code: Services_Update.
*
* @param manager Entry point to ApicenterManager.
*/
public static void servicesUpdate(com.azure.resourcemanager.apicenter.ApicenterManager manager) {
Service resource =
manager
.services()
.getByResourceGroupWithResponse("contoso-resources", "contoso", com.azure.core.util.Context.NONE)
.getValue();
resource.update().apply();
}
}
```

61 changes: 61 additions & 0 deletions sdk/apicenter/azure-resourcemanager-apicenter/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!--
~ Copyright (c) Microsoft Corporation. All rights reserved.
~ Licensed under the MIT License.
~ Code generated by Microsoft (R) AutoRest Code Generator.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.azure</groupId>
<artifactId>azure-client-sdk-parent</artifactId>
<version>1.7.0</version> <!-- {x-version-update;com.azure:azure-client-sdk-parent;current} -->
<relativePath>../../parents/azure-client-sdk-parent</relativePath>
</parent>

<groupId>com.azure.resourcemanager</groupId>
<artifactId>azure-resourcemanager-apicenter</artifactId>
<version>1.0.0-beta.1</version> <!-- {x-version-update;com.azure.resourcemanager:azure-resourcemanager-apicenter;current} -->
<packaging>jar</packaging>

<name>Microsoft Azure SDK for apicenter Management</name>
<description>This package contains Microsoft Azure SDK for apicenter Management SDK. For documentation on how to use this package, please see https://aka.ms/azsdk/java/mgmt. Azure API Center Resource Provider. Package tag package-2023-07-01-preview.</description>
<url>https://github.com/Azure/azure-sdk-for-java</url>

<licenses>
<license>
<name>The MIT License (MIT)</name>
<url>http://opensource.org/licenses/MIT</url>
<distribution>repo</distribution>
</license>
</licenses>

<scm>
<url>https://github.com/Azure/azure-sdk-for-java</url>
<connection>scm:git:[email protected]:Azure/azure-sdk-for-java.git</connection>
<developerConnection>scm:git:[email protected]:Azure/azure-sdk-for-java.git</developerConnection>
<tag>HEAD</tag>
</scm>
<developers>
<developer>
<id>microsoft</id>
<name>Microsoft</name>
</developer>
</developers>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<jacoco.min.linecoverage>0</jacoco.min.linecoverage>
<jacoco.min.branchcoverage>0</jacoco.min.branchcoverage>
</properties>
<dependencies>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core</artifactId>
<version>1.39.0</version> <!-- {x-version-update;com.azure:azure-core;dependency} -->
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core-management</artifactId>
<version>1.11.1</version> <!-- {x-version-update;com.azure:azure-core-management;dependency} -->
</dependency>
</dependencies>
</project>
Loading