com.microsoft.azure.management

Interface Azure.Authenticated

All Superinterfaces:

AccessManagement

Enclosing class:

Azure

public static interface Azure.Authenticated
extends AccessManagement

Provides authenticated access to a subset of Azure APIs that do not require a specific subscription.

To access the subscription-specific APIs, use withSubscription(String), or withDefaultSubscription() if a default subscription has already been previously specified (for example, in a previously specified authentication file).

Method Summary

Modifier and Type	Method and Description
Subscriptions	subscriptions() Entry point to subscription management APIs.
String	tenantId()
Tenants	tenants() Entry point to tenant management APIs.
Azure	withDefaultSubscription() Selects the default subscription as the subscription for the APIs to work with.
Azure	withSubscription(String subscriptionId) Selects a specific subscription for the APIs to work with.

Methods inherited from interface com.microsoft.azure.management.AccessManagement

activeDirectoryApplications, activeDirectoryGroups, activeDirectoryUsers, roleAssignments, roleDefinitions, servicePrincipals

Method Detail

tenantId

String tenantId()

Returns:

the currently selected tenant ID this client is authenticated to work with

subscriptions

Subscriptions subscriptions()

Entry point to subscription management APIs.

Returns:

Subscriptions interface providing access to subscription management

tenants

Tenants tenants()

Entry point to tenant management APIs.

Returns:

Tenants interface providing access to tenant management

withSubscription

Azure withSubscription(String subscriptionId)

Selects a specific subscription for the APIs to work with.

Most Azure APIs require a specific subscription to be selected.

Parameters:

subscriptionId - the ID of the subscription

Returns:

an authenticated Azure client configured to work with the specified subscription

withDefaultSubscription

Azure withDefaultSubscription()
                       throws CloudException,
                              IOException

Selects the default subscription as the subscription for the APIs to work with.

The default subscription can be specified inside the authentication file using Azure.authenticate(File). If no default subscription has been previously provided, the first subscription as returned by subscriptions() will be selected.

Returns:

an authenticated Azure client configured to work with the default subscription

Throws:

CloudException - exception thrown from Azure

IOException - exception thrown from serialization/deserialization