Service blueprint parameters for Azure
This topic outlines the guidelines to remember when adding parameters to a service blueprint for Azure. For additional information, see Configuring service blueprint parameters.
This topic includes the following sections:
Defining parameters for Azure Resource Manager
In version 4.6.05 and later, if the provider is Azure Resource Manager (not the classic Service Manager), you can add the following parameters to the blueprint. For more information, see Provisioning for Azure Resource Manager (with or without templates).
Because the parameters require background technical knowledge, you should enter the value in the blueprint and select No for the User Entry field for the parameters.
If you have hidden the username and password field for Azure SOIs, provisioning fails. You must specify #username# and #password# as blueprint parameters with their respective values. The label should also be same for both the parameters. These parameters are case-sensitive.
Tip
If you decide to ask end users to enter the value for a parameter in the service request form, enter a clear description so that they can click on the tooltip icon next to the field to learn what the field (parameter) requires. For more information, see Configuring service blueprint parameters.
Valid Azure Component | Parameter | Description |
---|---|---|
Azure Template Provider Azure Resource Manager | resource-container | The type of resource in which to place the provisioned service. You can enter any one of the following values:
|
Azure Resource Manager only | AZURE_OS_TYPE | For private or custom images, identifies the operating system for the provisioned service. This parameter must be specified for a successful provisioning. Azure Resource Manager supports only the Windows or Linux keywords as values for this parameter. This parameter is not required when you are deploying VM with managed disk from a managed image. However, you must provide this parameter when you are deploying VM with managed disk from an unmanaged image. |
Azure Resource Manager only | Azure_StorageAccount_Name | Defines the Azure storage account where you want to place the provisioned Azure service. The field is case-sensitive, and you must enter the exact name. If a name is not entered, a new storage account is created. If an incorrect name is entered, the service request returns an error. The behavior related to this parameter is as follows:
You can use the Azure_StorageAccount_Name parameter at the resource-set level, but use the following naming convention: ResourceSet: Azure_StorageAccount_Name For example, if the resource set is named Server Group 1, enter: Server Group 1: Azure_StorageAccount_Name |
Azure Resource Manager only | NEW IN 4.6.06AZURE_STORAGE | Defines whether to deploy a VM with managed disks or unmanaged disks. The default value of the AZURE_STORAGE parameter is unmanaged_disks. If you set the value of the parameter at the service blueprint level and at the definition level, the value of the parameter set in the definition take precedence. You can select the value of the Azure Storage property at the service-definition level (select Service Properties > Parameters) or the deployment-definition level (Definition > Parameters). For more information, see To set up support for managed disk and replication type. |
Azure Resource Manager only | AVAILABILITY_SET_NAME | Defines a new availability set at the deployment definition level to apply to all the resource sets within. To define this parameter, select the deployment definition in the blueprint, and define the parameters for that particular resource. You can use the AVAILABILITY_SET_NAME parameter at the resource-set level, but use the following naming convention: AVAILABILITY_SET_NAME#ResourceSet For example, if the resource set is named Server Group 1, enter: AVAILABILITY_SET_NAME#Server Group 1 If you are using BMC Cloud Lifecycle Management 4.6.05.002, you can create a new availability set by using the AVAILABILITY_SET_NAME parameter at the resource-set level with the following naming convention for Name and Default Value field respectively: Name - ResourceSet: AVAILABILITY_SET_NAME Default Value - <AvailabilitySetName>:<Fault Domain>: < Update Domain> where, the value of the Fault Domain and Update Domain must be an integer and accepted by Azure. For example, if the resource set is named Server Group 1, and availability set name is EastCoast_1, enter: Name - Server Group 1:AVAILABILITY_SET_NAME Default Value - EastCoast_1:3:2 For more information about availibility set, see https://docs.microsoft.com/en-us/azure/virtual-machines/windows/manage-availability. Note In BMC Cloud Lifecycle Management 4.6.05.002, if you are using an exisiting availability set, you cannot update the Fault Domain and Update Domain properties. |
Azure Resource Manager only | InstanceFamily | Defines the instance family or instance type series. For the parameter's value, enter the instance family name, for example, D-Series, DSV2-Series, or G-Series. For more information, see the Microsoft documentation at https://docs.microsoft.com/en-us/azure/virtual-machines/virtual-machines-windows-sizes. |
Azure Resource Manager only | InstanceSize | Defines the instance size, which is a subset of the instance family, which is defined above. For example, you might enter Standard_D1, Standard_D14_v2, or Standard_G1. |
Parameters that enable you to add tags to the Azure resources: | ||
Azure Resource Manager only | ARM_TAGS | Adds tags to the Azure resource. These might be helpful, for example, if the you want to tag resources for billing purposes. Add tags in a comma-separated list of name=value pairs, for example: tagName=tagValue, tagName=tagValue tag1=DBTier,tag2=WebTier |
Azure Resource Manager only | Tag-Level | Defines the level to which the ARM_TAGS tags are applied.
You can use this parameter at the resource-set level, but use the following format: ResourceSet: ARM_TAGS For example, if the resource set is named Server Group 1, enter: Server Group 1: ARM_TAGS |
Azure Resource Manager only | InstanceSize | Defines the instance size for an Azure instance. You can use this parameter at the resource-set level, but use the following format: ResourceSet:InstanceSize |
Azure Resource Manager only | InstanceFamily | Defines the instance family or instance type series for an Azure instance. You can use this parameter at the resource-set level, but use the following format: ResourceSet:InstanceFamily |
You can add these parameters at the service-definition level (select Service Properties > Parameters) or the deployment-definition level (Definition > Parameters).
If you want fields for these parameters to appear on the service request, select the User Entry Enabled check box when creating the parameter. If you added default values, the fields will include those default values.
Tip
Although not recommended, you can select Yes for User Entry, and the parameter will appear as a field in the Catalog details page. To help the end user understand what to enter in the field, edit the Description field of the parameter in the service blueprint.
For example, if you select User Entry Enabled for the AZURE_OS_TYPE parameter, the end user will see an AZURE_OS_TYPE field. In the service blueprint, enter a description such as "Windows, Linux" to help the user understand what to enter in the field. For the Azure_StorageAccount_Name parameter, you might want to enter directions such as "Enter the exact name of the Azure storage account. This field is case-senstiive."
Defining BmcSecurityGroups for deployment packages
In version 4.6.03 and later, make sure to define the BmcSecurityGroups
parameter so that the groups are applied to the deployment packages during VM provisioning. Remember these tips:
- This definition parameter enables an Azure instance to be placed within a security group (firewall).
- This security group allows RSCD agent traffic through port 4750 and remote access through an SSH or RDP port.
- If you select the Enabled option, BMC Cloud Lifecycle Management end users can control firewall policies for a server.
- On the Azure Portal, the network security group is created with the following format <serviceName>-<serverName>.
Adding local users in a provisioned VM
You cannot add new OS users after the VM has been provisioned. However, you can add users by using BMC Server Automation and you must add the following service blueprint definition parameters to enable addition of local users in a provisioned VM:
UNIX_USER
orWINDOWS_USER
parameterUNIX_USER_PASSWORD
orWINDOWS_USER_PASSWORD
parameter
For instructions, see Creating a BLPackage for adding local users in the Azure Provider.
Note
To enable addition of local users as a post-deployment action, you must define the Add local user option and configure the option choice details.
Defining BmcSecurityGroups for deployment packages for Azure Service Manager
(Available only on the BMC Cloud Lifecycle Management community) This is applicable only for Azure Classic (Azure Service Manager). After you download and deploy AzureProviderHotfix4.5.00.1242016.zip, you can specify a new parameter NetworkACL in the service blueprint. The parameter allows you to set up the Access Control List (ACL) at the RSCD endpoint. You must specify a valid Classless Inter-Domain Routing (CIDR) value for this parameter; for example, specify 10.0.0.0/24, which is the public subnet of the BMC Cloud Lifecycle Management stack.
Note
NetworkACL is only applicable to the endpoint opened by the provider implicitly before communicating with BMC Server Automation and not using the Network Paths feature.
For details about downloading and deploying this hotfix, see https://communities.bmc.com/docs/DOC-26795 on BMC Cloud Lifecycle Management Communities.
Comments
Log in or register to comment.