Returns a Cognitive Services project specified by the parameters.
Uses Azure REST API version 2025-04-01-preview.
Other available API versions: 2025-06-01, 2025-07-01-preview, 2025-09-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native cognitiveservices [ApiVersion]. See the version guide for details.
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>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]func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput> 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)
}public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
fn::invoke:
function: azure-native:cognitiveservices:getProject
arguments:
# arguments dictionaryThe following arguments are supported:
- Account
Name string - The name of Cognitive Services account.
- Project
Name string - The name of Cognitive Services account's project.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Account
Name string - The name of Cognitive Services account.
- Project
Name string - The name of Cognitive Services account's project.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- account
Name String - The name of Cognitive Services account.
- project
Name String - The name of Cognitive Services account's project.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- account
Name string - The name of Cognitive Services account.
- project
Name string - The name of Cognitive Services account's project.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- account_
name str - The name of Cognitive Services account.
- project_
name str - The name of Cognitive Services account's project.
- resource_
group_ strname - The name of the resource group. The name is case insensitive.
- account
Name String - The name of Cognitive Services account.
- project
Name String - The name of Cognitive Services account's project.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
getProject Result
The following output properties are available:
- Azure
Api stringVersion - 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.
Azure Native. Cognitive Services. Outputs. Project Properties Response - Properties of Cognitive Services project.
- System
Data Pulumi.Azure Native. Cognitive Services. Outputs. System Data Response - 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.
Azure Native. Cognitive Services. Outputs. Identity Response - Identity for the resource.
- Location string
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- Azure
Api stringVersion - 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
Project
Properties Response - Properties of Cognitive Services project.
- System
Data SystemData Response - 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
Identity
Response - Identity for the resource.
- Location string
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- azure
Api StringVersion - 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
Project
Properties Response - Properties of Cognitive Services project.
- system
Data SystemData Response - 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
Identity
Response - Identity for the resource.
- location String
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- azure
Api stringVersion - 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
Project
Properties Response - Properties of Cognitive Services project.
- system
Data SystemData Response - 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
Identity
Response - Identity for the resource.
- location string
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- azure_
api_ strversion - 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
Project
Properties Response - Properties of Cognitive Services project.
- system_
data SystemData Response - 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
Identity
Response - Identity for the resource.
- location str
- The geo-location where the resource lives
- Mapping[str, str]
- Resource tags.
- azure
Api StringVersion - 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.
- system
Data 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
- Map<String>
- Resource tags.
Supporting Types
IdentityResponse
- Principal
Id string - The principal ID of resource identity.
- Tenant
Id string - The tenant ID of resource.
- Type string
- The identity type.
- User
Assigned Dictionary<string, Pulumi.Identities Azure Native. Cognitive Services. Inputs. User Assigned Identity Response> - 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 string - The principal ID of resource identity.
- Tenant
Id string - The tenant ID of resource.
- Type string
- The identity type.
- User
Assigned map[string]UserIdentities Assigned Identity Response - 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 String - The principal ID of resource identity.
- tenant
Id String - The tenant ID of resource.
- type String
- The identity type.
- user
Assigned Map<String,UserIdentities Assigned Identity Response> - 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 string - The principal ID of resource identity.
- tenant
Id string - The tenant ID of resource.
- type string
- The identity type.
- user
Assigned {[key: string]: UserIdentities Assigned Identity Response} - 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 str - The principal ID of resource identity.
- tenant_
id str - The tenant ID of resource.
- type str
- The identity type.
- user_
assigned_ Mapping[str, Useridentities Assigned Identity Response] - 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 String - The principal ID of resource identity.
- tenant
Id String - The tenant ID of resource.
- type String
- The identity type.
- user
Assigned Map<Property Map>Identities - 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 Dictionary<string, string>
- The list of endpoint for this Cognitive Services Project.
- Is
Default bool - Indicates whether the project is the default project for the account.
- Provisioning
State 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.
- Display
Name string - The display name of the Cognitive Services Project.
- Endpoints map[string]string
- The list of endpoint for this Cognitive Services Project.
- Is
Default bool - Indicates whether the project is the default project for the account.
- Provisioning
State 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.
- Display
Name string - The display name of the Cognitive Services Project.
- endpoints Map<String,String>
- The list of endpoint for this Cognitive Services Project.
- is
Default Boolean - Indicates whether the project is the default project for the account.
- provisioning
State 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.
- display
Name String - The display name of the Cognitive Services Project.
- endpoints {[key: string]: string}
- The list of endpoint for this Cognitive Services Project.
- is
Default boolean - Indicates whether the project is the default project for the account.
- provisioning
State 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.
- display
Name string - The display name of the Cognitive Services Project.
- endpoints Mapping[str, str]
- The list of endpoint for this Cognitive Services Project.
- is_
default bool - Indicates whether the project is the default project for the account.
- provisioning_
state 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 Map<String>
- The list of endpoint for this Cognitive Services Project.
- is
Default Boolean - Indicates whether the project is the default project for the account.
- provisioning
State 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.
- display
Name String - The display name of the Cognitive Services Project.
SystemDataResponse
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UserAssignedIdentityResponse
- Client
Id string - Client App Id associated with this identity.
- Principal
Id string - Azure Active Directory principal ID associated with this Identity.
- Client
Id string - Client App Id associated with this identity.
- Principal
Id string - Azure Active Directory principal ID associated with this Identity.
- client
Id String - Client App Id associated with this identity.
- principal
Id String - Azure Active Directory principal ID associated with this Identity.
- client
Id string - Client App Id associated with this identity.
- principal
Id string - Azure Active Directory principal ID associated with this Identity.
- client_
id str - Client App Id associated with this identity.
- principal_
id str - Azure Active Directory principal ID associated with this Identity.
- client
Id String - Client App Id associated with this identity.
- principal
Id String - Azure Active Directory principal ID associated with this Identity.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0
