docs/Azure_appServices_azure-paaS.js.html

<!DOCTYPE html>
<html lang="en">
	<head>
		<meta charset="utf-8" />
		<meta name="viewport" content="width=device-width, initial-scale=1" />
		<title>Azure/appServices/azure-paaS.js</title>

		<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
		<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
		<script src="./build/entry.js"></script>
		<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
		<!--[if lt IE 9]>
			<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
		<![endif]-->
		<link
			href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700"
			rel="stylesheet"
		/>
		<link
			rel="stylesheet"
			href="https://use.fontawesome.com/releases/v5.6.3/css/all.css"
			integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/"
			crossorigin="anonymous"
		/>
		<link
			type="text/css"
			rel="stylesheet"
			href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css"
		/>
		<link type="text/css" rel="stylesheet" href="styles/app.min.css" />
		<link type="text/css" rel="stylesheet" href="styles/iframe.css" />
		<link type="text/css" rel="stylesheet" href="" />
		<script async defer src="https://buttons.github.io/buttons.js"></script>
	</head>

	<body class="layout small-header">
		<div id="stickyNavbarOverlay"></div>

		<div class="top-nav">
			<div class="inner">
				<a
					id="hamburger"
					role="button"
					class="navbar-burger"
					aria-label="menu"
					aria-expanded="false"
				>
					<span aria-hidden="true"></span>
					<span aria-hidden="true"></span>
					<span aria-hidden="true"></span>
				</a>
				<div class="logo"></div>
				<div class="menu">
					<div class="navigation">
						<a href="index.html" class="link">
							API Documentation
						</a>
					</div>
				</div>
			</div>
		</div>
		<div id="main">
			<div class="sidebar " id="sidebarNav">
				<nav>
					<h2><a href="index.html">Documentation</a></h2>
					<div class="category"></div>
					<div class="category">
						<h2>AWS</h2>
						<h3>Classes</h3>
						<ul>
							<li>
								<a href="AWS_ArchivalStorage.html"
									>AWS_ArchivalStorage</a
								>
							</li>
							<li>
								<a href="AWS_BlockStorage.html"
									>AWS_BlockStorage</a
								>
							</li>
							<li>
								<a href="AWS_ComputeInstance.html"
									>AWS_ComputeInstance</a
								>
							</li>
							<li>
								<a href="AWS_Container.html">AWS_Container</a>
							</li>
							<li><a href="AWS_DNS.html">AWS_DNS</a></li>
							<li><a href="AWS_IAM.html">AWS_IAM</a></li>
							<li>
								<a href="AWS_KeyManagement.html"
									>AWS_KeyManagement</a
								>
							</li>
							<li>
								<a href="AWS_Kubernetes.html">AWS_Kubernetes</a>
							</li>
							<li>
								<a href="AWS_LoadBalancer.html"
									>AWS_LoadBalancer</a
								>
							</li>
							<li>
								<a href="AWS_Monitoring.html">AWS_Monitoring</a>
							</li>
							<li><a href="AWS_NoSql.html">AWS_NoSql</a></li>
							<li>
								<a href="AWS_NoSqlIndexed.html"
									>AWS_NoSqlIndexed</a
								>
							</li>
							<li>
								<a href="AWS_NotificationService.html"
									>AWS_NotificationService</a
								>
							</li>
							<li><a href="AWS_PaaS.html">AWS_PaaS</a></li>
							<li><a href="AWS_RDBMS.html">AWS_RDBMS</a></li>
							<li>
								<a href="AWS_StorageBucket.html"
									>AWS_StorageBucket</a
								>
							</li>
							<li>
								<a href="AWS_Translation.html"
									>AWS_Translation</a
								>
							</li>
						</ul>
					</div>
					<div class="category">
						<h2>Azure</h2>
						<h3>Classes</h3>
						<ul>
							<li>
								<a href="Azure_BlockStorage.html"
									>Azure_BlockStorage</a
								>
							</li>
							<li>
								<a href="Azure_ComputeInstance.html"
									>Azure_ComputeInstance</a
								>
							</li>
							<li>
								<a href="Azure_Container.html"
									>Azure_Container</a
								>
							</li>
							<li><a href="Azure_DNS.html">Azure_DNS</a></li>
							<li>
								<a href="Azure_KeyManagement.html"
									>Azure_KeyManagement</a
								>
							</li>
							<li>
								<a href="Azure_Kubernetes.html"
									>Azure_Kubernetes</a
								>
							</li>
							<li>
								<a href="Azure_LoadBalancer.html"
									>Azure_LoadBalancer</a
								>
							</li>
							<li>
								<a href="Azure_Monitoring.html"
									>Azure_Monitoring</a
								>
							</li>
							<li><a href="Azure_NoSql.html">Azure_NoSql</a></li>
							<li><a href="Azure_PaaS.html">Azure_PaaS</a></li>
							<li><a href="Azure_RDBMS.html">Azure_RDBMS</a></li>
							<li>
								<a href="Azure_StorageBucket.html"
									>Azure_StorageBucket</a
								>
							</li>
						</ul>
					</div>
					<div class="category">
						<h2>Digital Ocean</h2>
						<h3>Classes</h3>
						<ul>
							<li>
								<a href="DO_BlockStorage.html"
									>DO_BlockStorage</a
								>
							</li>
							<li>
								<a href="DO_ComputeInstance.html"
									>DO_ComputeInstance</a
								>
							</li>
							<li><a href="DO_DNS.html">DO_DNS</a></li>
							<li>
								<a href="DO_KeyManagement.html"
									>DO_KeyManagement</a
								>
							</li>
							<li>
								<a href="DO_Kubernetes.html">DO_Kubernetes</a>
							</li>
							<li>
								<a href="DO_LoadBalancer.html"
									>DO_LoadBalancer</a
								>
							</li>
							<li><a href="DO_NoSql.html">DO_NoSql</a></li>
							<li><a href="DO_RDBMS.html">DO_RDBMS</a></li>
						</ul>
					</div>
					<div class="category">
						<h2>Google Cloud</h2>
						<h3>Classes</h3>
						<ul>
							<li><a href="GCP_dns.html">GCP_dns</a></li>
							<li>
								<a href="GCP_KeyManagement.html"
									>GCP_KeyManagement</a
								>
							</li>
							<li>
								<a href="GCP_Kubernetes.html">GCP_Kubernetes</a>
							</li>
							<li>
								<a href="GCP_Monitoring.html">GCP_Monitoring</a>
							</li>
							<li><a href="GCP_NoSql.html">GCP_NoSql</a></li>
							<li>
								<a href="GCP_NotificationService.html"
									>GCP_NotificationService</a
								>
							</li>
							<li><a href="GCP_RDBMS.html">GCP_RDBMS</a></li>
							<li><a href="GCP_storage.html">GCP_storage</a></li>
							<li>
								<a href="GCP_Translation.html"
									>GCP_Translation</a
								>
							</li>
						</ul>
					</div>
					<div class="category">
						<h2>Linode</h2>
						<h3>Classes</h3>
						<ul>
							<li>
								<a href="Linode_BlockStorage.html"
									>Linode_BlockStorage</a
								>
							</li>
							<li>
								<a href="Linode_ComputeInstance.html"
									>Linode_ComputeInstance</a
								>
							</li>
							<li><a href="Linode_DNS.html">Linode_DNS</a></li>
							<li>
								<a href="Linode_Firewalls.html"
									>Linode_Firewalls</a
								>
							</li>
							<li>
								<a href="Linode_Images.html">Linode_Images</a>
							</li>
							<li>
								<a href="Linode_Kubernetes.html"
									>Linode_Kubernetes</a
								>
							</li>
							<li>
								<a href="Linode_LoadBalancer.html"
									>Linode_LoadBalancer</a
								>
							</li>
							<li>
								<a href="Linode_Monitoring.html"
									>Linode_Monitoring</a
								>
							</li>
							<li>
								<a href="Linode_NoSql.html">Linode_NoSql</a>
							</li>
						</ul>
					</div>
				</nav>
			</div>
			<div class="core" id="main-content-wrapper">
				<div class="content">
					<header class="page-title">
						<p>Source</p>
						<h1>Azure/appServices/azure-paaS.js</h1>
					</header>

					<section>
						<article>
							<pre
								class="prettyprint source linenums"
							><code>const { WebSiteManagementClient } = require("@azure/arm-appservice");
