Azure Native v1.98.1, Mar 24 23

azure-native.purview.getAccount

Get an account API Version: 2020-12-01-preview.

Using getAccount

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAccount(args: GetAccountArgs, opts?: InvokeOptions): Promise<GetAccountResult>
function getAccountOutput(args: GetAccountOutputArgs, opts?: InvokeOptions): Output<GetAccountResult>

def get_account(account_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetAccountResult
def get_account_output(account_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetAccountResult]

func LookupAccount(ctx *Context, args *LookupAccountArgs, opts ...InvokeOption) (*LookupAccountResult, error)
func LookupAccountOutput(ctx *Context, args *LookupAccountOutputArgs, opts ...InvokeOption) LookupAccountResultOutput

> Note: This function is named LookupAccount in the Go SDK.

public static class GetAccount 
{
    public static Task<GetAccountResult> InvokeAsync(GetAccountArgs args, InvokeOptions? opts = null)
    public static Output<GetAccountResult> Invoke(GetAccountInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAccountResult> getAccount(GetAccountArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:purview:getAccount
  arguments:
    # arguments dictionary

The following arguments are supported:

AccountName string: The name of the account.
ResourceGroupName string: The resource group name.

AccountName string: The name of the account.
ResourceGroupName string: The resource group name.

accountName String: The name of the account.
resourceGroupName String: The resource group name.

accountName string: The name of the account.
resourceGroupName string: The resource group name.

account_name str: The name of the account.
resource_group_name str: The resource group name.

accountName String: The name of the account.
resourceGroupName String: The resource group name.

getAccount Result

The following output properties are available:

CreatedAt string: 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.
Endpoints Pulumi.AzureNative.Purview.Outputs.AccountPropertiesResponseEndpoints: The URIs that are the public endpoints of the account.
FriendlyName string: Gets or sets the friendly name.
Id string: Gets or sets the identifier.
ManagedResources Pulumi.AzureNative.Purview.Outputs.AccountPropertiesResponseManagedResources: Gets the resource identifiers of the managed resources.
Name string: Gets or sets the name.
PrivateEndpointConnections List<Pulumi.AzureNative.Purview.Outputs.PrivateEndpointConnectionResponse>: Gets the private endpoint connections information.
ProvisioningState string: Gets or sets the state of the provisioning.
Sku Pulumi.AzureNative.Purview.Outputs.AccountResponseSku: Gets or sets the Sku.
SystemData Pulumi.AzureNative.Purview.Outputs.AccountPropertiesResponseSystemData: Metadata pertaining to creation and last modification of the resource.
Type string: Gets or sets the type.
CloudConnectors Pulumi.AzureNative.Purview.Outputs.CloudConnectorsResponse: Cloud connectors. External cloud identifier used as part of scanning configuration.
Identity Pulumi.AzureNative.Purview.Outputs.IdentityResponse: Identity Info on the tracked resource
Location string: Gets or sets the location.
ManagedResourceGroupName string: Gets or sets the managed resource group name
PublicNetworkAccess string: Gets or sets the public network access.
Tags Dictionary<string, string>: Tags on the azure resource.

CreatedAt string: 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.
Endpoints AccountPropertiesResponseEndpoints: The URIs that are the public endpoints of the account.
FriendlyName string: Gets or sets the friendly name.
Id string: Gets or sets the identifier.
ManagedResources AccountPropertiesResponseManagedResources: Gets the resource identifiers of the managed resources.
Name string: Gets or sets the name.
PrivateEndpointConnections []PrivateEndpointConnectionResponse: Gets the private endpoint connections information.
ProvisioningState string: Gets or sets the state of the provisioning.
Sku AccountResponseSku: Gets or sets the Sku.
SystemData AccountPropertiesResponseSystemData: Metadata pertaining to creation and last modification of the resource.
Type string: Gets or sets the type.
CloudConnectors CloudConnectorsResponse: Cloud connectors. External cloud identifier used as part of scanning configuration.
Identity IdentityResponse: Identity Info on the tracked resource
Location string: Gets or sets the location.
ManagedResourceGroupName string: Gets or sets the managed resource group name
PublicNetworkAccess string: Gets or sets the public network access.
Tags map[string]string: Tags on the azure resource.

createdAt String: 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.
endpoints AccountPropertiesResponseEndpoints: The URIs that are the public endpoints of the account.
friendlyName String: Gets or sets the friendly name.
id String: Gets or sets the identifier.
managedResources AccountPropertiesResponseManagedResources: Gets the resource identifiers of the managed resources.
name String: Gets or sets the name.
privateEndpointConnections List<PrivateEndpointConnectionResponse>: Gets the private endpoint connections information.
provisioningState String: Gets or sets the state of the provisioning.
sku AccountResponseSku: Gets or sets the Sku.
systemData AccountPropertiesResponseSystemData: Metadata pertaining to creation and last modification of the resource.
type String: Gets or sets the type.
cloudConnectors CloudConnectorsResponse: Cloud connectors. External cloud identifier used as part of scanning configuration.
identity IdentityResponse: Identity Info on the tracked resource
location String: Gets or sets the location.
managedResourceGroupName String: Gets or sets the managed resource group name
publicNetworkAccess String: Gets or sets the public network access.
tags Map<String,String>: Tags on the azure resource.

createdAt string: 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.
endpoints AccountPropertiesResponseEndpoints: The URIs that are the public endpoints of the account.
friendlyName string: Gets or sets the friendly name.
id string: Gets or sets the identifier.
managedResources AccountPropertiesResponseManagedResources: Gets the resource identifiers of the managed resources.
name string: Gets or sets the name.
privateEndpointConnections PrivateEndpointConnectionResponse[]: Gets the private endpoint connections information.
provisioningState string: Gets or sets the state of the provisioning.
sku AccountResponseSku: Gets or sets the Sku.
systemData AccountPropertiesResponseSystemData: Metadata pertaining to creation and last modification of the resource.
type string: Gets or sets the type.
cloudConnectors CloudConnectorsResponse: Cloud connectors. External cloud identifier used as part of scanning configuration.
identity IdentityResponse: Identity Info on the tracked resource
location string: Gets or sets the location.
managedResourceGroupName string: Gets or sets the managed resource group name
publicNetworkAccess string: Gets or sets the public network access.
tags {[key: string]: string}: Tags on the azure resource.

created_at str: Gets the time at which the entity was created.
created_by str: Gets the creator of the entity.
created_by_object_id str: Gets the creators of the entity's object id.
endpoints AccountPropertiesResponseEndpoints: The URIs that are the public endpoints of the account.
friendly_name str: Gets or sets the friendly name.
id str: Gets or sets the identifier.
managed_resources AccountPropertiesResponseManagedResources: Gets the resource identifiers of the managed resources.
name str: Gets or sets the name.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]: Gets the private endpoint connections information.
provisioning_state str: Gets or sets the state of the provisioning.
sku AccountResponseSku: Gets or sets the Sku.
system_data AccountPropertiesResponseSystemData: Metadata pertaining to creation and last modification of the resource.
type str: Gets or sets the type.
cloud_connectors CloudConnectorsResponse: Cloud connectors. External cloud identifier used as part of scanning configuration.
identity IdentityResponse: Identity Info on the tracked resource
location str: Gets or sets the location.
managed_resource_group_name str: Gets or sets the managed resource group name
public_network_access str: Gets or sets the public network access.
tags Mapping[str, str]: Tags on the azure resource.

createdAt String: 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.
endpoints Property Map: The URIs that are the public endpoints of the account.
friendlyName String: Gets or sets the friendly name.
id String: Gets or sets the identifier.
managedResources Property Map: Gets the resource identifiers of the managed resources.
name String: Gets or sets the name.
privateEndpointConnections List<Property Map>: Gets the private endpoint connections information.
provisioningState String: Gets or sets the state of the provisioning.
sku Property Map: Gets or sets the Sku.
systemData Property Map: Metadata pertaining to creation and last modification of the resource.
type String: Gets or sets the type.
cloudConnectors Property Map: Cloud connectors. External cloud identifier used as part of scanning configuration.
identity Property Map: Identity Info on the tracked resource
location String: Gets or sets the location.
managedResourceGroupName String: Gets or sets the managed resource group name
publicNetworkAccess String: Gets or sets the public network access.
tags Map<String>: Tags on the azure resource.

Supporting Types

AccountPropertiesResponseEndpoints

Catalog string: Gets the catalog endpoint.
Guardian string: Gets the guardian endpoint.
Scan string: Gets the scan endpoint.

Catalog string: Gets the catalog endpoint.
Guardian string: Gets the guardian endpoint.
Scan string: Gets the scan endpoint.

catalog String: Gets the catalog endpoint.
guardian String: Gets the guardian endpoint.
scan String: Gets the scan endpoint.

catalog string: Gets the catalog endpoint.
guardian string: Gets the guardian endpoint.
scan string: Gets the scan endpoint.

catalog str: Gets the catalog endpoint.
guardian str: Gets the guardian endpoint.
scan str: Gets the scan endpoint.

catalog String: Gets the catalog endpoint.
guardian String: Gets the guardian endpoint.
scan String: Gets the scan endpoint.

AccountPropertiesResponseManagedResources

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.

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.

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.

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.

event_hub_namespace str: Gets the managed event hub namespace resource identifier.
resource_group str: Gets the managed resource group resource identifier. This resource group will host resource dependencies for the account.
storage_account str: Gets the managed storage account resource identifier.

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.

AccountPropertiesResponseSystemData

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of the last modification the resource (UTC).
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

CreatedAt string: The timestamp of resource creation (UTC).
CreatedBy string: The identity that created the resource.
CreatedByType string: The type of identity that created the resource.
LastModifiedAt string: The timestamp of the last modification the resource (UTC).
LastModifiedBy string: The identity that last modified the resource.
LastModifiedByType string: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of the last modification the resource (UTC).
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

createdAt string: The timestamp of resource creation (UTC).
createdBy string: The identity that created the resource.
createdByType string: The type of identity that created the resource.
lastModifiedAt string: The timestamp of the last modification the resource (UTC).
lastModifiedBy string: The identity that last modified the resource.
lastModifiedByType string: The type of identity that last modified the resource.

created_at str: The timestamp of resource creation (UTC).
created_by str: The identity that created the resource.
created_by_type str: The type of identity that created the resource.
last_modified_at str: The timestamp of the last modification the resource (UTC).
last_modified_by str: The identity that last modified the resource.
last_modified_by_type str: The type of identity that last modified the resource.

createdAt String: The timestamp of resource creation (UTC).
createdBy String: The identity that created the resource.
createdByType String: The type of identity that created the resource.
lastModifiedAt String: The timestamp of the last modification the resource (UTC).
lastModifiedBy String: The identity that last modified the resource.
lastModifiedByType String: The type of identity that last modified the resource.

AccountResponseSku

Capacity int: Gets or sets the sku capacity.
Name string: Gets or sets the sku name.

Capacity int: Gets or sets the sku capacity.
Name string: Gets or sets the sku name.

capacity Integer: Gets or sets the sku capacity.
name String: Gets or sets the sku name.

capacity number: Gets or sets the sku capacity.
name string: Gets or sets the sku name.

capacity int: Gets or sets the sku capacity.
name str: Gets or sets the sku name.

capacity Number: Gets or sets the sku capacity.
name String: Gets or sets the sku name.

CloudConnectorsResponse

AwsExternalId string: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning

AwsExternalId string: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning

awsExternalId String: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning

awsExternalId string: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning

aws_external_id str: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning

awsExternalId String: AWS external identifier. Configured in AWS to allow use of the role arn used for scanning

IdentityResponse

PrincipalId string: Service principal object Id
TenantId string: Tenant Id
Type string: Identity Type

PrincipalId string: Service principal object Id
TenantId string: Tenant Id
Type string: Identity Type

principalId String: Service principal object Id
tenantId String: Tenant Id
type String: Identity Type

principalId string: Service principal object Id
tenantId string: Tenant Id
type string: Identity Type

principal_id str: Service principal object Id
tenant_id str: Tenant Id
type str: Identity Type

principalId String: Service principal object Id
tenantId String: Tenant Id
type String: Identity Type

PrivateEndpointConnectionResponse

Id string: Gets or sets the identifier.
Name string: Gets or sets the name.
ProvisioningState string: The provisioning state.
Type string: Gets or sets the type.
PrivateEndpoint Pulumi.AzureNative.Purview.Inputs.PrivateEndpointResponse: The private endpoint information.
PrivateLinkServiceConnectionState Pulumi.AzureNative.Purview.Inputs.PrivateLinkServiceConnectionStateResponse: The private link service connection state.

Id string: Gets or sets the identifier.
Name string: Gets or sets the name.
ProvisioningState string: The provisioning state.
Type string: Gets or sets the type.
PrivateEndpoint PrivateEndpointResponse: The private endpoint information.
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: The private link service connection state.

id String: Gets or sets the identifier.
name String: Gets or sets the name.
provisioningState String: The provisioning state.
type String: Gets or sets the type.
privateEndpoint PrivateEndpointResponse: The private endpoint information.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: The private link service connection state.

id string: Gets or sets the identifier.
name string: Gets or sets the name.
provisioningState string: The provisioning state.
type string: Gets or sets the type.
privateEndpoint PrivateEndpointResponse: The private endpoint information.
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: The private link service connection state.

id str: Gets or sets the identifier.
name str: Gets or sets the name.
provisioning_state str: The provisioning state.
type str: Gets or sets the type.
private_endpoint PrivateEndpointResponse: The private endpoint information.
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse: The private link service connection state.

id String: Gets or sets the identifier.
name String: Gets or sets the name.
provisioningState String: The provisioning state.
type String: Gets or sets the type.
privateEndpoint Property Map: The private endpoint information.
privateLinkServiceConnectionState Property Map: The private link service connection state.

PrivateEndpointResponse

Id string: The private endpoint identifier.

Id string: The private endpoint identifier.

id String: The private endpoint identifier.

id string: The private endpoint identifier.

id str: The private endpoint identifier.

id String: The private endpoint identifier.

PrivateLinkServiceConnectionStateResponse

ActionsRequired string: The required actions.
Description string: The description.
Status string: The status.

ActionsRequired string: The required actions.
Description string: The description.
Status string: The status.

actionsRequired String: The required actions.
description String: The description.
status String: The status.

actionsRequired string: The required actions.
description string: The description.
status string: The status.

actions_required str: The required actions.
description str: The description.
status str: The status.

actionsRequired String: The required actions.
description String: The description.
status String: The status.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0