StaticSiteARMResource

Concrete tracked resource types can be created by aliasing this type using a specific property type.

Microsoft AzureCloudComputeEvent-DrivenMicrosoftServerless

Properties

Name Type Description
properties object Core resource properties
kind string Kind of resource.
sku object Description of a SKU for a scalable resource.
identity object Managed service identity.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-functions-static-site-armresource-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-functions/json-schema/microsoft-azure-functions-static-site-armresource-schema.json",
  "title": "StaticSiteARMResource",
  "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-functions-static-sites-api-openapi.yml#/components/schemas/StaticSiteARMResource",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/StaticSite",
      "description": "Core resource properties",
      "x-ms-client-flatten": true
    },
    "kind": {
      "type": "string",
      "description": "Kind of resource."
    },
    "sku": {
      "$ref": "#/$defs/SkuDescription",
      "description": "Description of a SKU for a scalable resource."
    },
    "identity": {
      "$ref": "#/$defs/ManagedServiceIdentity",
      "description": "Managed service identity."
    }
  },
  "allOf": [
    {
      "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
    }
  ],
  "$defs": {
    "ArmIdWrapper": {
      "type": "object",
      "description": "A wrapper for an ARM resource id",
      "properties": {
        "id": {
          "type": "string",
          "readOnly": true
        }
      }
    },
    "ArmPlan": {
      "type": "object",
      "description": "The plan object in Azure Resource Manager, represents a marketplace plan.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name."
        },
        "publisher": {
          "type": "string",
          "description": "The publisher."
        },
        "product": {
          "type": "string",
          "description": "The product."
        },
        "promotionCode": {
          "type": "string",
          "description": "The promotion code."
        },
        "version": {
          "type": "string",
          "description": "Version of product."
        }
      }
    },
    "Capability": {
      "type": "object",
      "description": "Describes the capabilities/features allowed for a specific SKU.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the SKU capability."
        },
        "value": {
          "type": "string",
          "description": "Value of the SKU capability."
        },
        "reason": {
          "type": "string",
          "description": "Reason of the SKU capability."
        }
      }
    },
    "DatabaseConnectionOverview": {
      "type": "object",
      "description": "Static Site Database Connection overview.",
      "properties": {
        "resourceId": {
          "type": "string",
          "description": "The resource id of the database.",
          "readOnly": true
        },
        "connectionIdentity": {
          "type": "string",
          "description": "If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.",
          "readOnly": true
        },
        "region": {
          "type": "string",
          "description": "The region of the database resource.",
          "readOnly": true
        },
        "configurationFiles": {
          "type": "array",
          "description": "A list of configuration files associated with this database connection.",
          "items": {
            "$ref": "#/$defs/StaticSiteDatabaseConnectionConfigurationFileOverview"
          },
          "readOnly": true,
          "x-ms-identifiers": [
            "fileName"
          ]
        },
        "name": {
          "type": "string",
          "description": "If present, the name of this database connection resource.",
          "readOnly": true
        }
      }
    },
    "EnterpriseGradeCdnStatus": {
      "type": "string",
      "description": "State indicating the status of the enterprise grade CDN serving traffic to the static web app.",
      "enum": [
        "Enabled",
        "Enabling",
        "Disabled",
        "Disabling"
      ],
      "x-ms-enum": {
        "name": "EnterpriseGradeCdnStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "Enabled",
            "value": "Enabled"
          },
          {
            "name": "Enabling",
            "value": "Enabling"
          },
          {
            "name": "Disabled",
            "value": "Disabled"
          },
          {
            "name": "Disabling",
            "value": "Disabling"
          }
        ]
      }
    },
    "ErrorEntity": {
      "type": "object",
      "description": "Body of the error response returned from the API.",
      "properties": {
        "extendedCode": {
          "type": "string",
          "description": "Type of error."
        },
        "messageTemplate": {
          "type": "string",
          "description": "Message template."
        },
        "parameters": {
          "type": "array",
          "description": "Parameters for the template.",
          "items": {
            "type": "string"
          }
        },
        "innerErrors": {
          "type": "array",
          "description": "Inner errors.",
          "items": {
            "$ref": "#/$defs/ErrorEntity"
          },
          "x-ms-identifiers": []
        },
        "details": {
          "type": "array",
          "description": "Error Details.",
          "items": {
            "$ref": "#/$defs/ErrorEntity"
          },
          "x-ms-identifiers": []
        },
        "target": {
          "type": "string",
          "description": "The error target."
        },
        "code": {
          "type": "string",
          "description": "Basic error code."
        },
        "message": {
          "type": "string",
          "description": "Any details of the error."
        }
      }
    },
    "ManagedServiceIdentity": {
      "type": "object",
      "description": "Managed service identity.",
      "properties": {
        "type": {
          "$ref": "#/$defs/ManagedServiceIdentityType",
          "description": "Type of managed service identity."
        },
        "tenantId": {
          "type": "string",
          "description": "Tenant of managed service identity.",
          "readOnly": true
        },
        "principalId": {
          "type": "string",
          "description": "Principal Id of managed service identity.",
          "readOnly": true
        },
        "userAssignedIdentities": {
          "type": "object",
          "description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
          "additionalProperties": {
            "$ref": "#/$defs/UserAssignedIdentity"
          }
        }
      }
    },
    "ManagedServiceIdentityType": {
      "type": "string",
      "description": "Type of managed service identity.",
      "enum": [
        "SystemAssigned",
        "UserAssigned",
        "SystemAssigned, UserAssigned",
        "None"
      ],
      "x-ms-enum": {
        "name": "ManagedServiceIdentityType",
        "modelAsString": false
      }
    },
    "PrivateLinkConnectionState": {
      "type": "object",
      "description": "The state of a private link connection",
      "properties": {
        "status": {
          "type": "string",
          "description": "Status of a private link connection"
        },
        "description": {
          "type": "string",
          "description": "Description of a private link connection"
        },
        "actionsRequired": {
          "type": "string",
          "description": "ActionsRequired for a private link connection"
        }
      }
    },
    "ProxyOnlyResource": {
      "type": "object",
      "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Resource Id.",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "Resource Name.",
          "readOnly": true
        },
        "kind": {
          "type": "string",
          "description": "Kind of resource."
        },
        "type": {
          "type": "string",
          "description": "Resource type.",
          "readOnly": true
        }
      }
    },
    "RemotePrivateEndpointConnection": {
      "type": "object",
      "description": "A remote private endpoint connection",
      "properties": {
        "properties": {
          "$ref": "#/$defs/RemotePrivateEndpointConnectionProperties",
          "description": "RemotePrivateEndpointConnection resource specific properties",
          "x-ms-client-flatten": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/ProxyOnlyResource"
        }
      ]
    },
    "RemotePrivateEndpointConnectionProperties": {
      "type": "object",
      "description": "RemotePrivateEndpointConnection resource specific properties",
      "properties": {
        "provisioningState": {
          "type": "string",
          "readOnly": true
        },
        "privateEndpoint": {
          "$ref": "#/$defs/ArmIdWrapper",
          "description": "PrivateEndpoint of a remote private endpoint connection"
        },
        "privateLinkServiceConnectionState": {
          "$ref": "#/$defs/PrivateLinkConnectionState",
          "description": "The state of a private link connection"
        },
        "ipAddresses": {
          "type": "array",
          "description": "Private IPAddresses mapped to the remote private endpoint",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "ResponseMessageEnvelopeRemotePrivateEndpointConnection": {
      "type": "object",
      "description": "Message envelope that contains the common Azure resource manager properties and the resource provider specific content.",
      "properties": {
        "id": {
          "type": "string",
          "description": "Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"
        },
        "name": {
          "type": "string",
          "description": "Name of resource."
        },
        "type": {
          "type": "string",
          "description": "Type of resource e.g \"Microsoft.Web/sites\"."
        },
        "location": {
          "type": "string",
          "description": "Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."
        },
        "tags": {
          "type": "object",
          "description": "Tags associated with resource.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "plan": {
          "$ref": "#/$defs/ArmPlan",
          "description": "Azure resource manager plan."
        },
        "properties": {
          "$ref": "#/$defs/RemotePrivateEndpointConnection",
          "description": "Resource specific properties."
        },
        "sku": {
          "$ref": "#/$defs/SkuDescription",
          "description": "SKU description of the resource."
        },
        "status": {
          "type": "string",
          "description": "Azure-AsyncOperation Status info."
        },
        "error": {
          "$ref": "#/$defs/ErrorEntity",
          "description": "Azure-AsyncOperation Error info."
        },
        "identity": {
          "$ref": "#/$defs/ManagedServiceIdentity",
          "description": "MSI resource"
        },
        "zones": {
          "type": "array",
          "description": "Logical Availability Zones the service is hosted in",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "SkuCapacity": {
      "type": "object",
      "description": "Description of the App Service plan scale options.",
      "properties": {
        "minimum": {
          "type": "integer",
          "format": "int32",
          "description": "Minimum number of workers for this App Service plan SKU."
        },
        "maximum": {
          "type": "integer",
          "format": "int32",
          "description": "Maximum number of workers for this App Service plan SKU."
        },
        "elasticMaximum": {
          "type": "integer",
          "format": "int32",
          "description": "Maximum number of Elastic workers for this App Service plan SKU."
        },
        "default": {
          "type": "integer",
          "format": "int32",
          "description": "Default number of workers for this App Service plan SKU."
        },
        "scaleType": {
          "type": "string",
          "description": "Available scale configurations for an App Service plan."
        }
      }
    },
    "SkuDescription": {
      "type": "object",
      "description": "Description of a SKU for a scalable resource.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the resource SKU."
        },
        "tier": {
          "type": "string",
          "description": "Service tier of the resource SKU."
        },
        "size": {
          "type": "string",
          "description": "Size specifier of the resource SKU."
        },
        "family": {
          "type": "string",
          "description": "Family code of the resource SKU."
        },
        "capacity": {
          "type": "integer",
          "format": "int32",
          "description": "Current number of instances assigned to the resource."
        },
        "skuCapacity": {
          "$ref": "#/$defs/SkuCapacity",
          "description": "Min, max, and default scale values of the SKU."
        },
        "locations": {
          "type": "array",
          "description": "Locations of the SKU.",
          "items": {
            "type": "string"
          }
        },
        "capabilities": {
          "type": "array",
          "description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
          "items": {
            "$ref": "#/$defs/Capability"
          },
          "x-ms-identifiers": [
            "name"
          ]
        }
      }
    },
    "StagingEnvironmentPolicy": {
      "type": "string",
      "description": "State indicating whether staging environments are allowed or not allowed for a static web app.",
      "enum": [
        "Enabled",
        "Disabled"
      ],
      "x-ms-enum": {
        "name": "StagingEnvironmentPolicy",
        "modelAsString": false
      }
    },
    "StaticSite": {
      "type": "object",
      "description": "A static site.",
      "properties": {
        "defaultHostname": {
          "type": "string",
          "description": "The default autogenerated hostname for the static site.",
          "readOnly": true
        },
        "repositoryUrl": {
          "type": "string",
          "description": "URL for the repository of the static site."
        },
        "branch": {
          "type": "string",
          "description": "The target branch in the repository."
        },
        "customDomains": {
          "type": "array",
          "description": "The custom domains associated with this static site.",
          "items": {
            "type": "string"
          },
          "readOnly": true
        },
        "repositoryToken": {
          "type": "string",
          "description": "A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."
        },
        "buildProperties": {
          "$ref": "#/$defs/StaticSiteBuildProperties",
          "description": "Build properties to configure on the repository."
        },
        "privateEndpointConnections": {
          "type": "array",
          "description": "Private endpoint connections",
          "items": {
            "$ref": "#/$defs/ResponseMessageEnvelopeRemotePrivateEndpointConnection"
          },
          "readOnly": true
        },
        "stagingEnvironmentPolicy": {
          "$ref": "#/$defs/StagingEnvironmentPolicy",
          "description": "State indicating whether staging environments are allowed or not allowed for a static web app."
        },
        "allowConfigFileUpdates": {
          "type": "boolean",
          "description": "<code>false</code> if config file is locked for this static web app; otherwise, <code>true</code>."
        },
        "templateProperties": {
          "$ref": "#/$defs/StaticSiteTemplateOptions",
          "description": "Template options for generating a new repository."
        },
        "contentDistributionEndpoint": {
          "type": "string",
          "description": "The content distribution endpoint for the static site.",
          "readOnly": true
        },
        "keyVaultReferenceIdentity": {
          "type": "string",
          "description": "Identity to use for Key Vault Reference authentication.",
          "readOnly": true
        },
        "userProvidedFunctionApps": {
          "type": "array",
          "description": "User provided function apps registered with the static site",
          "items": {
            "$ref": "#/$defs/StaticSiteUserProvidedFunctionApp"
          },
          "readOnly": true
        },
        "linkedBackends": {
          "type": "array",
          "description": "Backends linked to the static side",
          "items": {
            "$ref": "#/$defs/StaticSiteLinkedBackend"
          },
          "readOnly": true,
          "x-ms-identifiers": []
        },
        "provider": {
          "type": "string",
          "description": "The provider that submitted the last deployment to the primary environment of the static site."
        },
        "enterpriseGradeCdnStatus": {
          "$ref": "#/$defs/EnterpriseGradeCdnStatus",
          "description": "State indicating the status of the enterprise grade CDN serving traffic to the static web app."
        },
        "publicNetworkAccess": {
          "type": "string",
          "description": "State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string."
        },
        "databaseConnections": {
          "type": "array",
          "description": "Database connections for the static site",
          "items": {
            "$ref": "#/$defs/DatabaseConnectionOverview"
          },
          "readOnly": true,
          "x-ms-identifiers": [
            "name"
          ]
        }
      }
    },
    "StaticSiteBuildProperties": {
      "type": "object",
      "description": "Build properties for the static site.",
      "properties": {
        "appLocation": {
          "type": "string",
          "description": "The path to the app code within the repository."
        },
        "apiLocation": {
          "type": "string",
          "description": "The path to the api code within the repository."
        },
        "appArtifactLocation": {
          "type": "string",
          "description": "Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"
        },
        "outputLocation": {
          "type": "string",
          "description": "The output path of the app after building."
        },
        "appBuildCommand": {
          "type": "string",
          "description": "A custom command to run during deployment of the static content application."
        },
        "apiBuildCommand": {
          "type": "string",
          "description": "A custom command to run during deployment of the Azure Functions API application."
        },
        "skipGithubActionWorkflowGeneration": {
          "type": "boolean",
          "description": "Skip Github Action workflow generation."
        },
        "githubActionSecretNameOverride": {
          "type": "string",
          "description": "Github Action secret name override."
        }
      }
    },
    "StaticSiteDatabaseConnectionConfigurationFileOverview": {
      "type": "object",
      "description": "A database connection configuration file",
      "properties": {
        "fileName": {
          "type": "string",
          "description": "The name of the configuration file.",
          "readOnly": true
        },
        "contents": {
          "type": "string",
          "description": "The Base64 encoding of the file contents.",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "description": "The type of configuration file.",
          "readOnly": true
        }
      }
    },
    "StaticSiteLinkedBackend": {
      "type": "object",
      "description": "Static Site Linked Backend ARM resource.",
      "properties": {
        "backendResourceId": {
          "type": "string",
          "description": "The resource id of the backend linked to the static site"
        },
        "region": {
          "type": "string",
          "description": "The region of the backend linked to the static site"
        },
        "createdOn": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time on which the backend was linked to the static site.",
          "readOnly": true
        },
        "provisioningState": {
          "type": "string",
          "description": "The provisioning state of the linking process.",
          "readOnly": true
        }
      }
    },
    "StaticSiteTemplateOptions": {
      "type": "object",
      "description": "Template Options for the static site.",
      "properties": {
        "templateRepositoryUrl": {
          "type": "string",
          "description": "URL of the template repository. The newly generated repository will be based on this one."
        },
        "owner": {
          "type": "string",
          "description": "Owner of the newly generated repository."
        },
        "repositoryName": {
          "type": "string",
          "description": "Name of the newly generated repository."
        },
        "description": {
          "type": "string",
          "description": "Description of the newly generated repository."
        },
        "isPrivate": {
          "type": "boolean",
          "description": "Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."
        }
      }
    },
    "StaticSiteUserProvidedFunctionApp": {
      "type": "object",
      "description": "A static site user provided function.",
      "properties": {
        "properties": {
          "$ref": "#/$defs/StaticSiteUserProvidedFunctionAppProperties",
          "description": "StaticSiteUserProvidedFunctionApp resource specific properties",
          "x-ms-client-flatten": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/ProxyOnlyResource"
        }
      ]
    },
    "StaticSiteUserProvidedFunctionAppProperties": {
      "type": "object",
      "description": "StaticSiteUserProvidedFunctionApp resource specific properties",
      "properties": {
        "functionAppResourceId": {
          "type": "string",
          "description": "The resource id of the function app registered with the static site"
        },
        "functionAppRegion": {
          "type": "string",
          "description": "The region of the function app registered with the static site"
        },
        "createdOn": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time on which the function app was registered with the static site.",
          "readOnly": true
        }
      }
    },
    "UserAssignedIdentity": {
      "type": "object",
      "description": "User Assigned identity.",
      "properties": {
        "principalId": {
          "type": "string",
          "description": "Principal Id of user assigned identity",
          "readOnly": true
        },
        "clientId": {
          "type": "string",
          "description": "Client Id of user assigned identity",
          "readOnly": true
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/microsoft-azure-functions-static-site-armresource"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.