Share via


AccountProperties Class

Properties of Cognitive Services account.

Variables are only populated by the server, and will be ignored when sending a request.

Constructor

AccountProperties(*, migration_token: str | None = None, custom_sub_domain_name: str | None = None, network_acls: _models.NetworkRuleSet | None = None, encryption: _models.Encryption | None = None, user_owned_storage: list['_models.UserOwnedStorage'] | None = None, aml_workspace: _models.UserOwnedAmlWorkspace | None = None, public_network_access: str | _models.PublicNetworkAccess | None = None, api_properties: _models.ApiProperties | None = None, dynamic_throttling_enabled: bool | None = None, stored_completions_disabled: bool | None = None, restrict_outbound_network_access: bool | None = None, allowed_fqdn_list: list[str] | None = None, disable_local_auth: bool | None = None, restore: bool | None = None, locations: _models.MultiRegionSettings | None = None, rai_monitor_config: _models.RaiMonitorConfig | None = None, network_injections: list['_models.NetworkInjection'] | None = None, allow_project_management: bool | None = None, default_project: str | None = None, associated_projects: list[str] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
migration_token
str

Resource migration token.

Default value: None
custom_sub_domain_name
str

Optional subdomain name used for token-based authentication.

Default value: None
network_acls

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

Default value: None
encryption

The encryption properties for this resource.

Default value: None
user_owned_storage

The storage accounts for this resource.

Default value: None
aml_workspace

The user owned AML account properties.

Default value: None
public_network_access

Whether or not public endpoint access is allowed for this account. Known values are: "Enabled" and "Disabled".

Default value: None
api_properties

The api properties for special APIs.

Default value: None
dynamic_throttling_enabled

The flag to enable dynamic throttling.

Default value: None
stored_completions_disabled

The flag to disable stored completions.

Default value: None
restrict_outbound_network_access
Default value: None
allowed_fqdn_list
Default value: None
disable_local_auth
Default value: None
restore
Default value: None
locations

The multiregion settings of Cognitive Services account.

Default value: None
rai_monitor_config

Cognitive Services Rai Monitor Config.

Default value: None
network_injections
Default value: None
allow_project_management

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

Default value: None
default_project
str

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

Default value: None
associated_projects

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

Default value: None

Variables

Name Description
provisioning_state

Gets the status of the cognitive services account at the time the operation was called. Known values are: "Accepted", "Creating", "Deleting", "Moving", "Failed", "Succeeded", "ResolvingDNS", and "Canceled".

endpoint
str

Endpoint of the created account.

internal_id
str

The internal identifier (deprecated, do not use this property).

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.

is_migrated

If the resource is migrated from an existing key.

migration_token
str

Resource migration token.

sku_change_info

Sku change info of account.

custom_sub_domain_name
str

Optional subdomain name used for token-based authentication.

network_acls

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

encryption

The encryption properties for this resource.

user_owned_storage

The storage accounts for this resource.

aml_workspace

The user owned AML account properties.

private_endpoint_connections

The private endpoint connection associated with the Cognitive Services account.

public_network_access

Whether or not public endpoint access is allowed for this account. Known values are: "Enabled" and "Disabled".

api_properties

The api properties for special APIs.

date_created
str

Gets the date of cognitive services account creation.

call_rate_limit

The call rate limit Cognitive Services account.

dynamic_throttling_enabled

The flag to enable dynamic throttling.

stored_completions_disabled

The flag to disable stored completions.

quota_limit
restrict_outbound_network_access
allowed_fqdn_list
disable_local_auth
endpoints

Dictionary of <string>.

restore
deletion_date
str

The deletion date, only available for deleted account.

scheduled_purge_date
str

The scheduled purge date, only available for deleted account.

locations

The multiregion settings of Cognitive Services account.

commitment_plan_associations

The commitment plan associations of Cognitive Services account.

abuse_penalty

The abuse penalty.

rai_monitor_config

Cognitive Services Rai Monitor Config.

network_injections
allow_project_management

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

default_project
str

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

associated_projects

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