Share via


Azure.ResourceManager.CognitiveServices.Models Namespace

Classes

AadAuthTypeConnectionProperties

This connection type covers the AAD auth for any applicable Azure service.

AbusePenalty

The abuse penalty.

AccessKeyAuthTypeConnectionProperties

The AccessKeyAuthTypeConnectionProperties.

AccountKeyAuthTypeConnectionProperties

This connection type covers the account key connection for Azure storage.

AIFoundryNetworkInjection

Specifies in AI Foundry where virtual network injection occurs to secure scenarios like Agents entirely within the user's private network, eliminating public internet exposure while maintaining control over network configurations and resources.

ApiKeyAuthConnectionProperties

This connection type covers the generic ApiKey auth connection categories, for examples: AzureOpenAI: Category:= AzureOpenAI AuthType:= ApiKey (as type discriminator) Credentials:= {ApiKey} as .ApiKey Target:= {ApiBase}

CognitiveService: Category:= CognitiveService AuthType:= ApiKey (as type discriminator) Credentials:= {SubscriptionKey} as ApiKey Target:= ServiceRegion={serviceRegion}

CognitiveSearch: Category:= CognitiveSearch AuthType:= ApiKey (as type discriminator) Credentials:= {Key} as ApiKey Target:= {Endpoint}

Use Metadata property bag for ApiType, ApiVersion, Kind and other metadata fields

ArmCognitiveServicesModelFactory

Model factory for models.

AvailableCognitiveServicesSku

Describes an available Cognitive Services SKU.

BillingMeterInfo

The BillingMeterInfo.

CalculateModelCapacityContent

Calculate Model Capacity parameter.

CalculateModelCapacityResult

Calculate Model Capacity result.

CalculateModelCapacityResultEstimatedCapacity

Model Estimated Capacity.

CognitiveServicesAccountDeploymentModel

Properties of Cognitive Services account deployment model.

CognitiveServicesAccountDeploymentProperties

Properties of Cognitive Services account deployment.

CognitiveServicesAccountDeploymentScaleSettings

Properties of Cognitive Services account deployment model. (Deprecated, please use Deployment.sku instead.).

CognitiveServicesAccountModel

Cognitive Services account Model.

CognitiveServicesAccountProperties

Properties of Cognitive Services account.

CognitiveServicesAccountSku

Cognitive Services resource type and SKU.

CognitiveServicesCapabilityHostProperties

The CognitiveServicesCapabilityHostProperties.

CognitiveServicesCapacityConfig

The capacity configuration.

CognitiveServicesCommitmentPlanPatch

CognitiveServicesCommitmentPlanPatch

CognitiveServicesConnectionAccessKey

The CognitiveServicesConnectionAccessKey.

CognitiveServicesConnectionManagedIdentity

The CognitiveServicesConnectionManagedIdentity.

CognitiveServicesConnectionOAuth2

ClientId and ClientSecret are required. Other properties are optional depending on each OAuth2 provider's implementation.

CognitiveServicesConnectionPatch

The properties that the Cognitive services connection will be updated with.

CognitiveServicesConnectionProperties

Connection property base schema. Please note CognitiveServicesConnectionProperties is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AadAuthTypeConnectionProperties, AccessKeyAuthTypeConnectionProperties, AccountKeyAuthTypeConnectionProperties, ApiKeyAuthConnectionProperties, CustomKeysConnectionProperties, ManagedIdentityAuthTypeConnectionProperties, NoneAuthTypeConnectionProperties, OAuth2AuthTypeConnectionProperties, PatAuthTypeConnectionProperties, SASAuthTypeConnectionProperties, ServicePrincipalAuthTypeConnectionProperties and UsernamePasswordAuthTypeConnectionProperties.

CognitiveServicesConnectionServicePrincipal

The CognitiveServicesConnectionServicePrincipal.

CognitiveServicesConnectionUsernamePassword

The CognitiveServicesConnectionUsernamePassword.

CognitiveServicesDomainAvailabilityContent

Check Domain availability parameter.

CognitiveServicesDomainAvailabilityList

Domain availability.

CognitiveServicesEncryptionScopeProperties

Properties to EncryptionScope.

CognitiveServicesIPRule

A rule governing the accessibility from a specific ip address or ip range.

CognitiveServicesKeyVaultProperties

Properties to configure keyVault Properties.

