---
title: "PATCH /"
method: PATCH
path: "/"
tags: ["Account"]
---

# PATCH /

`PATCH /`

Updates an account

## Query parameters

- `api-version` string, required

## Request body

- DataPlaneAccountUpdateParameters — The account properties that can be updated through data plane.
  - `friendlyName` string — The friendly name for the azure resource.

## Response `200`

Success

- Account — Account resource
  - `id` string — Gets or sets the identifier.
  - `identity` Identity — The Managed Identity of the resource
    - `principalId` string — Service principal object Id
    - `tenantId` string — Tenant Id
    - `type` 'None' | 'SystemAssigned' | 'UserAssigned' — Identity Type
    - `userAssignedIdentities` object — User Assigned Identities
  - `location` string — Gets or sets the location.
  - `name` string — Gets or sets the name.
  - `properties` AccountProperties — The account properties
    - `accountStatus` AccountStatus — The account status.
      - `accountProvisioningState` 'Unknown' | 'Creating' | 'Updating' | 'Moving' | 'Deleting' | 'SoftDeleting' | 'SoftDeleted' | 'Failed' | 'Succeeded' | 'Canceled' — Gets the account status code.
      - `errorDetails` ErrorModel — Default error model
        - `code` string — Gets or sets the code.
        - `details` ErrorModel[] — Gets or sets the details.
        - `message` string — Gets or sets the messages.
        - `target` string — Gets or sets the target.
    - `cloudConnectors` CloudConnectors — External Cloud Service connectors
      - `awsExternalId` string — AWS external identifier. Configured in AWS to allow use of the role arn used for scanning
    - `createdAt` string, date-time — Gets the time at which the entity was created.
    - `createdBy` string — Gets the creator of the entity.
    - `createdByObjectId` string — Gets the creators of the entity's object id.
    - `defaultDomain` string — Gets or sets the default domain in the account.
    - `endpoints` AccountEndpoints — The account endpoints
      - `catalog` string — Gets the catalog endpoint.
      - `scan` string — Gets the scan endpoint.
    - `friendlyName` string — Gets or sets the friendly name.
    - `ingestionStorage` IngestionStorage — Ingestion Storage Account Info
      - `id` string — Gets or sets the Id.
      - `primaryEndpoint` string — Gets or sets the primary endpoint.
      - `publicNetworkAccess` 'NotSpecified' | 'Enabled' | 'Disabled' — Gets or sets the public network access setting
    - `managedEventHubState` 'NotSpecified' | 'Disabled' | 'Enabled' — Gets or sets the state of managed eventhub. If enabled managed eventhub will be created, if disabled the managed eventhub will be removed.
    - `managedResourceGroupName` string — Gets or sets the managed resource group name
    - `managedResources` ManagedResources — The managed resources in customer subscription.
      - `eventHubNamespace` string — Gets the managed event hub namespace resource identifier.
      - `resourceGroup` string — Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.
      - `storageAccount` string — Gets the managed storage account resource identifier.
    - `managedResourcesPublicNetworkAccess` 'NotSpecified' | 'Enabled' | 'Disabled' — Gets or sets the public network access for managed resources
    - `mergeInfo` AccountMergeInfo — The public Account Merge Info model.
      - `accountLocation` string — The account location of the *other* account in the merge operation.
      - `accountName` string — The account name of the *other* account in the merge operation.
      - `accountResourceGroupName` string — The resource group name of the *other* account in the merge operation.
      - `accountSubscriptionId` string — The subscription id of the *other* account in the merge operation.
      - `mergeStatus` 'Succeeded' | 'Failed' | 'InProgress' — The status of the merge operation.
      - `typeOfAccount` 'Primary' | 'Secondary' — The type of account this account is for the merge operation.
    - `privateEndpointConnections` PrivateEndpointConnection[] — Gets the private endpoint connections information.
      - `id` string — Gets or sets the identifier.
      - `name` string — Gets or sets the name.
      - `properties` PrivateEndpointConnectionProperties — A private endpoint connection properties class.
        - `privateEndpoint` PrivateEndpoint — A private endpoint class.
          - `id` string — The private endpoint identifier.
        - `privateLinkServiceConnectionState` PrivateLinkServiceConnectionState — The private link service connection state.
          - `actionsRequired` string — The required actions.
          - `description` string — The description.
          - `status` 'Unknown' | 'Pending' | 'Approved' | 'Rejected' | 'Disconnected' — The status.
        - `provisioningState` string — The provisioning state.
      - `systemData` SystemData — Metadata pertaining to creation and last modification of the resource.
        - `createdAt` string, date-time — The timestamp of resource creation (UTC).
        - `createdBy` string — The identity that created the resource.
        - `createdByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key' — The type of identity that created the resource.
        - `lastModifiedAt` string, date-time — The timestamp of the last modification the resource (UTC).
        - `lastModifiedBy` string — The identity that last modified the resource.
        - `lastModifiedByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key' — The type of identity that last modified the resource.
      - `type` string — Gets or sets the type.
    - `provisioningState` 'Unknown' | 'Creating' | 'Moving' | 'Deleting' | 'SoftDeleting' | 'SoftDeleted' | 'Failed' | 'Succeeded' | 'Canceled' — Gets or sets the state of the provisioning.
    - `publicNetworkAccess` 'NotSpecified' | 'Enabled' | 'Disabled' — Gets or sets the public network access.
  - `sku` AccountSku — The Sku
    - `capacity` integer — Gets or sets the sku capacity.
    - `name` 'Standard' | 'Free' — Gets or sets the sku name.
  - `systemData` SystemData — Metadata pertaining to creation and last modification of the resource.
    - `createdAt` string, date-time — The timestamp of resource creation (UTC).
    - `createdBy` string — The identity that created the resource.
    - `createdByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key' — The type of identity that created the resource.
    - `lastModifiedAt` string, date-time — The timestamp of the last modification the resource (UTC).
    - `lastModifiedBy` string — The identity that last modified the resource.
    - `lastModifiedByType` 'User' | 'Application' | 'ManagedIdentity' | 'Key' — The type of identity that last modified the resource.
  - `tags` object — Tags on the azure resource.
  - `type` string — Gets or sets the type.

## Other responses

- `default` — An error response received from the provider.

---

[API](https://skmtc.net/azure/apis/purview-account.md) · [All operations](https://skmtc.net/azure/apis/purview-account/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/purview-account/versions/dc51c3b3ddf7/schema)