2020-11-09 00:23:30 -05:00
# Site Provisioning Manager
2019-08-19 05:25:02 -04:00
## Summary
This sample shows how you can manage site provisioning by calling Azure functions.
You can also find out how you can use React Hooks to manage the state of your application and share data across all components.
2021-11-07 01:43:55 -04:00
2022-02-14 02:52:18 -05:00
## Compatibility
2021-11-07 01:43:55 -04:00
2023-02-10 10:22:32 -05:00
| :warning: Important |
|:---------------------------|
| Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.|
|Refer to < https: / / aka . ms / spfx-matrix > for more information on SPFx compatibility. |
2021-11-07 01:43:55 -04:00
-Incompatible-red.svg "SharePoint Server 2016 Feature Pack 2 requires SPFx 1.1")
2019-08-19 05:25:02 -04:00
## Applies to
2022-10-24 09:42:45 -04:00
* [SharePoint Framework ](https://learn.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview )
* [Microsoft 365 tenant ](https://learn.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment )
2019-08-19 05:25:02 -04:00
2023-02-18 22:58:44 -05:00
## Contributors
2019-08-19 05:25:02 -04:00
2023-03-15 01:23:34 -04:00
* [Ramin Ahmadi ](https://github.com/AhmadiRamin )
2019-08-19 05:25:02 -04:00
## Version history
Version|Date|Comments
-------|----|--------
1.0|August 14, 2019|Initial release
## Features
2023-02-18 22:58:44 -05:00
2019-08-19 05:25:02 -04:00
This sample illustrates the following concepts on top of the SharePoint Framework:
* Using React Hooks.
* Using aadHttpClientFactory to call Azure functions.
* PnP/graph to call Microsoft Graph Api.
## Configure Azure Function
2019-08-26 12:28:21 -04:00
### Create a self signed certificate
1. Run below command using Create-SelfSignedCertificate.ps1 in powershell-scripts folder.
```
.\Create-SelfSignedCertificate.ps1 -CommonName "NAME" -StartDate 2019-08-11 -EndDate 2025-08-11 -Password (ConvertTo-SecureString -String "PASSWORD" -AsPlainText -Force)
```
> The dates are provided in US date format: YYYY-MM-dd
> Don't forget to update the PASSWORD and NAME.
2019-08-19 05:25:02 -04:00
### Publishing the Azure function app
Follow below steps in order to publish the functions:
1. Open Provisioning App solution with Visual Studio 2017/2019.
2019-08-26 12:28:21 -04:00
2. Copy the .pfx certificate you generated under the Cert folder.
3. Open ProvisioningApp.csproj in a text editor and make sure your cert name is included. If not, replace provisioningapp.pfx with your cert file name.
2019-08-19 05:25:02 -04:00
2. In Solution Explorer, right-click the project and select Publish.
3. In the Pick a publish target dialog, use the publish options as specified in the table below the image:
4. Select Publish. If you haven't already signed-in to your Azure account from Visual Studio, select Sign-in.
5. In the App Service: Create new dialog, enter the hosting settings.
6. Select Create to create a function app and related resources in Azure with these settings and deploy your function project code.
2019-08-26 12:28:21 -04:00
## Setting up an Azure AD app for app-only access
### Create a new app registration in Azure AD
1. Open Azure Portal https://portal.azure.com.
2. Click on Azure Active Directory.
3. Click on App registrations.
4. Click on New registration.
5. Give youre registration a name.
6. Click Register.
### Add your certificate to the app registration
1. Open Azure Portal https://portal.azure.com.
2. Select Azure Active Director, App Registration and then the App your created in previous steps.
3. Click on "Certificates & secrets".
4. Click on the "Upload certificate" button.
5. Select the .CER file you generated earlier and click on "Add" to upload it.
### API permissions
1. In the app registration we created earlier, click on API Permissions.
2. Click on the "Add a permission" button.
3. Choose the following permissions:
* SharePoint -> Application permissions -> Sites -> Sites.FullControl.All
4. Click Add permissions to save
5. Click Grant admin consent for the permissions to come into effect.
### Add the user_impersonation scope
Still in your Azure AD app, do the following:
1. Click on Expose API.
2. Click on Add scope
3. Approve the suggested URL or change it, if you like.
4. Fill in the following info:
- Scope name: `user_impersonation`
- Admin consent display name: `Access YourAzureAdAppDisplayName`
- Admin consent description: `Allow the application to access YourAzureAdAppDisplayName on behalf of the signed-in user.`
3. Press Add scope to save.
2019-08-19 05:25:02 -04:00
### Securing the Azure function app
1. Open Azure Portal https://portal.azure.com.
2019-08-26 12:28:21 -04:00
2. Click App Services and find the app you created earlier.
2019-08-19 05:25:02 -04:00
3. Click "Platform features" tab.
4. Under Networking, click "Authentication / Authorization".
5. In the option “App Service Authentication”, select “ON”.
6. For "Action to take when request is not authenticated" option, select “Log in with Azure Active Directory”.
7. Under “Authentication Providers”, select “Azure Active Directory”.
8. Select “Management mode” as Express.
2019-08-26 12:28:21 -04:00
9. Select the Azure AD app we registered earlier.
2019-08-19 05:25:02 -04:00
10. Click OK and then Save.
### Enable CORS on Azure Function
1. Click Platform features.
2. Under API, click CORS.
3. Specify the Office 365 tenant domain url and SharePoint local workbench url.
4. Click Save.
### Update App Settings
1. Go the `App Settings` page of the Azure functions.
2. Create new key/value entries under ‘ ’
Key|Value|Note
---|-----|----
2019-08-26 12:28:21 -04:00
CERTIFICATE| .pfx file name | you should copy .pfx file in Cert folder
2019-08-19 05:25:02 -04:00
PASSWORD| Password you set for the certificate file
CLIENTID| Application Registration Client ID| you can find the client id from overview tab
TENANT| e.x. contoso.onmicrosoft.com
2019-08-26 12:28:21 -04:00
## Installing the web part
In the package-solution.json, replace the value of `resource` (under `webApiPermissionRequests` ) with the name of your Azure AD app registration.
On the command line run (when in `webparts` dir):
- `npm install`
- `gulp bundle --ship`
- `gulp package-solution --ship`
- Drop the .sppkg file under `sharepoint\solution` to your tenant app catalog.
- Approve the API permissions via the new SharePoint admin center.
## Configuring the web part on a page
Open the web part configurations and set the values:
1. Application Id/EndPoint: the client ID of the Azure AD app registration used for authentication
2. Get provisioning function URL: Go to the Azure functions in Azure portal and click on "GetProvisioningTemplate" and then "Get function Url". Copy-paste that value in this field.
3. Apply provisioning function URL: Go to the Azure functions in Azure portal and click on "ApplyProvisioningTemplate" and then "Get function Url". Copy-paste that value in this field.
2023-03-12 21:16:15 -04:00
< img src = "https://m365-visitor-stats.azurewebsites.net/sp-dev-fx-webparts/samples/react-site-provisioning-manager" / >
