@azure/arm-cognitiveservices package

Classes

CognitiveServicesManagementClient

Interfaces

AbusePenalty	The abuse penalty.
Account	Cognitive Services account is an Azure resource representing the provisioned account, it's type, location and SKU.
AccountListResult	The list of cognitive services accounts operation response.
AccountModel	Cognitive Services account Model.
AccountModelListResult	The list of cognitive services accounts operation response.
AccountProperties	Properties of Cognitive Services account.
AccountSku	Cognitive Services resource type and SKU.
AccountSkuListResult	The list of cognitive services accounts operation response.
Accounts	Interface representing a Accounts.
AccountsCreateOptionalParams	Optional parameters.
AccountsDeleteOptionalParams	Optional parameters.
AccountsGetOptionalParams	Optional parameters.
AccountsListByResourceGroupNextOptionalParams	Optional parameters.
AccountsListByResourceGroupOptionalParams	Optional parameters.
AccountsListKeysOptionalParams	Optional parameters.
AccountsListModelsNextOptionalParams	Optional parameters.
AccountsListModelsOptionalParams	Optional parameters.
AccountsListNextOptionalParams	Optional parameters.
AccountsListOptionalParams	Optional parameters.
AccountsListSkusOptionalParams	Optional parameters.
AccountsListUsagesOptionalParams	Optional parameters.
AccountsRegenerateKeyOptionalParams	Optional parameters.
AccountsUpdateOptionalParams	Optional parameters.
ApiKeys	The access keys for the cognitive services account.
ApiProperties	The api properties for special APIs.
AzureEntityResource	The resource model definition for an Azure Resource Manager resource with an etag.
CallRateLimit	The call rate limit Cognitive Services account.
CapacityConfig	The capacity configuration.
CheckDomainAvailabilityOptionalParams	Optional parameters.
CheckDomainAvailabilityParameter	Check Domain availability parameter.
CheckSkuAvailabilityOptionalParams	Optional parameters.
CheckSkuAvailabilityParameter	Check SKU availability parameter.
CognitiveServicesManagementClientOptionalParams	Optional parameters.
CommitmentCost	Cognitive Services account commitment cost.
CommitmentPeriod	Cognitive Services account commitment period.
CommitmentPlan	Cognitive Services account commitment plan.
CommitmentPlanAccountAssociation	The commitment plan association.
CommitmentPlanAccountAssociationListResult	The list of cognitive services Commitment Plan Account Association operation response.
CommitmentPlanAssociation	The commitment plan association.
CommitmentPlanListResult	The list of cognitive services accounts operation response.
CommitmentPlanProperties	Properties of Cognitive Services account commitment plan.
CommitmentPlans	Interface representing a CommitmentPlans.
CommitmentPlansCreateOrUpdateAssociationOptionalParams	Optional parameters.
CommitmentPlansCreateOrUpdateOptionalParams	Optional parameters.
CommitmentPlansCreateOrUpdatePlanOptionalParams	Optional parameters.
CommitmentPlansDeleteAssociationHeaders	Defines headers for CommitmentPlans_deleteAssociation operation.
CommitmentPlansDeleteAssociationOptionalParams	Optional parameters.
CommitmentPlansDeleteOptionalParams	Optional parameters.
CommitmentPlansDeletePlanHeaders	Defines headers for CommitmentPlans_deletePlan operation.
CommitmentPlansDeletePlanOptionalParams	Optional parameters.
CommitmentPlansGetAssociationOptionalParams	Optional parameters.
CommitmentPlansGetOptionalParams	Optional parameters.
CommitmentPlansGetPlanOptionalParams	Optional parameters.
CommitmentPlansListAssociationsNextOptionalParams	Optional parameters.
CommitmentPlansListAssociationsOptionalParams	Optional parameters.
CommitmentPlansListNextOptionalParams	Optional parameters.
CommitmentPlansListOptionalParams	Optional parameters.
CommitmentPlansListPlansByResourceGroupNextOptionalParams	Optional parameters.
CommitmentPlansListPlansByResourceGroupOptionalParams	Optional parameters.
CommitmentPlansListPlansBySubscriptionNextOptionalParams	Optional parameters.
CommitmentPlansListPlansBySubscriptionOptionalParams	Optional parameters.
CommitmentPlansUpdatePlanHeaders	Defines headers for CommitmentPlans_updatePlan operation.
CommitmentPlansUpdatePlanOptionalParams	Optional parameters.
CommitmentQuota	Cognitive Services account commitment quota.
CommitmentTier	Cognitive Services account commitment tier.
CommitmentTierListResult	The list of cognitive services accounts operation response.
CommitmentTiers	Interface representing a CommitmentTiers.
CommitmentTiersListNextOptionalParams	Optional parameters.
CommitmentTiersListOptionalParams	Optional parameters.
DeletedAccounts	Interface representing a DeletedAccounts.
DeletedAccountsGetOptionalParams	Optional parameters.
DeletedAccountsListNextOptionalParams	Optional parameters.
DeletedAccountsListOptionalParams	Optional parameters.
DeletedAccountsPurgeOptionalParams	Optional parameters.
Deployment	Cognitive Services account deployment.
DeploymentListResult	The list of cognitive services accounts operation response.
DeploymentModel	Properties of Cognitive Services account deployment model.
DeploymentProperties	Properties of Cognitive Services account deployment.
DeploymentScaleSettings	Properties of Cognitive Services account deployment model.
Deployments	Interface representing a Deployments.
DeploymentsCreateOrUpdateOptionalParams	Optional parameters.
DeploymentsDeleteOptionalParams	Optional parameters.
DeploymentsGetOptionalParams	Optional parameters.
DeploymentsListNextOptionalParams	Optional parameters.
DeploymentsListOptionalParams	Optional parameters.
DomainAvailability	Domain availability.
Encryption	Properties to configure Encryption
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
Identity	Identity for the resource.
IpRule	A rule governing the accessibility from a specific ip address or ip range.
KeyVaultProperties	Properties to configure keyVault Properties
MetricName	A metric name.
Model	Cognitive Services Model.
ModelDeprecationInfo	Cognitive Services account ModelDeprecationInfo.
ModelListResult	The list of cognitive services models.
ModelSku	Describes an available Cognitive Services Model SKU.
Models	Interface representing a Models.
ModelsListNextOptionalParams	Optional parameters.
ModelsListOptionalParams	Optional parameters.
MultiRegionSettings	The multiregion settings Cognitive Services account.
NetworkRuleSet	A set of rules governing the network accessibility.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PatchResourceTags	The object being used to update tags of a resource, in general used for PATCH operations.
PatchResourceTagsAndSku	The object being used to update tags and sku of a resource, in general used for PATCH operations.
PrivateEndpoint	The Private Endpoint resource.
PrivateEndpointConnection	The Private Endpoint Connection resource.
PrivateEndpointConnectionListResult	A list of private endpoint connections
PrivateEndpointConnectionProperties	Properties of the PrivateEndpointConnectProperties.
PrivateEndpointConnections	Interface representing a PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListOptionalParams	Optional parameters.
PrivateLinkResource	A private link resource
PrivateLinkResourceListResult	A list of private link resources
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResources	Interface representing a PrivateLinkResources.
PrivateLinkResourcesListOptionalParams	Optional parameters.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QuotaLimit
RegenerateKeyParameters	Regenerate key parameters.
RegionSetting	The call rate limit Cognitive Services account.
RequestMatchPattern
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceSku	Describes an available Cognitive Services SKU.
ResourceSkuListResult	The Get Skus operation response.
ResourceSkuRestrictionInfo
ResourceSkuRestrictions	Describes restrictions of a SKU.
ResourceSkus	Interface representing a ResourceSkus.
ResourceSkusListNextOptionalParams	Optional parameters.
ResourceSkusListOptionalParams	Optional parameters.
Sku	The resource model definition representing SKU
SkuAvailability	SKU availability.
SkuAvailabilityListResult	Check SKU availability result list.
SkuCapability	SkuCapability indicates the capability of a certain feature.
SkuChangeInfo	Sku change info of account.
SystemData	Metadata pertaining to creation and last modification of the resource.
ThrottlingRule
Usage	The usage data for a usage request.
UsageListResult	The response to a list usage request.
Usages	Interface representing a Usages.
UsagesListNextOptionalParams	Optional parameters.
UsagesListOptionalParams	Optional parameters.
UserAssignedIdentity	User-assigned managed identity.
UserOwnedStorage	The user owned storage for Cognitive Services account.
VirtualNetworkRule	A rule governing the accessibility from a specific virtual network.

