Package com.azure.resourcemanager.purview.models

Interface DefaultAccounts

public interface DefaultAccounts
Resource collection API of DefaultAccounts.

  • Method Details

    • getWithResponse

      com.azure.core.http.rest.Response<DefaultAccountPayload> getWithResponse(UUID scopeTenantId, ScopeType scopeType, String scope, com.azure.core.util.Context context)
      Gets the default account information set for the scope.

      Get the default account for the scope.

      Parameters:
      scopeTenantId - The tenant ID.
      scopeType - The scope for the default account.
      scope - The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.
      context - The context to associate with this operation.
      Returns:
      the default account for the scope along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • get

      DefaultAccountPayload get(UUID scopeTenantId, ScopeType scopeType)
      Gets the default account information set for the scope.

      Get the default account for the scope.

      Parameters:
      scopeTenantId - The tenant ID.
      scopeType - The scope for the default account.
      Returns:
      the default account for the scope.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • setWithResponse

      com.azure.core.http.rest.Response<DefaultAccountPayload> setWithResponse(DefaultAccountPayloadInner defaultAccountPayload, com.azure.core.util.Context context)
      Sets the default account for the scope.
      Parameters:
      defaultAccountPayload - The payload containing the default account information and the scope.
      context - The context to associate with this operation.
      Returns:
      payload to get and set the default account in the given scope along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • set

      DefaultAccountPayload set(DefaultAccountPayloadInner defaultAccountPayload)
      Sets the default account for the scope.
      Parameters:
      defaultAccountPayload - The payload containing the default account information and the scope.
      Returns:
      payload to get and set the default account in the given scope.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • removeWithResponse

      com.azure.core.http.rest.Response<Void> removeWithResponse(UUID scopeTenantId, ScopeType scopeType, String scope, com.azure.core.util.Context context)
      Removes the default account from the scope.
      Parameters:
      scopeTenantId - The tenant ID.
      scopeType - The scope for the default account.
      scope - The Id of the scope object, for example if the scope is "Subscription" then it is the ID of that subscription.
      context - The context to associate with this operation.
      Returns:
      the Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • remove

      void remove(UUID scopeTenantId, ScopeType scopeType)
      Removes the default account from the scope.
      Parameters:
      scopeTenantId - The tenant ID.
      scopeType - The scope for the default account.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.