AccountsOperations Class

AccountsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

AccountsOperations

Constructor

AccountsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Methods

get_access_keys	List the authorization keys associated with this account.
get_account_properties	Get an account.
regenerate_access_key	Regenerate the authorization keys associated with this data catalog.
update_account_properties	Updates an account.

get_access_keys

List the authorization keys associated with this account.

async get_access_keys(**kwargs: Any) -> Any

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 200
   response.json() == {
       "atlasKafkaPrimaryEndpoint": "str (optional)",
       "atlasKafkaSecondaryEndpoint": "str (optional)"
   }

get_account_properties

Get an account.

async get_account_properties(**kwargs: Any) -> Any

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   # response body for status code(s): 200
   response.json() == {
       "id": "str (optional)",
       "identity": {
           "principalId": "str (optional)",
           "tenantId": "str (optional)",
           "type": "str (optional)"
       },
       "location": "str (optional)",
       "name": "str (optional)",
       "properties": {
           "cloudConnectors": {
               "awsExternalId": "str (optional)"
           },
           "createdAt": "datetime (optional)",
           "createdBy": "str (optional)",
           "createdByObjectId": "str (optional)",
           "endpoints": {
               "catalog": "str (optional)",
               "guardian": "str (optional)",
               "scan": "str (optional)"
           },
           "friendlyName": "str (optional)",
           "managedResourceGroupName": "str (optional)",
           "managedResources": {
               "eventHubNamespace": "str (optional)",
               "resourceGroup": "str (optional)",
               "storageAccount": "str (optional)"
           },
           "privateEndpointConnections": [
               {
                   "id": "str (optional)",
                   "name": "str (optional)",
                   "properties": {
                       "privateEndpoint": {
                           "id": "str (optional)"
                       },
                       "privateLinkServiceConnectionState": {
                           "actionsRequired": "str (optional)",
                           "description": "str (optional)",
                           "status": "str (optional)"
                       },
                       "provisioningState": "str (optional)"
                   },
                   "type": "str (optional)"
               }
           ],
           "provisioningState": "str (optional)",
           "publicNetworkAccess": "str (optional). Default value is "Enabled""
       },
       "sku": {
           "capacity": "int (optional)",
           "name": "str (optional)"
       },
       "systemData": {
           "createdAt": "datetime (optional)",
           "createdBy": "str (optional)",
           "createdByType": "str (optional)",
           "lastModifiedAt": "datetime (optional)",
           "lastModifiedBy": "str (optional)",
           "lastModifiedByType": "str (optional)"
       },
       "tags": {
           "str": "str (optional)"
       },
       "type": "str (optional)"
   }

regenerate_access_key

Regenerate the authorization keys associated with this data catalog.

async regenerate_access_key(key_options: Any, **kwargs: Any) -> Any

Parameters

key_options

<xref:Any>

Required

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   # JSON input template you can fill out and use as your body input.
   key_options = {
       "keyType": "str (optional)"
   }

   # response body for status code(s): 200
   response.json() == {
       "atlasKafkaPrimaryEndpoint": "str (optional)",
       "atlasKafkaSecondaryEndpoint": "str (optional)"
   }

update_account_properties

Updates an account.

async update_account_properties(account_update_parameters: Any, **kwargs: Any) -> Any

Parameters

account_update_parameters

<xref:Any>

Required

Returns

JSON object

Return type

<xref:Any>

Exceptions

HttpResponseError

Examples

   # JSON input template you can fill out and use as your body input.
   account_update_parameters = {
       "friendlyName": "str (optional)"
   }

   # response body for status code(s): 200
   response.json() == {
       "id": "str (optional)",
       "identity": {
           "principalId": "str (optional)",
           "tenantId": "str (optional)",
           "type": "str (optional)"
       },
       "location": "str (optional)",
       "name": "str (optional)",
       "properties": {
           "cloudConnectors": {
               "awsExternalId": "str (optional)"
           },
           "createdAt": "datetime (optional)",
           "createdBy": "str (optional)",
           "createdByObjectId": "str (optional)",
           "endpoints": {
               "catalog": "str (optional)",
               "guardian": "str (optional)",
               "scan": "str (optional)"
           },
           "friendlyName": "str (optional)",
           "managedResourceGroupName": "str (optional)",
           "managedResources": {
               "eventHubNamespace": "str (optional)",
               "resourceGroup": "str (optional)",
               "storageAccount": "str (optional)"
           },
           "privateEndpointConnections": [
               {
                   "id": "str (optional)",
                   "name": "str (optional)",
                   "properties": {
                       "privateEndpoint": {
                           "id": "str (optional)"
                       },
                       "privateLinkServiceConnectionState": {
                           "actionsRequired": "str (optional)",
                           "description": "str (optional)",
                           "status": "str (optional)"
                       },
                       "provisioningState": "str (optional)"
                   },
                   "type": "str (optional)"
               }
           ],
           "provisioningState": "str (optional)",
           "publicNetworkAccess": "str (optional). Default value is "Enabled""
       },
       "sku": {
           "capacity": "int (optional)",
           "name": "str (optional)"
       },
       "systemData": {
           "createdAt": "datetime (optional)",
           "createdBy": "str (optional)",
           "createdByType": "str (optional)",
           "lastModifiedAt": "datetime (optional)",
           "lastModifiedBy": "str (optional)",
           "lastModifiedByType": "str (optional)"
       },
       "tags": {
           "str": "str (optional)"
       },
       "type": "str (optional)"
   }