Type Aliases

AbusePenaltyAction	Defines values for AbusePenaltyAction. KnownAbusePenaltyAction can be used interchangeably with AbusePenaltyAction, this enum contains the known values that the service supports. Known values supported by the service Throttle Block
AccountsCreateResponse	Contains response data for the create operation.
AccountsGetResponse	Contains response data for the get operation.
AccountsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
AccountsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
AccountsListKeysResponse	Contains response data for the listKeys operation.
AccountsListModelsNextResponse	Contains response data for the listModelsNext operation.
AccountsListModelsResponse	Contains response data for the listModels operation.
AccountsListNextResponse	Contains response data for the listNext operation.
AccountsListResponse	Contains response data for the list operation.
AccountsListSkusResponse	Contains response data for the listSkus operation.
AccountsListUsagesResponse	Contains response data for the listUsages operation.
AccountsRegenerateKeyResponse	Contains response data for the regenerateKey operation.
AccountsUpdateResponse	Contains response data for the update operation.
ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
CheckDomainAvailabilityResponse	Contains response data for the checkDomainAvailability operation.
CheckSkuAvailabilityResponse	Contains response data for the checkSkuAvailability operation.
CommitmentPlanProvisioningState	Defines values for CommitmentPlanProvisioningState. KnownCommitmentPlanProvisioningState can be used interchangeably with CommitmentPlanProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Accepted Creating Deleting Moving Failed Succeeded Canceled
CommitmentPlansCreateOrUpdateAssociationResponse	Contains response data for the createOrUpdateAssociation operation.
CommitmentPlansCreateOrUpdatePlanResponse	Contains response data for the createOrUpdatePlan operation.
CommitmentPlansCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
CommitmentPlansGetAssociationResponse	Contains response data for the getAssociation operation.
CommitmentPlansGetPlanResponse	Contains response data for the getPlan operation.
CommitmentPlansGetResponse	Contains response data for the get operation.
CommitmentPlansListAssociationsNextResponse	Contains response data for the listAssociationsNext operation.
CommitmentPlansListAssociationsResponse	Contains response data for the listAssociations operation.
CommitmentPlansListNextResponse	Contains response data for the listNext operation.
CommitmentPlansListPlansByResourceGroupNextResponse	Contains response data for the listPlansByResourceGroupNext operation.
CommitmentPlansListPlansByResourceGroupResponse	Contains response data for the listPlansByResourceGroup operation.
CommitmentPlansListPlansBySubscriptionNextResponse	Contains response data for the listPlansBySubscriptionNext operation.
CommitmentPlansListPlansBySubscriptionResponse	Contains response data for the listPlansBySubscription operation.
CommitmentPlansListResponse	Contains response data for the list operation.
CommitmentPlansUpdatePlanResponse	Contains response data for the updatePlan operation.
CommitmentTiersListNextResponse	Contains response data for the listNext operation.
CommitmentTiersListResponse	Contains response data for the list operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DeletedAccountsGetResponse	Contains response data for the get operation.
DeletedAccountsListNextResponse	Contains response data for the listNext operation.
DeletedAccountsListResponse	Contains response data for the list operation.
DeploymentModelVersionUpgradeOption	Defines values for DeploymentModelVersionUpgradeOption. KnownDeploymentModelVersionUpgradeOption can be used interchangeably with DeploymentModelVersionUpgradeOption, this enum contains the known values that the service supports. Known values supported by the service OnceNewDefaultVersionAvailable OnceCurrentVersionExpired NoAutoUpgrade
DeploymentProvisioningState	Defines values for DeploymentProvisioningState. KnownDeploymentProvisioningState can be used interchangeably with DeploymentProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Accepted Creating Deleting Moving Failed Succeeded Disabled Canceled
DeploymentScaleType	Defines values for DeploymentScaleType. KnownDeploymentScaleType can be used interchangeably with DeploymentScaleType, this enum contains the known values that the service supports. Known values supported by the service Standard Manual
DeploymentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DeploymentsGetResponse	Contains response data for the get operation.
DeploymentsListNextResponse	Contains response data for the listNext operation.
DeploymentsListResponse	Contains response data for the list operation.
HostingModel	Defines values for HostingModel. KnownHostingModel can be used interchangeably with HostingModel, this enum contains the known values that the service supports. Known values supported by the service Web ConnectedContainer DisconnectedContainer ProvisionedWeb
KeyName	Defines values for KeyName.
KeySource	Defines values for KeySource. KnownKeySource can be used interchangeably with KeySource, this enum contains the known values that the service supports. Known values supported by the service Microsoft.CognitiveServices Microsoft.KeyVault
ModelLifecycleStatus	Defines values for ModelLifecycleStatus. KnownModelLifecycleStatus can be used interchangeably with ModelLifecycleStatus, this enum contains the known values that the service supports. Known values supported by the service GenerallyAvailable Preview
ModelsListNextResponse	Contains response data for the listNext operation.
ModelsListResponse	Contains response data for the list operation.
NetworkRuleAction	Defines values for NetworkRuleAction. KnownNetworkRuleAction can be used interchangeably with NetworkRuleAction, this enum contains the known values that the service supports. Known values supported by the service Allow Deny
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
PrivateEndpointConnectionProvisioningState	Defines values for PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded Creating Deleting Failed
PrivateEndpointConnectionsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
PrivateEndpointConnectionsGetResponse	Contains response data for the get operation.
PrivateEndpointConnectionsListResponse	Contains response data for the list operation.
PrivateEndpointServiceConnectionStatus	Defines values for PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending Approved Rejected
PrivateLinkResourcesListResponse	Contains response data for the list operation.
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Accepted Creating Deleting Moving Failed Succeeded ResolvingDNS
PublicNetworkAccess	Defines values for PublicNetworkAccess. KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports. Known values supported by the service Enabled Disabled
QuotaUsageStatus	Defines values for QuotaUsageStatus. KnownQuotaUsageStatus can be used interchangeably with QuotaUsageStatus, this enum contains the known values that the service supports. Known values supported by the service Included Blocked InOverage Unknown
ResourceIdentityType	Defines values for ResourceIdentityType.
ResourceSkuRestrictionsReasonCode	Defines values for ResourceSkuRestrictionsReasonCode. KnownResourceSkuRestrictionsReasonCode can be used interchangeably with ResourceSkuRestrictionsReasonCode, this enum contains the known values that the service supports. Known values supported by the service QuotaId NotAvailableForSubscription
ResourceSkuRestrictionsType	Defines values for ResourceSkuRestrictionsType.
ResourceSkusListNextResponse	Contains response data for the listNext operation.
ResourceSkusListResponse	Contains response data for the list operation.
RoutingMethods	Defines values for RoutingMethods. KnownRoutingMethods can be used interchangeably with RoutingMethods, this enum contains the known values that the service supports. Known values supported by the service Priority Weighted Performance
SkuTier	Defines values for SkuTier. KnownSkuTier can be used interchangeably with SkuTier, this enum contains the known values that the service supports. Known values supported by the service Free Basic Standard Premium Enterprise
UnitType	Defines values for UnitType. KnownUnitType can be used interchangeably with UnitType, this enum contains the known values that the service supports. Known values supported by the service Count Bytes Seconds Percent CountPerSecond BytesPerSecond Milliseconds
UsagesListNextResponse	Contains response data for the listNext operation.
UsagesListResponse	Contains response data for the list operation.

