AccountProperties

Properties of Cognitive Services account.

API ManagementCloudCloud ComputingEnterpriseInfrastructure as a ServicePlatform as a ServiceT1

Properties

Name	Type	Description
provisioningState	string	The status of the cognitive services account at the time of the operation.
endpoint	string	Endpoint of the created account.
endpoints	object	Dictionary of endpoints for the cognitive services account.
capabilities	array	The capabilities of the cognitive services account.
isMigrated	boolean	Whether this account has been migrated.
dateCreated	string	The date of creation.
customSubDomainName	string	Optional subdomain name used for token-based authentication.
networkAcls	object
publicNetworkAccess	string	Whether or not public endpoint access is allowed.
disableLocalAuth	boolean	Whether to disable local authentication methods.
restrictOutboundNetworkAccess	boolean	Whether to restrict outbound network access.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AccountProperties",
  "title": "AccountProperties",
  "type": "object",
  "description": "Properties of Cognitive Services account.",
  "properties": {
    "provisioningState": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "Accepted",
        "Creating",
        "Deleting",
        "Moving",
        "Failed",
        "Succeeded",
        "ResolvingDNS"
      ],
      "description": "The status of the cognitive services account at the time of the operation.",
      "example": "Accepted"
    },
    "endpoint": {
      "type": "string",
      "readOnly": true,
      "description": "Endpoint of the created account.",
      "example": "example_value"
    },
    "endpoints": {
      "type": "object",
      "readOnly": true,
      "additionalProperties": {
        "type": "string"
      },
      "description": "Dictionary of endpoints for the cognitive services account.",
      "example": "example_value"
    },
    "capabilities": {
      "type": "array",
      "readOnly": true,
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        }
      },
      "description": "The capabilities of the cognitive services account.",
      "example": []
    },
    "isMigrated": {
      "type": "boolean",
      "readOnly": true,
      "description": "Whether this account has been migrated.",
      "example": true
    },
    "dateCreated": {
      "type": "string",
      "readOnly": true,
      "description": "The date of creation.",
      "example": "example_value"
    },
    "customSubDomainName": {
      "type": "string",
      "description": "Optional subdomain name used for token-based authentication.",
      "example": "example_value"
    },
    "networkAcls": {
      "$ref": "#/components/schemas/NetworkRuleSet"
    },
    "publicNetworkAccess": {
      "type": "string",
      "enum": [
        "Enabled",
        "Disabled"
      ],
      "description": "Whether or not public endpoint access is allowed.",
      "example": "Enabled"
    },
    "disableLocalAuth": {
      "type": "boolean",
      "description": "Whether to disable local authentication methods.",
      "example": true
    },
    "restrictOutboundNetworkAccess": {
      "type": "boolean",
      "description": "Whether to restrict outbound network access.",
      "example": true
    }
  }
}