mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
74 lines
2.0 KiB
Markdown
74 lines
2.0 KiB
Markdown
<!--
|
|
title: Serverless Framework Commands - Azure Functions - Install
|
|
menuText: install
|
|
menuOrder: 8
|
|
description: Install pre-written Azure Functions Functions, Events and Resources with the Serverless Framework
|
|
layout: Doc
|
|
-->
|
|
|
|
<!-- DOCS-SITE-LINK:START automatically generated -->
|
|
|
|
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/azure/cli-reference/install)
|
|
|
|
<!-- DOCS-SITE-LINK:END -->
|
|
|
|
# Azure - Install
|
|
|
|
Installs a service from a GitHub URL in the current working directory.
|
|
|
|
```bash
|
|
serverless install --url https://github.com/some/service
|
|
```
|
|
|
|
## Options
|
|
|
|
- `--url` or `-u` The services Git URL (can be a plain Git or a Code Hosting Platform URL). **Required**.
|
|
- `--name` or `-n` Name for the service.
|
|
|
|
## Provided lifecycle events
|
|
|
|
- `install:install`
|
|
|
|
## Supported Code Hosting Platforms
|
|
|
|
- GitHub
|
|
- GitHub Enterprise
|
|
- GitLab
|
|
- BitBucket
|
|
- BitBucket Server
|
|
|
|
## Examples
|
|
|
|
### Installing a service from a GitHub URL
|
|
|
|
```bash
|
|
serverless install --url https://github.com/azure/boilerplate-azurefunctions
|
|
```
|
|
|
|
This example will download the .zip file of the `serverless-azure-boilerplate`
|
|
service from GitHub, create a new directory with the name
|
|
`serverless-azure-boilerplate` in the current working directory and unzips the
|
|
files in this
|
|
directory.
|
|
|
|
### Installing a service from a GitHub URL with a new service name
|
|
|
|
```bash
|
|
serverless install --url https://github.com/azure/boilerplate-azurefunctions --name my-app
|
|
```
|
|
|
|
This example will download the .zip file of the `boilerplate-azurefunctions`
|
|
service from GitHub, create a new directory with the name `my-app` in the current
|
|
working directory and unzips the files in this directory and renames the service
|
|
to `my-app` if `serverless.yml` exists in the service root.
|
|
|
|
### Installing a service from a directory in a GitHub URL
|
|
|
|
```bash
|
|
serverless install --url
|
|
https://github.com/serverless/examples/tree/master/azure-node-simple-http-endpoint
|
|
```
|
|
|
|
This example will download the `azure-node-simple-http-endpoint` service from
|
|
GitHub.
|