Share via

AccountProperties interface

Package:
@azure/arm-cognitiveservices

Properties of Cognitive Services account.

Properties

abusePenalty

The abuse penalty. NOTE: This property will not be serialized. It can only be populated by the server.
allowedFqdnList
allowProjectManagement

Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry.
amlWorkspace

The user owned AML account properties.
apiProperties

The api properties for special APIs.
associatedProjects

Specifies the projects, by project name, that are associated with this resource.
callRateLimit

The call rate limit Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server.
capabilities

Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only. NOTE: This property will not be serialized. It can only be populated by the server.
commitmentPlanAssociations

The commitment plan associations of Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server.
customSubDomainName

Optional subdomain name used for token-based authentication.
dateCreated

Gets the date of cognitive services account creation. NOTE: This property will not be serialized. It can only be populated by the server.
defaultProject

Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter.
deletionDate

The deletion date, only available for deleted account. NOTE: This property will not be serialized. It can only be populated by the server.
disableLocalAuth
dynamicThrottlingEnabled

The flag to enable dynamic throttling.
encryption

The encryption properties for this resource.
endpoint

Endpoint of the created account. NOTE: This property will not be serialized. It can only be populated by the server.
endpoints

Dictionary of <string> NOTE: This property will not be serialized. It can only be populated by the server.
internalId

The internal identifier (deprecated, do not use this property). NOTE: This property will not be serialized. It can only be populated by the server.
isMigrated

If the resource is migrated from an existing key. NOTE: This property will not be serialized. It can only be populated by the server.
locations

The multiregion settings of Cognitive Services account.
migrationToken

Resource migration token.
networkAcls

A collection of rules governing the accessibility from specific network locations.
networkInjections
privateEndpointConnections

The private endpoint connection associated with the Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

Gets the status of the cognitive services account at the time the operation was called. NOTE: This property will not be serialized. It can only be populated by the server.
publicNetworkAccess

Whether or not public endpoint access is allowed for this account.
quotaLimit

NOTE: This property will not be serialized. It can only be populated by the server.
raiMonitorConfig

Cognitive Services Rai Monitor Config.
restore
restrictOutboundNetworkAccess
scheduledPurgeDate

The scheduled purge date, only available for deleted account. NOTE: This property will not be serialized. It can only be populated by the server.
skuChangeInfo

Sku change info of account. NOTE: This property will not be serialized. It can only be populated by the server.
storedCompletionsDisabled

The flag to disable stored completions.
userOwnedStorage

The storage accounts for this resource.

Property Details

abusePenalty

The abuse penalty. NOTE: This property will not be serialized. It can only be populated by the server.

abusePenalty?: AbusePenalty

Property Value

AbusePenalty

allowedFqdnList 

allowedFqdnList?: string[]

Property Value

string[]

allowProjectManagement

Specifies whether this resource support project management as child resources, used as containers for access management, data isolation and cost in AI Foundry.

allowProjectManagement?: boolean

Property Value

boolean

amlWorkspace

The user owned AML account properties.

amlWorkspace?: UserOwnedAmlWorkspace

Property Value

UserOwnedAmlWorkspace

apiProperties

The api properties for special APIs.

apiProperties?: ApiProperties

Property Value

ApiProperties

associatedProjects

Specifies the projects, by project name, that are associated with this resource.

associatedProjects?: string[]

Property Value

string[]

callRateLimit

The call rate limit Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server.

callRateLimit?: CallRateLimit

Property Value

CallRateLimit

capabilities

Gets the capabilities of the cognitive services account. Each item indicates the capability of a specific feature. The values are read-only and for reference only. NOTE: This property will not be serialized. It can only be populated by the server.

capabilities?: SkuCapability[]

Property Value

SkuCapability[]

commitmentPlanAssociations

The commitment plan associations of Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server.

commitmentPlanAssociations?: CommitmentPlanAssociation[]

Property Value

CommitmentPlanAssociation[]

customSubDomainName

Optional subdomain name used for token-based authentication.

customSubDomainName?: string

Property Value

string

dateCreated

Gets the date of cognitive services account creation. NOTE: This property will not be serialized. It can only be populated by the server.

dateCreated?: string

Property Value

string

defaultProject

Specifies the project, by project name, that is targeted when data plane endpoints are called without a project parameter.

defaultProject?: string

Property Value

string

deletionDate

The deletion date, only available for deleted account. NOTE: This property will not be serialized. It can only be populated by the server.

deletionDate?: string

Property Value

string

disableLocalAuth 

disableLocalAuth?: boolean

Property Value

boolean

dynamicThrottlingEnabled

The flag to enable dynamic throttling.

dynamicThrottlingEnabled?: boolean

Property Value

boolean

encryption

The encryption properties for this resource.

encryption?: Encryption

Property Value

Encryption

endpoint

Endpoint of the created account. NOTE: This property will not be serialized. It can only be populated by the server.

endpoint?: string

Property Value

string

endpoints

Dictionary of <string> NOTE: This property will not be serialized. It can only be populated by the server.

endpoints?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

internalId

The internal identifier (deprecated, do not use this property). NOTE: This property will not be serialized. It can only be populated by the server.

internalId?: string

Property Value

string

isMigrated

If the resource is migrated from an existing key. NOTE: This property will not be serialized. It can only be populated by the server.

isMigrated?: boolean

Property Value

boolean

locations

The multiregion settings of Cognitive Services account.

locations?: MultiRegionSettings

Property Value

MultiRegionSettings

migrationToken

Resource migration token.

migrationToken?: string

Property Value

string

networkAcls

A collection of rules governing the accessibility from specific network locations.

networkAcls?: NetworkRuleSet

Property Value

NetworkRuleSet

networkInjections 

networkInjections?: NetworkInjection[]

Property Value

NetworkInjection[]

privateEndpointConnections

The private endpoint connection associated with the Cognitive Services account. NOTE: This property will not be serialized. It can only be populated by the server.

privateEndpointConnections?: PrivateEndpointConnection[]

Property Value

PrivateEndpointConnection[]

provisioningState

Gets the status of the cognitive services account at the time the operation was called. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publicNetworkAccess

Whether or not public endpoint access is allowed for this account.

publicNetworkAccess?: string

Property Value

string

quotaLimit

NOTE: This property will not be serialized. It can only be populated by the server.

quotaLimit?: QuotaLimit

Property Value

QuotaLimit

raiMonitorConfig

Cognitive Services Rai Monitor Config.

raiMonitorConfig?: RaiMonitorConfig

Property Value

RaiMonitorConfig

restore 

restore?: boolean

Property Value

boolean

restrictOutboundNetworkAccess 

restrictOutboundNetworkAccess?: boolean

Property Value

boolean

scheduledPurgeDate

The scheduled purge date, only available for deleted account. NOTE: This property will not be serialized. It can only be populated by the server.

scheduledPurgeDate?: string

Property Value

string

skuChangeInfo

Sku change info of account. NOTE: This property will not be serialized. It can only be populated by the server.

skuChangeInfo?: SkuChangeInfo

Property Value

SkuChangeInfo

storedCompletionsDisabled

The flag to disable stored completions.

storedCompletionsDisabled?: boolean

Property Value

boolean

userOwnedStorage

The storage accounts for this resource.

userOwnedStorage?: UserOwnedStorage[]

Property Value

UserOwnedStorage[]