Microsoft Azure App Service Static Sites Async Operations API

openapi: 3.2.0
info:
  title: Microsoft Azure App Service Static Sites Async Operations…
  version: '2026-08-01'
  x-typespec-generated:
  - emitter: '@azure-tools/typespec-autorest'
  description: 'Operations tagged StaticSitesAsyncOperations across 2 of this provider''s published API definitions: microsoft-azure-app-service-openapi-original.json, microsoft-azure-app-service-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://management.azure.com
security:
- azure_auth:
  - user_impersonation
tags:
- name: StaticSitesAsyncOperations
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/staticSitesOperationResults/{operationId}:
    get:
      operationId: StaticSitesAsyncOperations_GetOperationResult
      tags:
      - StaticSitesAsyncOperations
      summary: Gets the result of a static site async operation
      description: Gets the result of a static site async operation.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/Resource
        '202':
          description: Resource operation accepted.
          headers:
            Location:
              description: The Location header contains the URL where the status of the long running operation can be checked.
              schema:
                type: string
            Retry-After:
              description: The Retry-After header can indicate how long the client should wait before polling the operation status.
              schema:
                type: integer
                format: int32
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorResponse'
    servers:
    - url: https://management.azure.com
  /subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/staticSitesOperationStatuses/{operationId}:
    get:
      operationId: StaticSitesAsyncOperations_GetOperationStatus
      tags:
      - StaticSitesAsyncOperations
      summary: Gets the status of a static site async operation
      description: Gets the status of a static site async operation.
      parameters:
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter
      - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/OperationIdParameter
      responses:
        '200':
          description: Azure operation completed successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaticSitesOperationStatus'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DefaultErrorResponse'
    servers:
    - url: https://management.azure.com
