SenderUsernameResourceCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-communication-services/json-schema/microsoft-azure-communication-services-sender-username-resource-collection-schema.json",
  "title": "SenderUsernameResourceCollection",
  "description": "A class representing a Domains SenderUsernames collection.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-communication-services-senderusernames-api-openapi.yml#/components/schemas/SenderUsernameResourceCollection",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The SenderUsernameResource items on this page",
      "items": {
        "$ref": "#/$defs/SenderUsernameResource"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "ProvisioningState": {
      "type": "string",
      "description": "Provisioning state of the resource. Unknown is the default state for Communication Services.",
      "enum": [
        "Unknown",
        "Succeeded",
        "Failed",
        "Canceled",
        "Running",
        "Creating",
        "Updating",
        "Deleting",
        "Moving"
      ],
      "x-ms-enum": {
        "name": "ProvisioningState",
        "modelAsString": true,
        "values": [
          {
            "name": "Unknown",
            "value": "Unknown",
            "description": "Unknown"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded",
            "description": "Succeeded"
          },
          {
            "name": "Failed",
            "value": "Failed",
            "description": "Failed"
          },
          {
            "name": "Canceled",
            "value": "Canceled",
            "description": "Canceled"
          },
          {
            "name": "Running",
            "value": "Running",
            "description": "Running"
          },
          {
            "name": "Creating",
            "value": "Creating",
            "description": "Creating"
          },
          {
            "name": "Updating",
            "value": "Updating",
            "description": "Updating"
          },
          {
            "name": "Deleting",
            "value": "Deleting",
            "description": "Deleting"
          },
          {
            "name": "Moving",
            "value": "Moving",
            "description": "Moving"
          }
        ]
      }
    },
    "ProxyResource": {
      "type": "object",
      "title": "Proxy Resource",
      "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location",
      "allOf": [
        {
          "$ref": "#/$defs/Resource"
        }
      ]
    },
    "SenderUsernameProperties": {
      "type": "object",
      "description": "A class that describes the properties of a SenderUsername resource.",
      "properties": {
        "dataLocation": {
          "type": "string",
          "description": "The location where the SenderUsername resource data is stored at rest.",
          "readOnly": true
        },
        "username": {
          "type": "string",
          "description": "A sender senderUsername to be used when sending emails."
        },
        "displayName": {
          "type": "string",
          "description": "The display name for the senderUsername."
        },
        "provisioningState": {
          "$ref": "#/$defs/ProvisioningState",
          "description": "Provisioning state of the resource. Unknown is the default state for Communication Services.",
          "readOnly": true
        }
      },
      "required": [
        "username"
      ]
    },
    "SenderUsernameResource": {
      "type": "object",
      "description": "A class representing a SenderUsername resource.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/SenderUsernameProperties",
          "description": "The properties of a SenderUsername resource.",
          "x-ms-client-flatten": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/ProxyResource"
        }
      ]
    }
  }
}