1. Packages
  2. Azure Native
  3. API Docs
  4. cognitiveservices
  5. getProjectConnection
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.cognitiveservices.getProjectConnection

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

Connection base resource schema.

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

Using getProjectConnection

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 getProjectConnection(args: GetProjectConnectionArgs, opts?: InvokeOptions): Promise<GetProjectConnectionResult>
function getProjectConnectionOutput(args: GetProjectConnectionOutputArgs, opts?: InvokeOptions): Output<GetProjectConnectionResult>
Copy
def get_project_connection(account_name: Optional[str] = None,
                           connection_name: Optional[str] = None,
                           project_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetProjectConnectionResult
def get_project_connection_output(account_name: Optional[pulumi.Input[str]] = None,
                           connection_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[GetProjectConnectionResult]
Copy
func LookupProjectConnection(ctx *Context, args *LookupProjectConnectionArgs, opts ...InvokeOption) (*LookupProjectConnectionResult, error)
func LookupProjectConnectionOutput(ctx *Context, args *LookupProjectConnectionOutputArgs, opts ...InvokeOption) LookupProjectConnectionResultOutput
Copy

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

public static class GetProjectConnection 
{
    public static Task<GetProjectConnectionResult> InvokeAsync(GetProjectConnectionArgs args, InvokeOptions? opts = null)
    public static Output<GetProjectConnectionResult> Invoke(GetProjectConnectionInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetProjectConnectionResult> getProjectConnection(GetProjectConnectionArgs args, InvokeOptions options)
public static Output<GetProjectConnectionResult> getProjectConnection(GetProjectConnectionArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:cognitiveservices:getProjectConnection
  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.
ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Friendly name of the connection
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.
ConnectionName
This property is required.
Changes to this property will trigger replacement.
string
Friendly name of the connection
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.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
Friendly name of the connection
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.
connectionName
This property is required.
Changes to this property will trigger replacement.
string
Friendly name of the connection
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.
connection_name
This property is required.
Changes to this property will trigger replacement.
str
Friendly name of the connection
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.
connectionName
This property is required.
Changes to this property will trigger replacement.
String
Friendly name of the connection
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.

getProjectConnection 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}
Name string
The name of the resource
Properties Pulumi.AzureNative.CognitiveServices.Outputs.AADAuthTypeConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.AccessKeyAuthTypeConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.AccountKeyAuthTypeConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.ApiKeyAuthConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.CustomKeysConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.ManagedIdentityAuthTypeConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.NoneAuthTypeConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.OAuth2AuthTypeConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.PATAuthTypeConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.SASAuthTypeConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.ServicePrincipalAuthTypeConnectionPropertiesResponse | Pulumi.AzureNative.CognitiveServices.Outputs.UsernamePasswordAuthTypeConnectionPropertiesResponse
Connection property base schema.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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}
Name string
The name of the resource
Properties AADAuthTypeConnectionPropertiesResponse | AccessKeyAuthTypeConnectionPropertiesResponse | AccountKeyAuthTypeConnectionPropertiesResponse | ApiKeyAuthConnectionPropertiesResponse | CustomKeysConnectionPropertiesResponse | ManagedIdentityAuthTypeConnectionPropertiesResponse | NoneAuthTypeConnectionPropertiesResponse | OAuth2AuthTypeConnectionPropertiesResponse | PATAuthTypeConnectionPropertiesResponse | SASAuthTypeConnectionPropertiesResponse | ServicePrincipalAuthTypeConnectionPropertiesResponse | UsernamePasswordAuthTypeConnectionPropertiesResponse
Connection property base schema.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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}
name String
The name of the resource
properties AADAuthTypeConnectionPropertiesResponse | AccessKeyAuthTypeConnectionPropertiesResponse | AccountKeyAuthTypeConnectionPropertiesResponse | ApiKeyAuthConnectionPropertiesResponse | CustomKeysConnectionPropertiesResponse | ManagedIdentityAuthTypeConnectionPropertiesResponse | NoneAuthTypeConnectionPropertiesResponse | OAuth2AuthTypeConnectionPropertiesResponse | PATAuthTypeConnectionPropertiesResponse | SASAuthTypeConnectionPropertiesResponse | ServicePrincipalAuthTypeConnectionPropertiesResponse | UsernamePasswordAuthTypeConnectionPropertiesResponse
Connection property base schema.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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}
name string
The name of the resource
properties AADAuthTypeConnectionPropertiesResponse | AccessKeyAuthTypeConnectionPropertiesResponse | AccountKeyAuthTypeConnectionPropertiesResponse | ApiKeyAuthConnectionPropertiesResponse | CustomKeysConnectionPropertiesResponse | ManagedIdentityAuthTypeConnectionPropertiesResponse | NoneAuthTypeConnectionPropertiesResponse | OAuth2AuthTypeConnectionPropertiesResponse | PATAuthTypeConnectionPropertiesResponse | SASAuthTypeConnectionPropertiesResponse | ServicePrincipalAuthTypeConnectionPropertiesResponse | UsernamePasswordAuthTypeConnectionPropertiesResponse
Connection property base schema.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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}
name str
The name of the resource
properties AADAuthTypeConnectionPropertiesResponse | AccessKeyAuthTypeConnectionPropertiesResponse | AccountKeyAuthTypeConnectionPropertiesResponse | ApiKeyAuthConnectionPropertiesResponse | CustomKeysConnectionPropertiesResponse | ManagedIdentityAuthTypeConnectionPropertiesResponse | NoneAuthTypeConnectionPropertiesResponse | OAuth2AuthTypeConnectionPropertiesResponse | PATAuthTypeConnectionPropertiesResponse | SASAuthTypeConnectionPropertiesResponse | ServicePrincipalAuthTypeConnectionPropertiesResponse | UsernamePasswordAuthTypeConnectionPropertiesResponse
Connection property base schema.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
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}
name String
The name of the resource
properties Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map | Property Map
Connection property base schema.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Supporting Types

AADAuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

AccessKeyAuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.ConnectionAccessKeyResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials ConnectionAccessKeyResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials ConnectionAccessKeyResponse
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials ConnectionAccessKeyResponse
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials ConnectionAccessKeyResponse
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

AccountKeyAuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.ConnectionAccountKeyResponse
Account key object for connection credential.
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials ConnectionAccountKeyResponse
Account key object for connection credential.
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials ConnectionAccountKeyResponse
Account key object for connection credential.
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials ConnectionAccountKeyResponse
Account key object for connection credential.
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials ConnectionAccountKeyResponse
Account key object for connection credential.
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
Account key object for connection credential.
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

ApiKeyAuthConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.ConnectionApiKeyResponse
Api key object for connection credential.
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials ConnectionApiKeyResponse
Api key object for connection credential.
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials ConnectionApiKeyResponse
Api key object for connection credential.
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials ConnectionApiKeyResponse
Api key object for connection credential.
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials ConnectionApiKeyResponse
Api key object for connection credential.
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
Api key object for connection credential.
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

ConnectionAccessKeyResponse

ConnectionAccountKeyResponse

Key string
Key string
key String
key string
key str
key String

ConnectionApiKeyResponse

Key string
Key string
key String
key string
key str
key String

ConnectionManagedIdentityResponse

ClientId string
ResourceId string
ClientId string
ResourceId string
clientId String
resourceId String
clientId string
resourceId string
clientId String
resourceId String

ConnectionOAuth2Response

AuthUrl string
Required by Concur connection category
ClientId string
Client id in the format of UUID
ClientSecret string
DeveloperToken string
Required by GoogleAdWords connection category
Password string
RefreshToken string
Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho where user needs to get RefreshToken offline
TenantId string
Required by QuickBooks and Xero connection categories
Username string
Concur, ServiceNow auth server AccessToken grant type is 'Password' which requires UsernamePassword
AuthUrl string
Required by Concur connection category
ClientId string
Client id in the format of UUID
ClientSecret string
DeveloperToken string
Required by GoogleAdWords connection category
Password string
RefreshToken string
Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho where user needs to get RefreshToken offline
TenantId string
Required by QuickBooks and Xero connection categories
Username string
Concur, ServiceNow auth server AccessToken grant type is 'Password' which requires UsernamePassword
authUrl String
Required by Concur connection category
clientId String
Client id in the format of UUID
clientSecret String
developerToken String
Required by GoogleAdWords connection category
password String
refreshToken String
Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho where user needs to get RefreshToken offline
tenantId String
Required by QuickBooks and Xero connection categories
username String
Concur, ServiceNow auth server AccessToken grant type is 'Password' which requires UsernamePassword
authUrl string
Required by Concur connection category
clientId string
Client id in the format of UUID
clientSecret string
developerToken string
Required by GoogleAdWords connection category
password string
refreshToken string
Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho where user needs to get RefreshToken offline
tenantId string
Required by QuickBooks and Xero connection categories
username string
Concur, ServiceNow auth server AccessToken grant type is 'Password' which requires UsernamePassword
auth_url str
Required by Concur connection category
client_id str
Client id in the format of UUID
client_secret str
developer_token str
Required by GoogleAdWords connection category
password str
refresh_token str
Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho where user needs to get RefreshToken offline
tenant_id str
Required by QuickBooks and Xero connection categories
username str
Concur, ServiceNow auth server AccessToken grant type is 'Password' which requires UsernamePassword
authUrl String
Required by Concur connection category
clientId String
Client id in the format of UUID
clientSecret String
developerToken String
Required by GoogleAdWords connection category
password String
refreshToken String
Required by GoogleBigQuery, GoogleAdWords, Hubspot, QuickBooks, Square, Xero, Zoho where user needs to get RefreshToken offline
tenantId String
Required by QuickBooks and Xero connection categories
username String
Concur, ServiceNow auth server AccessToken grant type is 'Password' which requires UsernamePassword

ConnectionPersonalAccessTokenResponse

