CommunicationServiceResourceList

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-communication-services/json-schema/microsoft-azure-communication-services-communication-service-resource-list-schema.json",
  "title": "CommunicationServiceResourceList",
  "description": "Object that includes an array of CommunicationServices and a possible link for next set.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-communication-services-communicationservices-api-openapi.yml#/components/schemas/CommunicationServiceResourceList",
  "type": "object",
  "properties": {
    "value": {
      "type": "array",
      "description": "The CommunicationServiceResource items on this page",
      "items": {
        "$ref": "#/$defs/CommunicationServiceResource"
      }
    },
    "nextLink": {
      "type": "string",
      "format": "uri",
      "description": "The link to the next page of items"
    }
  },
  "required": [
    "value"
  ],
  "$defs": {
    "CommunicationServiceProperties": {
      "type": "object",
      "description": "A class that describes the properties of the CommunicationService.",
      "properties": {
        "provisioningState": {
          "$ref": "#/$defs/CommunicationServices_ProvisioningState",
          "description": "Provisioning state of the resource.",
          "readOnly": true
        },
        "hostName": {
          "type": "string",
          "description": "FQDN of the CommunicationService instance.",
          "readOnly": true
        },
        "dataLocation": {
          "type": "string",
          "description": "The location where the communication service stores its data at rest.",
          "x-ms-mutability": [
            "read",
            "create"
          ]
        },
        "notificationHubId": {
          "type": "string",
          "description": "Resource ID of an Azure Notification Hub linked to this resource.",
          "readOnly": true
        },
        "version": {
          "type": "string",
          "description": "Version of the CommunicationService resource. Probably you need the same or higher version of client SDKs.",
          "readOnly": true
        },
        "immutableResourceId": {
          "type": "string",
          "description": "The immutable resource Id of the communication service.",
          "readOnly": true
        },
        "linkedDomains": {
          "$ref": "#/$defs/DomainsResourceList",
          "description": "List of email Domain resource Ids."
        },
        "publicNetworkAccess": {
          "$ref": "#/$defs/PublicNetworkAccess",
          "description": "Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'."
        },
        "disableLocalAuth": {
          "type": "boolean",
          "description": "Disable local authentication for the CommunicationService.",
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        }
      },
      "required": [
        "dataLocation"
      ]
    },
    "CommunicationServiceResource": {
      "type": "object",
      "description": "A class representing a CommunicationService resource.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/CommunicationServiceProperties",
          "description": "The properties of the service.",
          "x-ms-client-flatten": true
        },
        "identity": {
          "$ref": "#/$defs/ManagedServiceIdentity",
          "description": "The managed service identities assigned to this resource.",
          "x-ms-mutability": [
            "read",
            "update",
            "create"
          ]
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/TrackedResource"
        }
      ]
    },
    "CommunicationServices_ProvisioningState": {
      "type": "string",
      "description": "Provisioning state of the resource.",
      "enum": [
        "Unknown",
        "Succeeded",
        "Failed",
        "Canceled",
        "Running",
        "Creating",
        "Updating",
        "Deleting",
        "Moving"
      ],
      "x-ms-enum": {
        "name": "CommunicationServices_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"
          }
        ]
      }
    },
    "DomainsResourceList": {
      "type": "array",
      "description": "List of email Domain resource Ids.",
      "items": {
        "type": "string"
      }
    },
    "ManagedServiceIdentity": {
      "type": "object",
      "description": "Managed service identity (system assigned and/or user assigned identities)",
      "properties": {
        "principalId": {
          "type": "string",
          "format": "uuid",
          "description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
          "readOnly": true
        },
        "tenantId": {
          "type": "string",
          "format": "uuid",
          "description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
          "readOnly": true
        },
        "type": {
          "$ref": "#/$defs/ManagedServiceIdentityType"
        },
        "userAssignedIdentities": {
          "type": "object",
          "description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
          "additionalProperties": {
            "$ref": "#/$defs/UserAssignedIdentity"
          }
        }
      },
      "required": [
        "type"
      ]
    },
    "PublicNetworkAccess": {
      "type": "string",
      "description": "Allow, disallow, or let network security perimeter configuration control public network access to the protected resource. Value is optional but if passed in, it must be 'Enabled', 'Disabled' or 'SecuredByPerimeter'.",
      "enum": [
        "Enabled",
        "Disabled",
        "SecuredByPerimeter"
      ],
      "x-ms-enum": {
        "name": "PublicNetworkAccess",
        "modelAsString": true,
        "values": [
          {
            "value": "Enabled",
            "description": "Allows public network access to the resource"
          },
          {
            "value": "Disabled",
            "description": "Disallows public network access to the resource"
          },
          {
            "value": "SecuredByPerimeter",
            "description": "The network security perimeter configuration rules allow or disallow public network access to the resource. Requires an associated network security perimeter."
          }
        ]
      }
    },
    "TrackedResource": {
      "type": "object",
      "title": "Tracked Resource",
      "description": "The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'",
      "properties": {
        "tags": {
          "type": "object",
          "description": "Resource tags.",
          "additionalProperties": {
            "type": "string"
          },
          "x-ms-mutability": [
            "read",
            "create",
            "update"
          ]
        },
        "location": {
          "type": "string",
          "description": "The geo-location where the resource lives",
          "x-ms-mutability": [
            "read",
            "create"
          ]
        }
      },
      "required": [
        "location"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/Resource"
        }
      ]
    }
  }
}