Azure SDK for Java Reference Documentation

Current version is 2.31.0, click here for the index

Azure Resource Manager resources client library for Java

Azure Resource Manager resources client library for Java

For documentation on how to use this package, please see Azure Management Libraries for Java.

Getting started

Prerequisites

Adding the package to your product

<dependency>
    <groupId>com.azure.resourcemanager</groupId>
    <artifactId>azure-resourcemanager-resources</artifactId>
    <version>2.31.0</version>
</dependency>

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

Azure Identity package and Azure Core Netty HTTP package provide the default implementation.

Authentication

By default, Azure Active Directory token authentication depends on correct configure of 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 environment variable AZURE_SUBSCRIPTION_ID.

With above configuration, azure client can be authenticated by following code:

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

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

See Authentication for more options.

Key concepts

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

Examples

See Samples for code snippets and samples.

Troubleshooting

Next steps

Contributing

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

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Packages
Package
Description
Package containing the classes for ResourceManagementClient.
Package containing the service clients for ResourceManagementClient.
Package containing the inner data models for ResourceManagementClient.
This package contains the base classes for management sdk.
This package contains the common resource manager utility classes that are useful to other management plane libraries.
This package contains the base class for resource collections.
This package contains the base classes for resource models.
This package contains the base class for resource collections.
This package contains the graph related classes that are useful for performing cloud requests in parallel.
This package contains the exception classes for management plane libraries.
This package contains the base classes for resource models, and their variants for creating and updating scenarios.
This package contains the base classes for resources http policy.
This package contains the base classes for resources azure http rest.
This package contains a few utility classes for working with Azure resources.
Package containing the data models for ResourceManagementClient.