components:
  schemas:
    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.
    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

            value for GET requests only.

            For 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: '#/components/schemas/ArmPlan'
          description: Azure resource manager plan.
        properties:
          $ref: '#/components/schemas/RemotePrivateEndpointConnection'
          description: Resource specific properties.
        sku:
          $ref: '#/components/schemas/SkuDescription'
          description: SKU description of the resource.
        status:
          type: string
          description: Azure-AsyncOperation Status info.
        error:
          $ref: '#/components/schemas/ErrorEntity'
          description: Azure-AsyncOperation Error info.
        identity:
          $ref: '#/components/schemas/ManagedServiceIdentity'
          description: MSI resource
        zones:
          type: array
          description: Logical Availability Zones the service is hosted in
          items:
            type: string
    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
    DefaultErrorResponseError:
      type: object
      description: Error model.
      properties:
        code:
          type: string
          description: Standardized string to programmatically identify the error.
          readOnly: true
        message:
          type: string
          description: Detailed error description and debugging information.
          readOnly: true
        target:
          type: string
          description: Detailed error description and debugging information.
          readOnly: true
        details:
          type: array
          items:
            $ref: '#/components/schemas/DefaultErrorResponseErrorDetailsItem'
          x-ms-identifiers: []
        innererror:
          type: string
          description: More information to debug error.
          readOnly: true
    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: '#/components/schemas/ErrorEntity'
          x-ms-identifiers: []
        details:
          type: array
          description: Error Details.
          items:
            $ref: '#/components/schemas/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.
    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: '#/components/schemas/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: '#/components/schemas/Capability'
          x-ms-identifiers:
          - name
    ErrorResponse:
      type: object
      description: Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
      properties:
        error:
          $ref: '#/components/schemas/ErrorProperties'
          description: The error properties.
    RemotePrivateEndpointConnectionProperties:
      type: object
      description: RemotePrivateEndpointConnection resource specific properties
      properties:
        provisioningState:
          type: string
          readOnly: true
        privateEndpoint:
          $ref: '#/components/schemas/ArmIdWrapper'
          description: PrivateEndpoint of a remote private endpoint connection
        privateLinkServiceConnectionState:
          $ref: '#/components/schemas/PrivateLinkConnectionState'
          description: The state of a private link connection
        ipAddresses:
          type: array
          description: Private IPAddresses mapped to the remote private endpoint
          items:
            type: string
    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.
          x-ms-secret: true
        buildProperties:
          $ref: '#/components/schemas/StaticSiteBuildProperties'
          description: Build properties to configure on the repository.
        privateEndpointConnections:
          type: array
          description: Private endpoint connections
          items:
            $ref: '#/components/schemas/ResponseMessageEnvelopeRemotePrivateEndpointConnection'
          readOnly: true
        stagingEnvironmentPolicy:
          $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/StaticSiteUserProvidedFunctionApp'
          readOnly: true
        linkedBackends:
          type: array
          description: Backends linked to the static side
          items:
            $ref: '#/components/schemas/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: '#/components/schemas/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: '#/components/schemas/DatabaseConnectionOverview'
          readOnly: true
          x-ms-identifiers:
          - name
    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).
    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
    StaticSiteUserProvidedFunctionApp:
      type: object
      description: A static site user provided function.
      properties:
        properties:
          $ref: '#/components/schemas/StaticSiteUserProvidedFunctionAppProperties'
          description: StaticSiteUserProvidedFunctionApp resource specific properties
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/ProxyOnlyResource'
    StaticSitesOperationStatus:
      type: object
      description: Status object for a static sites asynchronous operation.
      properties:
        id:
          type: string
          description: The fully qualified ID for the staticSitesOperationStatus.  For example, /subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSitesOperationStatuses/{operationId}
          readOnly: true
        type:
          type: string
          description: The type of the resource.  For example, Microsoft.Web/staticSitesOperationStatuses
          readOnly: true
        name:
          type: string
          description: The name of the staticSitesOperationStatus. For example, a1f6e015-a5de-468f-ad54-9c75638d7134
          readOnly: true
        properties:
          $ref: '#/components/schemas/StaticSitesOperationStatusProperties'
          description: Properties of the async operation status.
    ManagedServiceIdentity:
      type: object
      description: Managed service identity.
      properties:
        type:
          $ref: '#/components/schemas/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: '#/components/schemas/UserAssignedIdentity'
    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.
    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
    ArmIdWrapper:
      type: object
      description: A wrapper for an ARM resource id
      properties:
        id:
          type: string
          readOnly: true
    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: '#/components/schemas/StaticSiteDatabaseConnectionConfigurationFileOverview'
          readOnly: true
          x-ms-identifiers:
          - fileName
        name:
          type: string
          description: If present, the name of this database connection resource.
          readOnly: true
    RemotePrivateEndpointConnection:
      type: object
      description: A remote private endpoint connection
      properties:
        properties:
          $ref: '#/components/schemas/RemotePrivateEndpointConnectionProperties'
          description: RemotePrivateEndpointConnection resource specific properties
          x-ms-client-flatten: true
      allOf:
      - $ref: '#/components/schemas/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
    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
    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
    DefaultErrorResponse:
      type: object
      description: App Service error response.
      properties:
        error:
          $ref: '#/components/schemas/DefaultErrorResponseError'
          description: Error model.
          readOnly: true
    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
    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
    DefaultErrorResponseErrorDetailsItem:
      type: object
      description: Detailed errors.
      properties:
        code:
          type: string
          description: Standardized string to programmatically identify the error.
          readOnly: true
        message:
          type: string
          description: Detailed error description and debugging information.
          readOnly: true
        target:
          type: string
          description: Detailed error description and debugging information.
          readOnly: true
    StaticSitesOperationStatusProperties:
      type: object
      description: Properties of a static sites asynchronous operation status.
      properties:
        status:
          type: string
          description: The current status of the asynchronous operation performed. For example, Running, Succeeded, Failed
          readOnly: true
        startTime:
          type: string
          description: The start time of the asynchronous operation.
        endTime:
          type: string
          description: The end time of the asynchronous operation.
        staticSiteProperties:
          $ref: '#/components/schemas/StaticSite'
          description: The generic properties of a staticSite.
        error:
          $ref: '#/components/schemas/ErrorResponse'
          description: Error details for the asynchronous operation, if any.
    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.
    ManagedServiceIdentityType:
      type: string
      description: Type of managed service identity.
      enum:
      - SystemAssigned
      - UserAssigned
      - SystemAssigned, UserAssigned
      - None
      x-ms-enum:
        name: ManagedServiceIdentityType
        modelAsString: false
    ErrorProperties:
      type: object
      description: Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
      properties:
        code:
          type: string
          description: Error code.
        message:
          type: string
          description: Error message indicating why the operation failed.
    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.
  securitySchemes:
    azure_auth:
      type: oauth2
      flows:
        implicit:
          scopes:
            user_impersonation: impersonate your user account
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
      description: Azure Active Directory OAuth2 Flow.
x-refined-from:
- microsoft-azure-app-service-openapi-original.json
- microsoft-azure-app-service-openapi.yml