Function DeployApiAxiosParamCreator

Returns {
    adminConfigureDeployment: ((groupId, appId, deploymentConfig?, options?) => Promise<RequestArgs>);
    adminCreateDeploymentDraft: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminCreateDeploymentMigration: ((groupId, appId, appDeploymentSettings, options?) => Promise<RequestArgs>);
    adminDeployDraft: ((groupId, appId, draftId, adminDeployDraftRequest?, options?) => Promise<RequestArgs>);
    adminDeployDraftDiff: ((groupId, appId, draftId, options?) => Promise<RequestArgs>);
    adminDiscardDraft: ((groupId, appId, draftId, options?) => Promise<RequestArgs>);
    adminGetDeployment: ((groupId, appId, deploymentId, options?) => Promise<RequestArgs>);
    adminGetDeploymentConfig: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminGetDeploymentMigration: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminListAppRegions: ((options?) => Promise<RequestArgs>);
    adminListDeploymentDrafts: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminListDeployments: ((groupId, appId, options?) => Promise<RequestArgs>);
    adminRedeployDeployment: ((groupId, appId, deploymentId, options?) => Promise<RequestArgs>);
}

• adminConfigureDeployment: ((groupId, appId, deploymentConfig?, options?) => Promise<RequestArgs>)

  • • (groupId, appId, deploymentConfig?, options?): Promise<RequestArgs>

    • Modify an App's deployment configuration to customize how the App deploys changes.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • Optional deploymentConfig: DeploymentConfig

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Configure Deployment

      Throws

• adminCreateDeploymentDraft: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • Create a new application deployment draft, if none exists.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a Deployment Draft

      Throws

• adminCreateDeploymentMigration: ((groupId, appId, appDeploymentSettings, options?) => Promise<RequestArgs>)

  • • (groupId, appId, appDeploymentSettings, options?): Promise<RequestArgs>

    • Start a new deployment migration.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • appDeploymentSettings: AppDeploymentSettings

        The deployment model and cloud provider region that the App should migrate to.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Create a Deployment Migration

      Throws

• adminDeployDraft: ((groupId, appId, draftId, adminDeployDraftRequest?, options?) => Promise<RequestArgs>)

  • • (groupId, appId, draftId, adminDeployDraftRequest?, options?): Promise<RequestArgs>

    • Deploy the specified application deployment draft.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • draftId: any

        The unique `_id` value of a draft.

      • Optional adminDeployDraftRequest: AdminDeployDraftRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Deploy a deployment draft

      Throws

• adminDeployDraftDiff: ((groupId, appId, draftId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, draftId, options?): Promise<RequestArgs>

    • Return a diff between the currently deployed application and the specified draft.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • draftId: any

        The unique `_id` value of a draft.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Diff a draft with the current deployment

      Throws

• adminDiscardDraft: ((groupId, appId, draftId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, draftId, options?): Promise<RequestArgs>

    • Discard the specified application deployment draft.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • draftId: any

        The unique `_id` value of a draft.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Discard the specified deployment draft

      Throws

• adminGetDeployment: ((groupId, appId, deploymentId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, deploymentId, options?): Promise<RequestArgs>

    • Get information about a recent deployment of the application.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • deploymentId: any

        The `_id` value of an application deployment.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get a deployment

      Throws

• adminGetDeploymentConfig: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • See information about how your App deploys changes.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get the Deployment Configuration

      Throws

• adminGetDeploymentMigration: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • Get metadata and status for the current deployment migration, if one exists.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get a Deployment Migration

      Throws

• adminListAppRegions: ((options?) => Promise<RequestArgs>)

  • • (options?): Promise<RequestArgs>

    • Return a list of all supported cloud regions in which you can deploy an Atlas App.

      Parameters

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List all available Atlas App cloud regions

      Throws

• adminListDeploymentDrafts: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • Return the current application deployment draft, if applicable.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Get Current Deployment Draft

      Throws

• adminListDeployments: ((groupId, appId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, options?): Promise<RequestArgs>

    • Return the 25 most recent application deployments.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      List recent deployments

      Throws

• adminRedeployDeployment: ((groupId, appId, deploymentId, options?) => Promise<RequestArgs>)

  • • (groupId, appId, deploymentId, options?): Promise<RequestArgs>

    • Redeploy a previously-deployed version of an App.

      Parameters

      • groupId: any

        An Atlas Project/Group ID.

      • appId: any

        The ObjectID of your application. The App Services API Project and Application IDs section demonstrates how to find this value.

      • deploymentId: any

        The `_id` value of an application deployment.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Redeploy a Deployment

      Throws