Pat string
Pat string
pat String
pat string
pat str
pat String

ConnectionServicePrincipalResponse

ClientId string
ClientSecret string
TenantId string
ClientId string
ClientSecret string
TenantId string
clientId String
clientSecret String
tenantId String
clientId string
clientSecret string
tenantId string
clientId String
clientSecret String
tenantId String

ConnectionSharedAccessSignatureResponse

Sas string
Sas string
sas String
sas string
sas str
sas String

ConnectionUsernamePasswordResponse

Password string
SecurityToken string
Optional, required by connections like SalesForce for extra security in addition to UsernamePassword
Username string
Password string
SecurityToken string
Optional, required by connections like SalesForce for extra security in addition to UsernamePassword
Username string
password String
securityToken String
Optional, required by connections like SalesForce for extra security in addition to UsernamePassword
username String
password string
securityToken string
Optional, required by connections like SalesForce for extra security in addition to UsernamePassword
username string
password str
security_token str
Optional, required by connections like SalesForce for extra security in addition to UsernamePassword
username str
password String
securityToken String
Optional, required by connections like SalesForce for extra security in addition to UsernamePassword
username String

CustomKeysConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.CustomKeysResponse
Custom Keys credential object
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials CustomKeysResponse
Custom Keys credential object
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials CustomKeysResponse
Custom Keys credential object
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials CustomKeysResponse
Custom Keys credential object
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials CustomKeysResponse
Custom Keys credential object
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
Custom Keys credential object
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

CustomKeysResponse

Keys Dictionary<string, string>
Keys map[string]string
keys Map<String,String>
keys {[key: string]: string}
keys Mapping[str, str]
keys Map<String>

ManagedIdentityAuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.ConnectionManagedIdentityResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials ConnectionManagedIdentityResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials ConnectionManagedIdentityResponse
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials ConnectionManagedIdentityResponse
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials ConnectionManagedIdentityResponse
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

NoneAuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

OAuth2AuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.ConnectionOAuth2Response
ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider's implementation.
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials ConnectionOAuth2Response
ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider's implementation.
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials ConnectionOAuth2Response
ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider's implementation.
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials ConnectionOAuth2Response
ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider's implementation.
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials ConnectionOAuth2Response
ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider's implementation.
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider's implementation.
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

PATAuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.ConnectionPersonalAccessTokenResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials ConnectionPersonalAccessTokenResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials ConnectionPersonalAccessTokenResponse
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials ConnectionPersonalAccessTokenResponse
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials ConnectionPersonalAccessTokenResponse
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

SASAuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.ConnectionSharedAccessSignatureResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials ConnectionSharedAccessSignatureResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials ConnectionSharedAccessSignatureResponse
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials ConnectionSharedAccessSignatureResponse
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials ConnectionSharedAccessSignatureResponse
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

ServicePrincipalAuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.ConnectionServicePrincipalResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials ConnectionServicePrincipalResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials ConnectionServicePrincipalResponse
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials ConnectionServicePrincipalResponse
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials ConnectionServicePrincipalResponse
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

UsernamePasswordAuthTypeConnectionPropertiesResponse

CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials Pulumi.AzureNative.CognitiveServices.Inputs.ConnectionUsernamePasswordResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata Dictionary<string, string>
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList List<string>
Target string
UseWorkspaceManagedIdentity bool
CreatedByWorkspaceArmId This property is required. string
Group This property is required. string
Group based on connection category
Category string
Category of the connection
Credentials ConnectionUsernamePasswordResponse
Error string
ExpiryTime string
IsSharedToAll bool
Metadata map[string]string
Store user metadata for this connection
PeRequirement string
PeStatus string
SharedUserList []string
Target string
UseWorkspaceManagedIdentity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials ConnectionUsernamePasswordResponse
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String,String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean
createdByWorkspaceArmId This property is required. string
group This property is required. string
Group based on connection category
category string
Category of the connection
credentials ConnectionUsernamePasswordResponse
error string
expiryTime string
isSharedToAll boolean
metadata {[key: string]: string}
Store user metadata for this connection
peRequirement string
peStatus string
sharedUserList string[]
target string
useWorkspaceManagedIdentity boolean
created_by_workspace_arm_id This property is required. str
group This property is required. str
Group based on connection category
category str
Category of the connection
credentials ConnectionUsernamePasswordResponse
error str
expiry_time str
is_shared_to_all bool
metadata Mapping[str, str]
Store user metadata for this connection
pe_requirement str
pe_status str
shared_user_list Sequence[str]
target str
use_workspace_managed_identity bool
createdByWorkspaceArmId This property is required. String
group This property is required. String
Group based on connection category
category String
Category of the connection
credentials Property Map
error String
expiryTime String
isSharedToAll Boolean
metadata Map<String>
Store user metadata for this connection
peRequirement String
peStatus String
sharedUserList List<String>
target String
useWorkspaceManagedIdentity Boolean

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