Enums

KnownAbusePenaltyAction	Known values of AbusePenaltyAction that the service accepts.
KnownActionType	Known values of ActionType that the service accepts.
KnownCommitmentPlanProvisioningState	Known values of CommitmentPlanProvisioningState that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownDeploymentModelVersionUpgradeOption	Known values of DeploymentModelVersionUpgradeOption that the service accepts.
KnownDeploymentProvisioningState	Known values of DeploymentProvisioningState that the service accepts.
KnownDeploymentScaleType	Known values of DeploymentScaleType that the service accepts.
KnownHostingModel	Known values of HostingModel that the service accepts.
KnownKeySource	Known values of KeySource that the service accepts.
KnownModelLifecycleStatus	Known values of ModelLifecycleStatus that the service accepts.
KnownNetworkRuleAction	Known values of NetworkRuleAction that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownPrivateEndpointConnectionProvisioningState	Known values of PrivateEndpointConnectionProvisioningState that the service accepts.
KnownPrivateEndpointServiceConnectionStatus	Known values of PrivateEndpointServiceConnectionStatus that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownPublicNetworkAccess	Known values of PublicNetworkAccess that the service accepts.
KnownQuotaUsageStatus	Known values of QuotaUsageStatus that the service accepts.
KnownResourceSkuRestrictionsReasonCode	Known values of ResourceSkuRestrictionsReasonCode that the service accepts.
KnownRoutingMethods	Known values of RoutingMethods that the service accepts.
KnownSkuTier	Known values of SkuTier that the service accepts.
KnownUnitType	Known values of UnitType that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.