/*This is an auto generated class, please do not change.*/
/**
 * Class to create a PaaS object
 * @category Azure
 */
class Azure_PaaS {
    /**
     *
     * @param {module} azureRestSdk Azure Rest SDK
     */
    constructor(azureRestSdk) {
        this._azureRestSdk = azureRestSdk;
    }
    /**
     * Trigers the createOrUpdate function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {TypeReference} siteEnvelope - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;createOrUpdateResponse>}
     */
    create(resourceGroupName, name, siteEnvelope, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.webApps.createOrUpdate(resourceGroupName, name, siteEnvelope, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the update function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {TypeReference} siteEnvelope - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;updateResponse>}
     */
    update(resourceGroupName, name, siteEnvelope, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.webApps.update(resourceGroupName, name, siteEnvelope, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the get function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;getResponse>}
     */
    describe(resourceGroupName, name, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.webApps.get(resourceGroupName, name, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the deleteMethod function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;deleteMethodResponse>}
     */
    delete(resourceGroupName, name, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.webApps.deleteMethod(resourceGroupName, name, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the restart function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;restartResponse>}
     */
    restart(resourceGroupName, name, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.webApps.restart(resourceGroupName, name, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the createOrUpdate function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {TypeReference} hostingEnvironmentEnvelope - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;createOrUpdateResponse>}
     */
    createEnvironment(resourceGroupName, name, hostingEnvironmentEnvelope, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.appServiceEnvironments.createOrUpdate(resourceGroupName, name, hostingEnvironmentEnvelope, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the update function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {TypeReference} hostingEnvironmentEnvelope - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;updateResponse>}
     */
    updateEnvironment(resourceGroupName, name, hostingEnvironmentEnvelope, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.appServiceEnvironments.update(resourceGroupName, name, hostingEnvironmentEnvelope, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the createOrUpdateSlot function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {TypeReference} siteEnvelope - Mandatory parameter
     * @param {StringKeyword} slot - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;createOrUpdateSlotResponse>}
     */
    createConfigTemplate(resourceGroupName, name, siteEnvelope, slot, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.webApps.createOrUpdateSlot(resourceGroupName, name, siteEnvelope, slot, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the getSlot function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {StringKeyword} slot - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;getSlotResponse>}
     */
    describeConfigSettings(resourceGroupName, name, slot, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.webApps.getSlot(resourceGroupName, name, slot, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the deleteSlot function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {StringKeyword} slot - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;deleteSlotResponse>}
     */
    deleteConfigTemplate(resourceGroupName, name, slot, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.webApps.deleteSlot(resourceGroupName, name, slot, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the checkAvailability function of appservice
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;checkAvailabilityResponse>}
     */
    checkDNSAvailability(options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.domains.checkAvailability(options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
    /**
     * Trigers the deleteMethod function of appservice
     * @param {StringKeyword} resourceGroupName - Mandatory parameter
     * @param {StringKeyword} name - Mandatory parameter
     * @param {TypeReference} [options] - Optional parameter
     * @returns {Promise&lt;deleteMethodResponse>}
     */
    terminateEnvironment(resourceGroupName, name, options = undefined) {
        return new Promise((resolve, reject) => {
            this._azureRestSdk
                .loginWithServicePrincipalSecretWithAuthResponse(process.env.AZURE_CLIENT_ID, process.env.AZURE_CLIENT_SECRET, process.env.AZURE_TENANT_ID)
                .then(authres => {
                const client = new WebSiteManagementClient(authres.credentials, process.env.AZURE_SUBSCRIPTION_ID);
                client.appServiceEnvironments.deleteMethod(resourceGroupName, name, options).then(result => {
                    resolve(result);
                });
            })
                .catch(err => {
                reject(err);
            });
        });
    }
}
module.exports = Azure_PaaS;
</code></pre>
						</article>
					</section>
				</div>

				<footer class="footer">
					<div class="content has-text-centered">
						<p>
							Documentation generated by
							<a href="https://github.com/jsdoc3/jsdoc"
								>JSDoc 3.6.5</a
							>
						</p>
						<p class="sidebar-created-by">
							<a
								href="https://github.com/SoftwareBrothers/better-docs"
								target="_blank"
								>BetterDocs theme</a
							>
							provided with <i class="fas fa-heart"></i> by
							<a href="http://softwarebrothers.co" target="_blank"
								>SoftwareBrothers - JavaScript Development
								Agency</a
							>
						</p>
					</div>
				</footer>
			</div>
			<div id="side-nav" class="side-nav"></div>
		</div>
		<script src="scripts/app.min.js"></script>
		<script>
			PR.prettyPrint();
		</script>
		<script src="scripts/linenumber.js"></script>
	</body>
</html>