PurviewAccountClient.GetAccountPropertiesAsync(RequestOptions) Method

Reference

Definition

Namespace:: Azure.Analytics.Purview.Administration

Assembly:: Azure.Analytics.Purview.Administration.dll

Package:: Azure.Analytics.Purview.Administration v1.0.0-beta.1

Source:: PurviewAccountClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get an account.

public virtual System.Threading.Tasks.Task<Azure.Response> GetAccountPropertiesAsync (Azure.RequestOptions options);

abstract member GetAccountPropertiesAsync : Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>
override this.GetAccountPropertiesAsync : Azure.RequestOptions -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function GetAccountPropertiesAsync (options As RequestOptions) As Task(Of Response)

Parameters

options: Azure.RequestOptions

The request options.

Returns

Task<Response>

Remarks

Schema for Response Body:

{
              id: string,
              identity: {
                principalId: string,
                tenantId: string,
                type: "SystemAssigned"
              },
              location: string,
              name: string,
              properties: {
                cloudConnectors: {
                  awsExternalId: string
                },
                createdAt: string (ISO 8601 Format),
                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: "Unknown" | "Pending" | "Approved" | "Rejected" | "Disconnected"
                      },
                      provisioningState: string
                    },
                    type: string
                  }
                ],
                provisioningState: "Unknown" | "Creating" | "Moving" | "Deleting" | "SoftDeleting" | "SoftDeleted" | "Failed" | "Succeeded" | "Canceled",
                publicNetworkAccess: "NotSpecified" | "Enabled" | "Disabled"
              },
              sku: {
                capacity: number,
                name: "Standard"
              },
              systemData: {
                createdAt: string (ISO 8601 Format),
                createdBy: string,
                createdByType: "User" | "Application" | "ManagedIdentity" | "Key",
                lastModifiedAt: string (ISO 8601 Format),
                lastModifiedBy: string,
                lastModifiedByType: "User" | "Application" | "ManagedIdentity" | "Key"
              },
              tags: Dictionary<string, string>,
              type: string
            }

Schema for Response Error:

{
              error: {
                code: string,
                details: [
                  {
                    code: string,
                    details: [ErrorModel],
                    message: string,
                    target: string
                  }
                ],
                message: string,
                target: string
              }
            }

Applies to

Share via