CloudService
Provides a CloudService from the Compute group
Examples
Create New Cloud Service with Single Role
exports.createResources = () => [
{
type: "CloudService",
group: "Compute",
name: "myCloudService",
properties: () => ({
location: "westus",
properties: {
networkProfile: {
loadBalancerConfigurations: [
{
properties: {
frontendIPConfigurations: [
{
properties: {
publicIPAddress: {
id: "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/myPublicIP",
},
},
name: "myfe",
},
],
},
name: "myLoadBalancer",
},
],
},
roleProfile: {
roles: [
{
sku: { name: "Standard_D1_v2", capacity: 1, tier: "Standard" },
name: "ContosoFrontend",
},
],
},
configuration: "{ServiceConfiguration}",
packageUrl: "{PackageUrl}",
upgradeMode: "Auto",
},
}),
dependencies: ({}) => ({
resourceGroup: "myResourceGroup",
vaults: ["myVault"],
publicIpAddresses: ["myPublicIPAddress"],
subnets: ["mySubnet"],
}),
},
];
Create New Cloud Service with Single Role and RDP Extension
exports.createResources = () => [
{
type: "CloudService",
group: "Compute",
name: "myCloudService",
properties: () => ({
properties: {
extensionProfile: {
extensions: [
{
properties: {
type: "RDP",
autoUpgradeMinorVersion: false,
protectedSettings:
"<PrivateConfig><Password>{password}</Password></PrivateConfig>",
publisher: "Microsoft.Windows.Azure.Extensions",
settings:
"<PublicConfig><UserName>UserAzure</UserName><Expiration>10/22/2021 15:05:45</Expiration></PublicConfig>",
typeHandlerVersion: "1.2",
},
name: "RDPExtension",
},
],
},
networkProfile: {
loadBalancerConfigurations: [
{
properties: {
frontendIPConfigurations: [
{
properties: {
publicIPAddress: {
id: "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip",
},
},
name: "contosofe",
},
],
},
name: "contosolb",
},
],
},
roleProfile: {
roles: [
{
sku: { name: "Standard_D1_v2", capacity: 1, tier: "Standard" },
name: "ContosoFrontend",
},
],
},
configuration: "{ServiceConfiguration}",
packageUrl: "{PackageUrl}",
upgradeMode: "Auto",
},
location: "westus",
}),
dependencies: ({}) => ({
resourceGroup: "myResourceGroup",
vaults: ["myVault"],
publicIpAddresses: ["myPublicIPAddress"],
subnets: ["mySubnet"],
}),
},
];
Create New Cloud Service with Multiple Roles
exports.createResources = () => [
{
type: "CloudService",
group: "Compute",
name: "myCloudService",
properties: () => ({
properties: {
networkProfile: {
loadBalancerConfigurations: [
{
properties: {
frontendIPConfigurations: [
{
properties: {
publicIPAddress: {
id: "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip",
},
},
name: "contosofe",
},
],
},
name: "contosolb",
},
],
},
roleProfile: {
roles: [
{
sku: { name: "Standard_D1_v2", capacity: 1, tier: "Standard" },
name: "ContosoFrontend",
},
{
sku: { name: "Standard_D1_v2", capacity: 1, tier: "Standard" },
name: "ContosoBackend",
},
],
},
configuration: "{ServiceConfiguration}",
packageUrl: "{PackageUrl}",
upgradeMode: "Auto",
},
location: "westus",
}),
dependencies: ({}) => ({
resourceGroup: "myResourceGroup",
vaults: ["myVault"],
publicIpAddresses: ["myPublicIPAddress"],
subnets: ["mySubnet"],
}),
},
];
Create New Cloud Service with Single Role and Certificate from Key Vault
exports.createResources = () => [
{
type: "CloudService",
group: "Compute",
name: "myCloudService",
properties: () => ({
location: "westus",
properties: {
networkProfile: {
loadBalancerConfigurations: [
{
properties: {
frontendIPConfigurations: [
{
properties: {
publicIPAddress: {
id: "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.Network/publicIPAddresses/contosopublicip",
},
},
name: "contosofe",
},
],
},
name: "contosolb",
},
],
},
osProfile: {
secrets: [
{
sourceVault: {
id: "/subscriptions/{subscription-id}/resourceGroups/ConstosoRG/providers/Microsoft.KeyVault/vaults/{keyvault-name}",
},
vaultCertificates: [
{
certificateUrl:
"https://{keyvault-name}.vault.azure.net:443/secrets/ContosoCertificate/{secret-id}",
},
],
},
],
},
roleProfile: {
roles: [
{
sku: { name: "Standard_D1_v2", capacity: 1, tier: "Standard" },
name: "ContosoFrontend",
},
],
},
configuration: "{ServiceConfiguration}",
packageUrl: "{PackageUrl}",
upgradeMode: "Auto",
},
}),
dependencies: ({}) => ({
resourceGroup: "myResourceGroup",
vaults: ["myVault"],
publicIpAddresses: ["myPublicIPAddress"],
subnets: ["mySubnet"],
}),
},
];
Dependencies
Swagger Schema
{
description: 'Describes the cloud service.',
type: 'object',
properties: {
id: { description: 'Resource Id.', type: 'string', readOnly: true },
name: { description: 'Resource name.', type: 'string', readOnly: true },
type: { description: 'Resource type.', type: 'string', readOnly: true },
location: { description: 'Resource location.', type: 'string' },
tags: {
description: 'Resource tags.',
type: 'object',
additionalProperties: { type: 'string' }
},
properties: {
description: 'Cloud service properties',
type: 'object',
properties: {
packageUrl: {
description: 'Specifies a URL that refers to the location of the service package in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\r\n' +
'This is a write-only property and is not returned in GET calls.',
type: 'string'
},
configuration: {
description: 'Specifies the XML service configuration (.cscfg) for the cloud service.',
type: 'string'
},
configurationUrl: {
description: 'Specifies a URL that refers to the location of the service configuration in the Blob service. The service package URL can be Shared Access Signature (SAS) URI from any storage account.\r\n' +
'This is a write-only property and is not returned in GET calls.',
type: 'string'
},
startCloudService: {
description: '(Optional) Indicates whether to start the cloud service immediately after it is created. The default value is `true`.\r\n' +
'If false, the service model is still deployed, but the code is not run immediately. Instead, the service is PoweredOff until you call Start, at which time the service will be started. A deployed service still incurs charges, even if it is poweredoff.',
type: 'boolean'
},
allowModelOverride: {
description: '(Optional) Indicates whether the role sku properties (roleProfile.roles.sku) specified in the model/template should override the role instance count and vm size specified in the .cscfg and .csdef respectively.\r\n' +
'The default value is `false`.',
type: 'boolean'
},
upgradeMode: {
description: 'Update mode for the cloud service. Role instances are allocated to update domains when the service is deployed. Updates can be initiated manually in each update domain or initiated automatically in all update domains.\r\n' +
'Possible Values are <br /><br />**Auto**<br /><br />**Manual** <br /><br />**Simultaneous**<br /><br />\r\n' +
'If not specified, the default value is Auto. If set to Manual, PUT UpdateDomain must be called to apply the update. If set to Auto, the update is automatically applied to each update domain in sequence.',
enum: [ 'Auto', 'Manual', 'Simultaneous' ],
type: 'string',
'x-ms-enum': { name: 'CloudServiceUpgradeMode', modelAsString: true }
},
roleProfile: {
description: 'Describes the role profile for the cloud service.',
type: 'object',
properties: {
roles: {
description: 'List of roles for the cloud service.',
type: 'array',
items: {
description: 'Describes the role properties.',
type: 'object',
properties: {
name: { description: 'Resource name.', type: 'string' },
sku: {
description: 'Describes the cloud service role sku.',
type: 'object',
properties: {
name: {
description: 'The sku name. NOTE: If the new SKU is not supported on the hardware the cloud service is currently on, you need to delete and recreate the cloud service or move back to the old sku.',
type: 'string'
},
tier: {
description: 'Specifies the tier of the cloud service. Possible Values are <br /><br /> **Standard** <br /><br /> **Basic**',
type: 'string'
},
capacity: {
format: 'int64',
description: 'Specifies the number of role instances in the cloud service.',
type: 'integer'
}
}
}
}
},
'x-ms-identifiers': [ 'name' ]
}
}
},
osProfile: {
description: 'Describes the OS profile for the cloud service.',
type: 'object',
properties: {
secrets: {
description: 'Specifies set of certificates that should be installed onto the role instances.',
type: 'array',
items: {
description: 'Describes a set of certificates which are all in the same Key Vault.',
type: 'object',
properties: {
sourceVault: {
description: 'The relative URL of the Key Vault containing all of the certificates in VaultCertificates.',
properties: {
id: { type: 'string', description: 'Resource Id' }
},
'x-ms-azure-resource': true
},
vaultCertificates: {
description: 'The list of key vault references in SourceVault which contain certificates.',
type: 'array',
items: {
description: 'Describes a single certificate reference in a Key Vault, and where the certificate should reside on the role instance.',
type: 'object',
properties: {
certificateUrl: {
description: 'This is the URL of a certificate that has been uploaded to Key Vault as a secret.',
type: 'string'
}
}
},
'x-ms-identifiers': [ 'certificateUrl' ]
}
}
},
'x-ms-identifiers': [ 'sourceVault/id' ]
}
}
},
networkProfile: {
description: 'Network Profile for the cloud service.',
type: 'object',
properties: {
loadBalancerConfigurations: {
description: 'List of Load balancer configurations. Cloud service can have up to two load balancer configurations, corresponding to a Public Load Balancer and an Internal Load Balancer.',
type: 'array',
items: {
description: 'Describes the load balancer configuration.',
type: 'object',
properties: {
id: { description: 'Resource Id', type: 'string' },
name: {
description: 'The name of the Load balancer',
type: 'string'
},
properties: {
description: 'Properties of the load balancer configuration.',
type: 'object',
properties: {
frontendIPConfigurations: {
description: 'Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.',
type: 'array',
items: {
description: 'Specifies the frontend IP to be used for the load balancer. Only IPv4 frontend IP address is supported. Each load balancer configuration must have exactly one frontend IP configuration.',
type: 'object',
properties: {
name: {
description: 'The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource.',
type: 'string'
},
properties: {
description: 'Properties of load balancer frontend ip configuration.',
type: 'object',
properties: {
publicIPAddress: {
description: 'The reference to the public ip address resource.',
properties: {
id: {
type: 'string',
description: 'Resource Id'
}
},
'x-ms-azure-resource': true
},
subnet: {
description: 'The reference to the virtual network subnet resource.',
properties: {
id: {
type: 'string',
description: 'Resource Id'
}
},
'x-ms-azure-resource': true
},
privateIPAddress: {
description: 'The virtual network private IP address of the IP configuration.',
type: 'string'
}
}
}
},
required: [ 'name', 'properties' ]
},
'x-ms-identifiers': [ 'name' ]
}
},
required: [ 'frontendIPConfigurations' ]
}
},
required: [ 'name', 'properties' ]
}
},
slotType: {
description: 'Slot type for the cloud service.\r\n' +
'Possible values are <br /><br />**Production**<br /><br />**Staging**<br /><br />\r\n' +
'If not specified, the default value is Production.',
enum: [ 'Production', 'Staging' ],
type: 'string',
'x-ms-enum': { name: 'CloudServiceSlotType', modelAsString: true }
},
swappableCloudService: {
description: 'The id reference of the cloud service containing the target IP with which the subject cloud service can perform a swap. This property cannot be updated once it is set. The swappable cloud service referred by this id must be present otherwise an error will be thrown.',
properties: { id: { type: 'string', description: 'Resource Id' } },
'x-ms-azure-resource': true
}
}
},
extensionProfile: {
description: 'Describes a cloud service extension profile.',
type: 'object',
properties: {
extensions: {
description: 'List of extensions for the cloud service.',
type: 'array',
items: {
description: 'Describes a cloud service Extension.',
type: 'object',
properties: {
name: {
description: 'The name of the extension.',
type: 'string'
},
properties: {
description: 'Extension Properties.',
type: 'object',
properties: {
publisher: {
description: 'The name of the extension handler publisher.',
type: 'string'
},
type: {
description: 'Specifies the type of the extension.',
type: 'string'
},
typeHandlerVersion: {
description: 'Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.',
type: 'string'
},
autoUpgradeMinorVersion: {
description: 'Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.',
type: 'boolean'
},
settings: {
description: 'Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.',
type: 'object'
},
protectedSettings: {
description: 'Protected settings for the extension which are encrypted before sent to the role instance.',
type: 'object'
},
protectedSettingsFromKeyVault: {
type: 'object',
properties: {
sourceVault: {
description: 'The ARM Resource ID of the Key Vault',
properties: {
id: {
type: 'string',
description: 'Resource Id'
}
},
'x-ms-azure-resource': true
},
secretUrl: {
type: 'string',
description: 'Secret URL which contains the protected settings of the extension'
}
},
description: 'Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.'
},
forceUpdateTag: {
description: 'Tag to force apply the provided public and protected settings.\r\n' +
'Changing the tag value allows for re-running the extension without changing any of the public or protected settings.\r\n' +
'If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler.\r\n' +
'If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and\r\n' +
'it is up to handler implementation whether to re-run it or not',
type: 'string'
},
provisioningState: {
description: 'The provisioning state, which only appears in the response.',
type: 'string',
readOnly: true
},
rolesAppliedTo: {
description: "Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.",
type: 'array',
items: { type: 'string' }
}
}
}
}
},
'x-ms-identifiers': [ 'name' ]
}
}
},
provisioningState: {
description: 'The provisioning state, which only appears in the response.',
type: 'string',
readOnly: true
},
uniqueId: {
description: 'The unique identifier for the cloud service.',
type: 'string',
readOnly: true
}
}
},
systemData: {
description: 'The system meta data relating to this resource.',
type: 'object',
properties: {
createdAt: {
format: 'date-time',
description: 'Specifies the time in UTC at which the Cloud Service (extended support) resource was created. <br />Minimum api-version: 2022-04-04.',
type: 'string',
readOnly: true
},
lastModifiedAt: {
format: 'date-time',
description: 'Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. <br />Minimum api-version: 2022-04-04.',
type: 'string',
readOnly: true
}
}
}
},
'x-ms-azure-resource': true,
required: [ 'location' ]
}
Misc
The resource version is 2022-04-04.
The Swagger schema used to generate this documentation can be found here.