com.azure.resourcemanager.managementgroups.ManagementGroupsManager Maven / Gradle / Ivy
Show all versions of azure-resourcemanager-managementgroups Show documentation
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.
package com.azure.resourcemanager.managementgroups;
import com.azure.core.credential.TokenCredential;
import com.azure.core.http.HttpClient;
import com.azure.core.http.HttpPipeline;
import com.azure.core.http.HttpPipelineBuilder;
import com.azure.core.http.HttpPipelinePosition;
import com.azure.core.http.policy.AddDatePolicy;
import com.azure.core.http.policy.AddHeadersFromContextPolicy;
import com.azure.core.http.policy.HttpLogOptions;
import com.azure.core.http.policy.HttpLoggingPolicy;
import com.azure.core.http.policy.HttpPipelinePolicy;
import com.azure.core.http.policy.HttpPolicyProviders;
import com.azure.core.http.policy.RequestIdPolicy;
import com.azure.core.http.policy.RetryOptions;
import com.azure.core.http.policy.RetryPolicy;
import com.azure.core.http.policy.UserAgentPolicy;
import com.azure.core.management.http.policy.ArmChallengeAuthenticationPolicy;
import com.azure.core.management.profile.AzureProfile;
import com.azure.core.util.Configuration;
import com.azure.core.util.logging.ClientLogger;
import com.azure.resourcemanager.managementgroups.fluent.ManagementGroupsApi;
import com.azure.resourcemanager.managementgroups.implementation.EntitiesImpl;
import com.azure.resourcemanager.managementgroups.implementation.HierarchySettingsOperationsImpl;
import com.azure.resourcemanager.managementgroups.implementation.ManagementGroupSubscriptionsImpl;
import com.azure.resourcemanager.managementgroups.implementation.ManagementGroupsApiBuilder;
import com.azure.resourcemanager.managementgroups.implementation.ManagementGroupsImpl;
import com.azure.resourcemanager.managementgroups.implementation.OperationsImpl;
import com.azure.resourcemanager.managementgroups.implementation.ResourceProvidersImpl;
import com.azure.resourcemanager.managementgroups.models.Entities;
import com.azure.resourcemanager.managementgroups.models.HierarchySettingsOperations;
import com.azure.resourcemanager.managementgroups.models.ManagementGroupSubscriptions;
import com.azure.resourcemanager.managementgroups.models.ManagementGroups;
import com.azure.resourcemanager.managementgroups.models.Operations;
import com.azure.resourcemanager.managementgroups.models.ResourceProviders;
import java.time.Duration;
import java.time.temporal.ChronoUnit;
import java.util.ArrayList;
import java.util.List;
import java.util.Objects;
import java.util.stream.Collectors;
/**
* Entry point to ManagementGroupsManager. The Azure Management Groups API enables consolidation of multiple
* subscriptions/resources into an organizational hierarchy and centrally manage access control, policies, alerting and
* reporting for those resources.
*/
public final class ManagementGroupsManager {
private ManagementGroups managementGroups;
private ManagementGroupSubscriptions managementGroupSubscriptions;
private HierarchySettingsOperations hierarchySettingsOperations;
private Operations operations;
private ResourceProviders resourceProviders;
private Entities entities;
private final ManagementGroupsApi clientObject;
private ManagementGroupsManager(HttpPipeline httpPipeline, AzureProfile profile, Duration defaultPollInterval) {
Objects.requireNonNull(httpPipeline, "'httpPipeline' cannot be null.");
Objects.requireNonNull(profile, "'profile' cannot be null.");
this.clientObject =
new ManagementGroupsApiBuilder()
.pipeline(httpPipeline)
.endpoint(profile.getEnvironment().getResourceManagerEndpoint())
.defaultPollInterval(defaultPollInterval)
.buildClient();
}
/**
* Creates an instance of ManagementGroups service API entry point.
*
* @param credential the credential to use.
* @param profile the Azure profile for client.
* @return the ManagementGroups service API instance.
*/
public static ManagementGroupsManager authenticate(TokenCredential credential, AzureProfile profile) {
Objects.requireNonNull(credential, "'credential' cannot be null.");
Objects.requireNonNull(profile, "'profile' cannot be null.");
return configure().authenticate(credential, profile);
}
/**
* Creates an instance of ManagementGroups service API entry point.
*
* @param httpPipeline the {@link HttpPipeline} configured with Azure authentication credential.
* @param profile the Azure profile for client.
* @return the ManagementGroups service API instance.
*/
public static ManagementGroupsManager authenticate(HttpPipeline httpPipeline, AzureProfile profile) {
Objects.requireNonNull(httpPipeline, "'httpPipeline' cannot be null.");
Objects.requireNonNull(profile, "'profile' cannot be null.");
return new ManagementGroupsManager(httpPipeline, profile, null);
}
/**
* Gets a Configurable instance that can be used to create ManagementGroupsManager with optional configuration.
*
* @return the Configurable instance allowing configurations.
*/
public static Configurable configure() {
return new ManagementGroupsManager.Configurable();
}
/** The Configurable allowing configurations to be set. */
public static final class Configurable {
private static final ClientLogger LOGGER = new ClientLogger(Configurable.class);
private HttpClient httpClient;
private HttpLogOptions httpLogOptions;
private final List policies = new ArrayList<>();
private final List scopes = new ArrayList<>();
private RetryPolicy retryPolicy;
private RetryOptions retryOptions;
private Duration defaultPollInterval;
private Configurable() {
}
/**
* Sets the http client.
*
* @param httpClient the HTTP client.
* @return the configurable object itself.
*/
public Configurable withHttpClient(HttpClient httpClient) {
this.httpClient = Objects.requireNonNull(httpClient, "'httpClient' cannot be null.");
return this;
}
/**
* Sets the logging options to the HTTP pipeline.
*
* @param httpLogOptions the HTTP log options.
* @return the configurable object itself.
*/
public Configurable withLogOptions(HttpLogOptions httpLogOptions) {
this.httpLogOptions = Objects.requireNonNull(httpLogOptions, "'httpLogOptions' cannot be null.");
return this;
}
/**
* Adds the pipeline policy to the HTTP pipeline.
*
* @param policy the HTTP pipeline policy.
* @return the configurable object itself.
*/
public Configurable withPolicy(HttpPipelinePolicy policy) {
this.policies.add(Objects.requireNonNull(policy, "'policy' cannot be null."));
return this;
}
/**
* Adds the scope to permission sets.
*
* @param scope the scope.
* @return the configurable object itself.
*/
public Configurable withScope(String scope) {
this.scopes.add(Objects.requireNonNull(scope, "'scope' cannot be null."));
return this;
}
/**
* Sets the retry policy to the HTTP pipeline.
*
* @param retryPolicy the HTTP pipeline retry policy.
* @return the configurable object itself.
*/
public Configurable withRetryPolicy(RetryPolicy retryPolicy) {
this.retryPolicy = Objects.requireNonNull(retryPolicy, "'retryPolicy' cannot be null.");
return this;
}
/**
* Sets the retry options for the HTTP pipeline retry policy.
*
* This setting has no effect, if retry policy is set via {@link #withRetryPolicy(RetryPolicy)}.
*
* @param retryOptions the retry options for the HTTP pipeline retry policy.
* @return the configurable object itself.
*/
public Configurable withRetryOptions(RetryOptions retryOptions) {
this.retryOptions = Objects.requireNonNull(retryOptions, "'retryOptions' cannot be null.");
return this;
}
/**
* Sets the default poll interval, used when service does not provide "Retry-After" header.
*
* @param defaultPollInterval the default poll interval.
* @return the configurable object itself.
*/
public Configurable withDefaultPollInterval(Duration defaultPollInterval) {
this.defaultPollInterval =
Objects.requireNonNull(defaultPollInterval, "'defaultPollInterval' cannot be null.");
if (this.defaultPollInterval.isNegative()) {
throw LOGGER
.logExceptionAsError(new IllegalArgumentException("'defaultPollInterval' cannot be negative"));
}
return this;
}
/**
* Creates an instance of ManagementGroups service API entry point.
*
* @param credential the credential to use.
* @param profile the Azure profile for client.
* @return the ManagementGroups service API instance.
*/
public ManagementGroupsManager authenticate(TokenCredential credential, AzureProfile profile) {
Objects.requireNonNull(credential, "'credential' cannot be null.");
Objects.requireNonNull(profile, "'profile' cannot be null.");
StringBuilder userAgentBuilder = new StringBuilder();
userAgentBuilder
.append("azsdk-java")
.append("-")
.append("com.azure.resourcemanager.managementgroups")
.append("/")
.append("1.0.0-beta.1");
if (!Configuration.getGlobalConfiguration().get("AZURE_TELEMETRY_DISABLED", false)) {
userAgentBuilder
.append(" (")
.append(Configuration.getGlobalConfiguration().get("java.version"))
.append("; ")
.append(Configuration.getGlobalConfiguration().get("os.name"))
.append("; ")
.append(Configuration.getGlobalConfiguration().get("os.version"))
.append("; auto-generated)");
} else {
userAgentBuilder.append(" (auto-generated)");
}
if (scopes.isEmpty()) {
scopes.add(profile.getEnvironment().getManagementEndpoint() + "/.default");
}
if (retryPolicy == null) {
if (retryOptions != null) {
retryPolicy = new RetryPolicy(retryOptions);
} else {
retryPolicy = new RetryPolicy("Retry-After", ChronoUnit.SECONDS);
}
}
List policies = new ArrayList<>();
policies.add(new UserAgentPolicy(userAgentBuilder.toString()));
policies.add(new AddHeadersFromContextPolicy());
policies.add(new RequestIdPolicy());
policies
.addAll(
this
.policies
.stream()
.filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_CALL)
.collect(Collectors.toList()));
HttpPolicyProviders.addBeforeRetryPolicies(policies);
policies.add(retryPolicy);
policies.add(new AddDatePolicy());
policies.add(new ArmChallengeAuthenticationPolicy(credential, scopes.toArray(new String[0])));
policies
.addAll(
this
.policies
.stream()
.filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_RETRY)
.collect(Collectors.toList()));
HttpPolicyProviders.addAfterRetryPolicies(policies);
policies.add(new HttpLoggingPolicy(httpLogOptions));
HttpPipeline httpPipeline =
new HttpPipelineBuilder()
.httpClient(httpClient)
.policies(policies.toArray(new HttpPipelinePolicy[0]))
.build();
return new ManagementGroupsManager(httpPipeline, profile, defaultPollInterval);
}
}
/**
* Gets the resource collection API of ManagementGroups.
*
* @return Resource collection API of ManagementGroups.
*/
public ManagementGroups managementGroups() {
if (this.managementGroups == null) {
this.managementGroups = new ManagementGroupsImpl(clientObject.getManagementGroups(), this);
}
return managementGroups;
}
/**
* Gets the resource collection API of ManagementGroupSubscriptions.
*
* @return Resource collection API of ManagementGroupSubscriptions.
*/
public ManagementGroupSubscriptions managementGroupSubscriptions() {
if (this.managementGroupSubscriptions == null) {
this.managementGroupSubscriptions =
new ManagementGroupSubscriptionsImpl(clientObject.getManagementGroupSubscriptions(), this);
}
return managementGroupSubscriptions;
}
/**
* Gets the resource collection API of HierarchySettingsOperations.
*
* @return Resource collection API of HierarchySettingsOperations.
*/
public HierarchySettingsOperations hierarchySettingsOperations() {
if (this.hierarchySettingsOperations == null) {
this.hierarchySettingsOperations =
new HierarchySettingsOperationsImpl(clientObject.getHierarchySettingsOperations(), this);
}
return hierarchySettingsOperations;
}
/**
* Gets the resource collection API of Operations.
*
* @return Resource collection API of Operations.
*/
public Operations operations() {
if (this.operations == null) {
this.operations = new OperationsImpl(clientObject.getOperations(), this);
}
return operations;
}
/**
* Gets the resource collection API of ResourceProviders.
*
* @return Resource collection API of ResourceProviders.
*/
public ResourceProviders resourceProviders() {
if (this.resourceProviders == null) {
this.resourceProviders = new ResourceProvidersImpl(clientObject.getResourceProviders(), this);
}
return resourceProviders;
}
/**
* Gets the resource collection API of Entities.
*
* @return Resource collection API of Entities.
*/
public Entities entities() {
if (this.entities == null) {
this.entities = new EntitiesImpl(clientObject.getEntities(), this);
}
return entities;
}
/**
* @return Wrapped service client ManagementGroupsApi providing direct access to the underlying auto-generated API
* implementation, based on Azure REST API.
*/
public ManagementGroupsApi serviceClient() {
return this.clientObject;
}
}