1. Packages
  2. Azure Native
  3. API Docs
  4. recommendationsservice
  5. getAccount
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.recommendationsservice.getAccount

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

Returns RecommendationsService Account resource for a given name.

Uses Azure REST API version 2022-03-01-preview.

Other available API versions: 2022-02-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native recommendationsservice [ApiVersion]. See the version guide for details.

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>
Copy
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]
Copy
func LookupAccount(ctx *Context, args *LookupAccountArgs, opts ...InvokeOption) (*LookupAccountResult, error)
func LookupAccountOutput(ctx *Context, args *LookupAccountOutputArgs, opts ...InvokeOption) LookupAccountResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetAccountResult> getAccount(GetAccountArgs args, InvokeOptions options)
public static Output<GetAccountResult> getAccount(GetAccountArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:recommendationsservice:getAccount
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RecommendationsService Account resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
AccountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RecommendationsService Account resource.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the RecommendationsService Account resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
string
The name of the RecommendationsService Account resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
account_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the RecommendationsService Account resource.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
accountName
This property is required.
Changes to this property will trigger replacement.
String
The name of the RecommendationsService Account resource.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getAccount Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties Pulumi.AzureNative.RecommendationsService.Outputs.AccountResourceResponseProperties
Account resource properties.
SystemData Pulumi.AzureNative.RecommendationsService.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Identity Pulumi.AzureNative.RecommendationsService.Outputs.ManagedServiceIdentityResponse
The identity used for the resource.
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
Properties AccountResourceResponseProperties
Account resource properties.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Identity ManagedServiceIdentityResponse
The identity used for the resource.
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
properties AccountResourceResponseProperties
Account resource properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ManagedServiceIdentityResponse
The identity used for the resource.
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
properties AccountResourceResponseProperties
Account resource properties.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ManagedServiceIdentityResponse
The identity used for the resource.
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
properties AccountResourceResponseProperties
Account resource properties.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity ManagedServiceIdentityResponse
The identity used for the resource.
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
properties Property Map
Account resource properties.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
identity Property Map
The identity used for the resource.
tags Map<String>
Resource tags.

Supporting Types

AccountResourceResponseProperties

ProvisioningState This property is required. string
The resource provisioning state.
Configuration string
Account configuration. This can only be set at RecommendationsService Account creation.
Cors List<Pulumi.AzureNative.RecommendationsService.Inputs.CorsRuleResponse>
The list of CORS details.
EndpointAuthentications List<Pulumi.AzureNative.RecommendationsService.Inputs.EndpointAuthenticationResponse>
The list of service endpoints authentication details.
ReportsConnectionString string
Connection string to write Accounts reports to.
ProvisioningState This property is required. string
The resource provisioning state.
Configuration string
Account configuration. This can only be set at RecommendationsService Account creation.
Cors []CorsRuleResponse
The list of CORS details.
EndpointAuthentications []EndpointAuthenticationResponse
The list of service endpoints authentication details.
ReportsConnectionString string
Connection string to write Accounts reports to.
provisioningState This property is required. String
The resource provisioning state.
configuration String
Account configuration. This can only be set at RecommendationsService Account creation.
cors List<CorsRuleResponse>
The list of CORS details.
endpointAuthentications List<EndpointAuthenticationResponse>
The list of service endpoints authentication details.
reportsConnectionString String
Connection string to write Accounts reports to.
provisioningState This property is required. string
The resource provisioning state.
configuration string
Account configuration. This can only be set at RecommendationsService Account creation.
cors CorsRuleResponse[]
The list of CORS details.
endpointAuthentications EndpointAuthenticationResponse[]
The list of service endpoints authentication details.
reportsConnectionString string
Connection string to write Accounts reports to.
provisioning_state This property is required. str
The resource provisioning state.
configuration str
Account configuration. This can only be set at RecommendationsService Account creation.
cors Sequence[CorsRuleResponse]
The list of CORS details.
endpoint_authentications Sequence[EndpointAuthenticationResponse]
The list of service endpoints authentication details.
reports_connection_string str
Connection string to write Accounts reports to.
provisioningState This property is required. String
The resource provisioning state.
configuration String
Account configuration. This can only be set at RecommendationsService Account creation.
cors List<Property Map>
The list of CORS details.
endpointAuthentications List<Property Map>
The list of service endpoints authentication details.
reportsConnectionString String
Connection string to write Accounts reports to.

CorsRuleResponse

AllowedOrigins This property is required. List<string>
The origin domains that are permitted to make a request against the service via CORS.
AllowedHeaders List<string>
The request headers that the origin domain may specify on the CORS request.
AllowedMethods List<string>
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
ExposedHeaders List<string>
The response headers to expose to CORS clients.
MaxAgeInSeconds int
The number of seconds that the client/browser should cache a preflight response.
AllowedOrigins This property is required. []string
The origin domains that are permitted to make a request against the service via CORS.
AllowedHeaders []string
The request headers that the origin domain may specify on the CORS request.
AllowedMethods []string
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
ExposedHeaders []string
The response headers to expose to CORS clients.
MaxAgeInSeconds int
The number of seconds that the client/browser should cache a preflight response.
allowedOrigins This property is required. List<String>
The origin domains that are permitted to make a request against the service via CORS.
allowedHeaders List<String>
The request headers that the origin domain may specify on the CORS request.
allowedMethods List<String>
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposedHeaders List<String>
The response headers to expose to CORS clients.
maxAgeInSeconds Integer
The number of seconds that the client/browser should cache a preflight response.
allowedOrigins This property is required. string[]
The origin domains that are permitted to make a request against the service via CORS.
allowedHeaders string[]
The request headers that the origin domain may specify on the CORS request.
allowedMethods string[]
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposedHeaders string[]
The response headers to expose to CORS clients.
maxAgeInSeconds number
The number of seconds that the client/browser should cache a preflight response.
allowed_origins This property is required. Sequence[str]
The origin domains that are permitted to make a request against the service via CORS.
allowed_headers Sequence[str]
The request headers that the origin domain may specify on the CORS request.
allowed_methods Sequence[str]
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposed_headers Sequence[str]
The response headers to expose to CORS clients.
max_age_in_seconds int
The number of seconds that the client/browser should cache a preflight response.
allowedOrigins This property is required. List<String>
The origin domains that are permitted to make a request against the service via CORS.
allowedHeaders List<String>
The request headers that the origin domain may specify on the CORS request.
allowedMethods List<String>
The methods (HTTP request verbs) that the origin domain may use for a CORS request.
exposedHeaders List<String>
The response headers to expose to CORS clients.
maxAgeInSeconds Number
The number of seconds that the client/browser should cache a preflight response.

EndpointAuthenticationResponse

AadTenantID string
AAD tenant ID.
PrincipalID string
AAD principal ID.
PrincipalType string
AAD principal type.
AadTenantID string
AAD tenant ID.
PrincipalID string
AAD principal ID.
PrincipalType string
AAD principal type.
aadTenantID String
AAD tenant ID.
principalID String
AAD principal ID.
principalType String
AAD principal type.
aadTenantID string
AAD tenant ID.
principalID string
AAD principal ID.
principalType string
AAD principal type.
aad_tenant_id str
AAD tenant ID.
principal_id str
AAD principal ID.
principal_type str
AAD principal type.
aadTenantID String
AAD tenant ID.
principalID String
AAD principal ID.
principalType String
AAD principal type.

ManagedServiceIdentityResponse

PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.RecommendationsService.Inputs.UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principal_id This property is required. str
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. str
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

SystemDataResponse

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 resource last modification (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 resource last modification (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 resource last modification (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 resource last modification (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 resource last modification (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 resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserAssignedIdentityResponse

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi