com.azure.resourcemanager.billing.fluent.AssociatedTenantsClient Maven / Gradle / Ivy

Go to download
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.billing.fluent;

import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.management.polling.PollResult;
import com.azure.core.util.Context;
import com.azure.core.util.polling.SyncPoller;
import com.azure.resourcemanager.billing.fluent.models.AssociatedTenantInner;

/**
 * An instance of this class provides access to all the operations defined in AssociatedTenantsClient.
 */
public interface AssociatedTenantsClient {
    /**
     * Deletes an associated tenant for a billing account.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link SyncPoller} for polling of long-running operation.
     */
    @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
    SyncPoller, Void> beginDelete(String billingAccountName, String associatedTenantName);

    /**
     * Deletes an associated tenant for a billing account.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link SyncPoller} for polling of long-running operation.
     */
    @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
    SyncPoller, Void> beginDelete(String billingAccountName, String associatedTenantName,
        Context context);

    /**
     * Deletes an associated tenant for a billing account.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    void delete(String billingAccountName, String associatedTenantName);

    /**
     * Deletes an associated tenant for a billing account.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    void delete(String billingAccountName, String associatedTenantName, Context context);

    /**
     * Gets an associated tenant by ID.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return an associated tenant by ID along with {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response getWithResponse(String billingAccountName, String associatedTenantName,
        Context context);

    /**
     * Gets an associated tenant by ID.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return an associated tenant by ID.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    AssociatedTenantInner get(String billingAccountName, String associatedTenantName);

    /**
     * Create or update an associated tenant for the billing account.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @param parameters An associated tenant.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link SyncPoller} for polling of an associated tenant.
     */
    @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
    SyncPoller, AssociatedTenantInner> beginCreateOrUpdate(String billingAccountName,
        String associatedTenantName, AssociatedTenantInner parameters);

    /**
     * Create or update an associated tenant for the billing account.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @param parameters An associated tenant.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link SyncPoller} for polling of an associated tenant.
     */
    @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
    SyncPoller, AssociatedTenantInner> beginCreateOrUpdate(String billingAccountName,
        String associatedTenantName, AssociatedTenantInner parameters, Context context);

    /**
     * Create or update an associated tenant for the billing account.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @param parameters An associated tenant.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return an associated tenant.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    AssociatedTenantInner createOrUpdate(String billingAccountName, String associatedTenantName,
        AssociatedTenantInner parameters);

    /**
     * Create or update an associated tenant for the billing account.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param associatedTenantName The ID that uniquely identifies a tenant.
     * @param parameters An associated tenant.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return an associated tenant.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    AssociatedTenantInner createOrUpdate(String billingAccountName, String associatedTenantName,
        AssociatedTenantInner parameters, Context context);

    /**
     * Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing
     * and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a container for a list of resources as paginated response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable listByBillingAccount(String billingAccountName);

    /**
     * Lists the associated tenants that can collaborate with the billing account on commerce activities like viewing
     * and downloading invoices, managing payments, making purchases, and managing or provisioning licenses.
     * 
     * @param billingAccountName The ID that uniquely identifies a billing account.
     * @param includeRevoked Can be used to get revoked associated tenants.
     * @param filter The filter query option allows clients to filter a collection of resources that are addressed by a
     * request URL.
     * @param orderBy The orderby query option allows clients to request resources in a particular order.
     * @param top The top query option requests the number of items in the queried collection to be included in the
     * result. The maximum supported value for top is 50.
     * @param skip The skip query option requests the number of items in the queried collection that are to be skipped
     * and not included in the result.
     * @param count The count query option allows clients to request a count of the matching resources included with the
     * resources in the response.
     * @param search The search query option allows clients to request items within a collection matching a free-text
     * search expression. search is only supported for string fields.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return a container for a list of resources as paginated response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable listByBillingAccount(String billingAccountName, Boolean includeRevoked,
        String filter, String orderBy, Long top, Long skip, Boolean count, String search, Context context);
}