CognitiveServicesModel

Cognitive Services Model.

CognitiveServicesModelSku

Describes an available Cognitive Services Model SKU.

CognitiveServicesMultiRegionSettings

The multiregion settings Cognitive Services account.

CognitiveServicesNetworkRuleSet

A set of rules governing the network accessibility.

CognitiveServicesNetworkSecurityPerimeter

Information about a linked Network Security Perimeter.

CognitiveServicesPatchResourceTags

The object being used to update tags of a resource, in general used for PATCH operations.

CognitiveServicesPrivateLinkResource

A private link resource.

CognitiveServicesPrivateLinkResourceProperties

Properties of a private link resource.

CognitiveServicesPrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

CognitiveServicesProjectProperties

Properties of Cognitive Services Project'.

CognitiveServicesRegionSetting

The call rate limit Cognitive Services account.

CognitiveServicesResourceBase

The CognitiveServicesResourceBase.

CognitiveServicesResourceSku

Properties of Cognitive Services account resource sku resource properties.

CognitiveServicesSku

The resource model definition representing SKU.

CognitiveServicesSkuAvailabilityContent

Check SKU availability parameter.

CognitiveServicesSkuAvailabilityList

SKU availability.

CognitiveServicesSkuCapability

SkuCapability indicates the capability of a certain feature.

CognitiveServicesSkuChangeInfo

Sku change info of account.

CognitiveServicesSkuRestrictionInfo

The CognitiveServicesSkuRestrictionInfo.

CognitiveServicesSkuRestrictions

Describes restrictions of a SKU.

CognitiveServicesVirtualNetworkRule

A rule governing the accessibility from a specific virtual network.

CommitmentCost

Cognitive Services account commitment cost.

CommitmentPeriod

Cognitive Services account commitment period.

CommitmentPlanAssociation

The commitment plan association.

CommitmentPlanProperties

Properties of Cognitive Services account commitment plan.

CommitmentQuota

Cognitive Services account commitment quota.

CommitmentTier

Cognitive Services account commitment tier.

CustomBlocklistConfig

Gets or sets the source to which filter applies.

CustomKeysConnectionProperties

Category:= CustomKeys AuthType:= CustomKeys (as type discriminator) Credentials:= {CustomKeys} as CustomKeys Target:= {any value} Use Metadata property bag for ApiVersion and other metadata fields

DeploymentCapacitySettings

Internal use only.

ManagedIdentityAuthTypeConnectionProperties

The ManagedIdentityAuthTypeConnectionProperties.

ModelCapacityCalculatorWorkload

Model Capacity Calculator Workload.

ModelCapacityCalculatorWorkloadRequestParam

Dictionary, Model Capacity Calculator Workload Parameters.

ModelCapacityListResultValueItem

The ModelCapacityListResultValueItem.

ModelSkuCapacityProperties

Cognitive Services account ModelSkuCapacity.

NetworkSecurityPerimeterAccessRule

Network Security Perimeter Access Rule.

NetworkSecurityPerimeterAccessRuleProperties

The Properties of Network Security Perimeter Rule.

NetworkSecurityPerimeterConfigurationAssociationInfo

Network Security Perimeter Configuration Association Information.

NetworkSecurityPerimeterConfigurationProperties

The properties of an NSP Configuration.

NetworkSecurityPerimeterProfileInfo

Network Security Perimeter Profile Information.

NetworkSecurityPerimeterProvisioningIssue

The NetworkSecurityPerimeterProvisioningIssue.

NetworkSecurityPerimeterProvisioningIssueProperties

Properties of Provisioning Issue.

NoneAuthTypeConnectionProperties

The NoneAuthTypeConnectionProperties.

OAuth2AuthTypeConnectionProperties

The OAuth2AuthTypeConnectionProperties.

PatAuthTypeConnectionProperties

The PatAuthTypeConnectionProperties.

PatchResourceTagsAndSku

The object being used to update tags and sku of a resource, in general used for PATCH operations.

RaiBlocklistConfig

Azure OpenAI blocklist config.

RaiBlocklistItemBulkContent

The Cognitive Services RaiBlocklist Item request body.

RaiBlocklistItemProperties

RAI Custom Blocklist Item properties.

RaiContentFilterProperties

Azure OpenAI Content Filter Properties.

RaiMonitorConfig

