Package com.azure.analytics.purview.administration

Class AccountsClient

java.lang.Object
com.azure.analytics.purview.administration.AccountsClient
public final class AccountsClient extends Object
Initializes a new instance of the synchronous PurviewAccountClient type.

  • Method Details

    • getAccountPropertiesWithResponse

      public Response<BinaryData> getAccountPropertiesWithResponse(RequestOptions requestOptions)
      Get an account.

      Response Body Schema 

      
 {
     id: String
     identity: {
         principalId: String
         tenantId: String
         type: String(SystemAssigned)
     }
     location: String
     name: String
     properties: {
         cloudConnectors: {
             awsExternalId: String
         }
         createdAt: OffsetDateTime
         createdBy: String
         createdByObjectId: String
         endpoints: {
             catalog: String
             guardian: String
             scan: String
         }
         friendlyName: String
         managedResourceGroupName: String
         managedResources: {
             eventHubNamespace: String
             resourceGroup: String
             storageAccount: String
         }
         privateEndpointConnections: [
             {
                 id: String
                 name: String
                 properties: {
                     privateEndpoint: {
                         id: String
                     }
                     privateLinkServiceConnectionState: {
                         actionsRequired: String
                         description: String
                         status: String(Unknown/Pending/Approved/Rejected/Disconnected)
                     }
                     provisioningState: String
                 }
                 type: String
             }
         ]
         provisioningState: String(Unknown/Creating/Moving/Deleting/SoftDeleting/SoftDeleted/Failed/Succeeded/Canceled)
         publicNetworkAccess: String(NotSpecified/Enabled/Disabled)
     }
     sku: {
         capacity: Integer
         name: String(Standard)
     }
     systemData: {
         createdAt: OffsetDateTime
         createdBy: String
         createdByType: String(User/Application/ManagedIdentity/Key)
         lastModifiedAt: OffsetDateTime
         lastModifiedBy: String
         lastModifiedByType: String(User/Application/ManagedIdentity/Key)
     }
     tags: {
         String: String
     }
     type: String
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      an account along with Response.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • updateAccountPropertiesWithResponse

      public Response<BinaryData> updateAccountPropertiesWithResponse(BinaryData accountUpdateParameters, RequestOptions requestOptions)
      Updates an account.

      Request Body Schema 

      
 {
     friendlyName: String
 }

      Response Body Schema 

      
 {
     id: String
     identity: {
         principalId: String
         tenantId: String
         type: String(SystemAssigned)
     }
     location: String
     name: String
     properties: {
         cloudConnectors: {
             awsExternalId: String
         }
         createdAt: OffsetDateTime
         createdBy: String
         createdByObjectId: String
         endpoints: {
             catalog: String
             guardian: String
             scan: String
         }
         friendlyName: String
         managedResourceGroupName: String
         managedResources: {
             eventHubNamespace: String
             resourceGroup: String
             storageAccount: String
         }
         privateEndpointConnections: [
             {
                 id: String
                 name: String
                 properties: {
                     privateEndpoint: {
                         id: String
                     }
                     privateLinkServiceConnectionState: {
                         actionsRequired: String
                         description: String
                         status: String(Unknown/Pending/Approved/Rejected/Disconnected)
                     }
                     provisioningState: String
                 }
                 type: String
             }
         ]
         provisioningState: String(Unknown/Creating/Moving/Deleting/SoftDeleting/SoftDeleted/Failed/Succeeded/Canceled)
         publicNetworkAccess: String(NotSpecified/Enabled/Disabled)
     }
     sku: {
         capacity: Integer
         name: String(Standard)
     }
     systemData: {
         createdAt: OffsetDateTime
         createdBy: String
         createdByType: String(User/Application/ManagedIdentity/Key)
         lastModifiedAt: OffsetDateTime
         lastModifiedBy: String
         lastModifiedByType: String(User/Application/ManagedIdentity/Key)
     }
     tags: {
         String: String
     }
     type: String
 }
      Parameters:
      accountUpdateParameters - The account properties that can be updated through data plane.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      account resource along with Response.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • getAccessKeysWithResponse

      public Response<BinaryData> getAccessKeysWithResponse(RequestOptions requestOptions)
      List the authorization keys associated with this account.

      Response Body Schema 

      
 {
     atlasKafkaPrimaryEndpoint: String
     atlasKafkaSecondaryEndpoint: String
 }
      Parameters:
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Account access keys along with Response.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.

    • regenerateAccessKeyWithResponse

      public Response<BinaryData> regenerateAccessKeyWithResponse(BinaryData keyOptions, RequestOptions requestOptions)
      Regenerate the authorization keys associated with this data catalog.

      Request Body Schema 

      
 {
     keyType: String(PrimaryAtlasKafkaKey/SecondaryAtlasKafkaKey)
 }

      Response Body Schema 

      
 {
     atlasKafkaPrimaryEndpoint: String
     atlasKafkaSecondaryEndpoint: String
 }
      Parameters:
      keyOptions - A access key options used for regeneration.
      requestOptions - The options to configure the HTTP request before HTTP client sends it.
      Returns:
      the Account access keys along with Response.
      Throws:
      HttpResponseException - thrown if the request is rejected by server.
      ClientAuthenticationException - thrown if the request is rejected by server on status code 401.
      ResourceNotFoundException - thrown if the request is rejected by server on status code 404.
      ResourceModifiedException - thrown if the request is rejected by server on status code 409.