Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. cognitiveservices
  5. getProject
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
pulumi/pulumi-azure-native

azure-native.cognitiveservices.getProject

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
pulumi/pulumi-azure-native

Returns a Cognitive Services project specified by the parameters.

Uses Azure REST API version 2025-04-01-preview.

Using getProject

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 getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOptions): Output<GetProjectResult>
Copy
def get_project(account_name: Optional[str] = None,
                project_name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetProjectResult
def get_project_output(account_name: Optional[pulumi.Input[str]] = None,
                project_name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetProjectResult]
Copy
func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput
Copy

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

public static class GetProject 
{
    public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cognitiveservices:getProject
  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 Cognitive Services account.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
The name of Cognitive Services account's project.
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 Cognitive Services account.
ProjectName
This property is required.
Changes to this property will trigger replacement.
string
The name of Cognitive Services account's project.
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 Cognitive Services account.
projectName
This property is required.
Changes to this property will trigger replacement.
String
The name of Cognitive Services account's project.
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 Cognitive Services account.
projectName
This property is required.
Changes to this property will trigger replacement.
string
The name of Cognitive Services account's project.
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 Cognitive Services account.
project_name
This property is required.
Changes to this property will trigger replacement.
str
The name of Cognitive Services account's project.
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 Cognitive Services account.
projectName
This property is required.
Changes to this property will trigger replacement.
String
The name of Cognitive Services account's project.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.

getProject Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Etag string
Resource Etag.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties Pulumi.AzureNative.CognitiveServices.Outputs.ProjectPropertiesResponse
Properties of Cognitive Services project.
SystemData Pulumi.AzureNative.CognitiveServices.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.CognitiveServices.Outputs.IdentityResponse
Identity for the resource.
Location string
The geo-location where the resource lives
Tags Dictionary<string, string>
Resource tags.
AzureApiVersion string
The Azure API version of the resource.
Etag string
Resource Etag.
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string
The name of the resource
Properties ProjectPropertiesResponse
Properties of Cognitive Services project.
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 IdentityResponse
Identity for the resource.
Location string
The geo-location where the resource lives
Tags map[string]string
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
Resource Etag.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties ProjectPropertiesResponse
Properties of Cognitive Services project.
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 IdentityResponse
Identity for the resource.
location String
The geo-location where the resource lives
tags Map<String,String>
Resource tags.
azureApiVersion string
The Azure API version of the resource.
etag string
Resource Etag.
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string
The name of the resource
properties ProjectPropertiesResponse
Properties of Cognitive Services project.
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 IdentityResponse
Identity for the resource.
location string
The geo-location where the resource lives
tags {[key: string]: string}
Resource tags.
azure_api_version str
The Azure API version of the resource.
etag str
Resource Etag.
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str
The name of the resource
properties ProjectPropertiesResponse
Properties of Cognitive Services project.
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 IdentityResponse
Identity for the resource.
location str
The geo-location where the resource lives
tags Mapping[str, str]
Resource tags.
azureApiVersion String
The Azure API version of the resource.
etag String
Resource Etag.
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String
The name of the resource
properties Property Map
Properties of Cognitive Services project.
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
Identity for the resource.
location String
The geo-location where the resource lives
tags Map<String>
Resource tags.

Supporting Types

IdentityResponse

PrincipalId This property is required. string
The principal ID of resource identity.
TenantId This property is required. string
The tenant ID of resource.
Type string
The identity type.
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.CognitiveServices.Inputs.UserAssignedIdentityResponse>
The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}
PrincipalId This property is required. string
The principal ID of resource identity.
TenantId This property is required. string
The tenant ID of resource.
Type string
The identity type.
UserAssignedIdentities map[string]UserAssignedIdentityResponse
The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}
principalId This property is required. String
The principal ID of resource identity.
tenantId This property is required. String
The tenant ID of resource.
type String
The identity type.
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}
principalId This property is required. string
The principal ID of resource identity.
tenantId This property is required. string
The tenant ID of resource.
type string
The identity type.
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}
principal_id This property is required. str
The principal ID of resource identity.
tenant_id This property is required. str
The tenant ID of resource.
type str
The identity type.
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}
principalId This property is required. String
The principal ID of resource identity.
tenantId This property is required. String
The tenant ID of resource.
type String
The identity type.
userAssignedIdentities Map<Property Map>
The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ProjectPropertiesResponse

Endpoints This property is required. Dictionary<string, string>
The list of endpoint for this Cognitive Services Project.
IsDefault This property is required. bool
Indicates whether the project is the default project for the account.
ProvisioningState This property is required. string
Gets the status of the cognitive services project at the time the operation was called.
Description string
The description of the Cognitive Services Project.
DisplayName string
The display name of the Cognitive Services Project.
Endpoints This property is required. map[string]string
The list of endpoint for this Cognitive Services Project.
IsDefault This property is required. bool
Indicates whether the project is the default project for the account.
ProvisioningState This property is required. string
Gets the status of the cognitive services project at the time the operation was called.
Description string
The description of the Cognitive Services Project.
DisplayName string
The display name of the Cognitive Services Project.
endpoints This property is required. Map<String,String>
The list of endpoint for this Cognitive Services Project.
isDefault This property is required. Boolean
Indicates whether the project is the default project for the account.
provisioningState This property is required. String
Gets the status of the cognitive services project at the time the operation was called.
description String
The description of the Cognitive Services Project.
displayName String
The display name of the Cognitive Services Project.
endpoints This property is required. {[key: string]: string}
The list of endpoint for this Cognitive Services Project.
isDefault This property is required. boolean
Indicates whether the project is the default project for the account.
provisioningState This property is required. string
Gets the status of the cognitive services project at the time the operation was called.
description string
The description of the Cognitive Services Project.
displayName string
The display name of the Cognitive Services Project.
endpoints This property is required. Mapping[str, str]
The list of endpoint for this Cognitive Services Project.
is_default This property is required. bool
Indicates whether the project is the default project for the account.
provisioning_state This property is required. str
Gets the status of the cognitive services project at the time the operation was called.
description str
The description of the Cognitive Services Project.
display_name str
The display name of the Cognitive Services Project.
endpoints This property is required. Map<String>
The list of endpoint for this Cognitive Services Project.
isDefault This property is required. Boolean
Indicates whether the project is the default project for the account.
provisioningState This property is required. String
Gets the status of the cognitive services project at the time the operation was called.
description String
The description of the Cognitive Services Project.
displayName String
The display name of the Cognitive Services Project.

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
Client App Id associated with this identity.
PrincipalId This property is required. string
Azure Active Directory principal ID associated with this Identity.
ClientId This property is required. string
Client App Id associated with this identity.
PrincipalId This property is required. string
Azure Active Directory principal ID associated with this Identity.
clientId This property is required. String
Client App Id associated with this identity.
principalId This property is required. String
Azure Active Directory principal ID associated with this Identity.
clientId This property is required. string
Client App Id associated with this identity.
principalId This property is required. string
Azure Active Directory principal ID associated with this Identity.
client_id This property is required. str
Client App Id associated with this identity.
principal_id This property is required. str
Azure Active Directory principal ID associated with this Identity.
clientId This property is required. String
Client App Id associated with this identity.
principalId This property is required. String
Azure Active Directory principal ID associated with this 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
pulumi/pulumi-azure-native