Cognitive Services Rai Monitor Config.

RaiPolicyContentFilter

Azure OpenAI Content Filter.

RaiPolicyProperties

Azure OpenAI Content Filters properties.

RegenerateServiceAccountKeyContent

Regenerate key parameters.

SASAuthTypeConnectionProperties

The SASAuthTypeConnectionProperties.

ServiceAccountApiKeys

The access keys for the cognitive services account.

ServiceAccountApiProperties

The api properties for special APIs.

ServiceAccountCallRateLimit

The call rate limit Cognitive Services account.

ServiceAccountEncryptionProperties

Properties to configure Encryption.

ServiceAccountModelDeprecationInfo

Cognitive Services account ModelDeprecationInfo.

ServiceAccountQuotaLimit

The ServiceAccountQuotaLimit.

ServiceAccountThrottlingMatchPattern

The ServiceAccountThrottlingMatchPattern.

ServiceAccountThrottlingRule

The ServiceAccountThrottlingRule.

ServiceAccountUsage

The usage data for a usage request.

ServiceAccountUsageMetricName

A metric name.

ServiceAccountUserOwnedStorage

The user owned storage for Cognitive Services account.

ServicePrincipalAuthTypeConnectionProperties

The ServicePrincipalAuthTypeConnectionProperties.

UsernamePasswordAuthTypeConnectionProperties

The UsernamePasswordAuthTypeConnectionProperties.

UserOwnedAmlWorkspace

The user owned AML account for Cognitive Services account.

Structs

AbusePenaltyAction

The action of AbusePenalty.

AIFoundryNetworkInjectionScenarioType

Specifies what features in AI Foundry network injection applies to. Currently only supports 'agent' for agent scenarios. 'none' means no network injection.

CapabilityHostKind

The CapabilityHostKind.

CapabilityHostProvisioningState

Provisioning state of capability host.

CognitiveServicesAccountDeploymentProvisioningState

Gets the status of the resource at the time the operation was called.

CognitiveServicesAccountDeploymentScaleType

Deployment scale type.

CognitiveServicesConnectionCategory

Category of the connection.

CognitiveServicesConnectionGroup

Group based on connection category.

CognitiveServicesNetworkRuleAction

The default action when no rule from ipRules and from virtualNetworkRules match. This is only used after the bypass property has been evaluated.

CognitiveServicesPrivateEndpointConnectionProvisioningState

The current provisioning state.

CognitiveServicesPrivateEndpointServiceConnectionStatus

The private endpoint connection status.

CognitiveServicesRoutingMethod

Multiregion routing methods.

CognitiveServicesSkuRestrictionReasonCode

The reason for restriction.

CognitiveServicesSkuTier

This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.

CommitmentPlanProvisioningState

Gets the status of the resource at the time the operation was called.

DefenderForAISettingState

Defender for AI state on the AI resource.

DeploymentModelVersionUpgradeOption

Deployment model version upgrade option.

EncryptionScopeProvisioningState

Gets the status of the resource at the time the operation was called.

EncryptionScopeState

The encryptionScope state.

ManagedPERequirement

The ManagedPERequirement.

ManagedPEStatus

The ManagedPEStatus.

ModelLifecycleStatus

Model lifecycle status.

NspAccessRuleDirection

Direction of Access Rule.

RaiPolicyContentLevel

Level at which content is filtered.

RaiPolicyContentSource

Content source to apply the Content Filters.

RaiPolicyMode

Rai policy mode. The enum value mapping is as below: Default = 0, Deferred=1, Blocking=2, Asynchronous_filter =3. Please use 'Asynchronous_filter' after 2025-06-01. It is the same as 'Deferred' in previous version.

RaiPolicyType

Content Filters policy type.

ServiceAccountEncryptionKeySource

Enumerates the possible value of keySource for Encryption.

ServiceAccountHostingModel

Account hosting model.

ServiceAccountProvisioningState

Gets the status of the cognitive services account at the time the operation was called.

ServiceAccountPublicNetworkAccess

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

ServiceAccountQuotaUsageStatus

Cognitive Services account quota usage status.

ServiceAccountUsageUnitType

The unit of the metric.

TrustedServicesByPassSelection

Setting for trusted services.

Enums

CognitiveServicesSkuRestrictionsType

The type of restrictions.

ServiceAccountKeyName

key name to generate (Key1|Key2).