|
| 1 | +--- |
| 2 | +online version: https://github.com/Azure/sap-hana |
| 3 | +schema: 2.0.0 |
| 4 | +author: kimforss |
| 5 | +ms.author: kimforss |
| 6 | +ms.reviewer: kimforss |
| 7 | +ms.date: 10/21/2021 |
| 8 | +ms.topic: reference |
| 9 | +ms.service: virtual-machines-sap |
| 10 | +title: set_secrets.sh |
| 11 | +description: Sets the SPN Secrets in Azure Key vault using a shell script. |
| 12 | +--- |
| 13 | + |
| 14 | +# set_secrets.sh |
| 15 | + |
| 16 | +## Synopsis |
| 17 | +Sets the service principal secrets in Azure Key Vault. |
| 18 | + |
| 19 | +## Syntax |
| 20 | + |
| 21 | +```bash |
| 22 | + |
| 23 | +set_secrets.sh [--region] <String> [--environment] <String> [--vault] <String> [--subscription] <String> [--spn_id] <String> |
| 24 | + [--spn_secret] <String> [--tenant_id] <String> |
| 25 | +``` |
| 26 | + |
| 27 | +## Description |
| 28 | +Sets the secrets in Key Vault that the deployment automation requires. |
| 29 | + |
| 30 | +## EXAMPLES |
| 31 | + |
| 32 | +### EXAMPLE 1 |
| 33 | + |
| 34 | +```bash |
| 35 | + |
| 36 | +set_secrets.sh --environment DEV \ |
| 37 | + --region weeu \ |
| 38 | + --vault MGMTWEEUDEP00userABC \ |
| 39 | + --subscription xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \ |
| 40 | + --spn_id yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy \ |
| 41 | + --spn_secret ************************ \ |
| 42 | + --tenant_id zzzzzzzz-zzzz-zzzz-zzzz-zzzzzzzzzzzz |
| 43 | +``` |
| 44 | + |
| 45 | +## Parameters |
| 46 | + |
| 47 | +### `--region` |
| 48 | +Sets the name of the Azure region for deployment. |
| 49 | + |
| 50 | +```yaml |
| 51 | +Type: String |
| 52 | +Aliases: `-r` |
| 53 | + |
| 54 | +Required: True |
| 55 | +``` |
| 56 | +
|
| 57 | +### `--environment` |
| 58 | +Sets the name of the deployment environment. |
| 59 | + |
| 60 | +```yaml |
| 61 | +Type: String |
| 62 | +```yaml |
| 63 | +Type: String |
| 64 | +Aliases: `-e` |
| 65 | + |
| 66 | +Required: True |
| 67 | +``` |
| 68 | +
|
| 69 | +### `--vault` |
| 70 | +Sets the name of the key vault. |
| 71 | + |
| 72 | +```yaml |
| 73 | +Type: String |
| 74 | +Aliases: `-v` |
| 75 | + |
| 76 | +Required: True |
| 77 | +``` |
| 78 | +
|
| 79 | +### `-spn_id` |
| 80 | +Sets the service principal's app ID. For more information, see [Prepare the deployment credentials](../automation-deploy-control-plane.md#prepare-the-deployment-credentials). |
| 81 | + |
| 82 | +```yaml |
| 83 | +Type: String |
| 84 | +Aliases: `-c` |
| 85 | + |
| 86 | +Required: False |
| 87 | +``` |
| 88 | +
|
| 89 | +### `--spn_secret` |
| 90 | +Sets the Service Principal password. For more information, see [Prepare the deployment credentials](../automation-deploy-control-plane.md#prepare-the-deployment-credentials). |
| 91 | + |
| 92 | +```yaml |
| 93 | +Type: String |
| 94 | +Aliases: `-p` |
| 95 | + |
| 96 | +Required: False |
| 97 | +``` |
| 98 | +
|
| 99 | +### `--tenant_id` |
| 100 | +Sets the tenant ID for the service principal. For more information, see [Prepare the deployment credentials](../automation-deploy-control-plane.md#prepare-the-deployment-credentials). |
| 101 | + |
| 102 | +```yaml |
| 103 | +Type: String |
| 104 | +Aliases: `-t` |
| 105 | + |
| 106 | +Required: False |
| 107 | +``` |
| 108 | +
|
| 109 | +## Notes |
| 110 | +v0.9 - Initial version |
| 111 | +
|
| 112 | +
|
| 113 | +Copyright (c) Microsoft Corporation. |
| 114 | +Licensed under the MIT license. |
| 115 | +## Related links |
| 116 | +
|
| 117 | +[GitHub repository: SAP deployment automation framework](https://github.com/Azure/sap-hana) |
0 commit comments