CloudServiceProperties interface

Package:

@azure/arm-compute

Cloud service properties

Properties

allowModelOverride	(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. The default value is false.
configuration	Specifies the XML service configuration (.cscfg) for the cloud service.
configurationUrl	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. This is a write-only property and is not returned in GET calls.
extensionProfile	Describes a cloud service extension profile.
networkProfile	Network Profile for the cloud service.
osProfile	Describes the OS profile for the cloud service.
packageUrl	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. This is a write-only property and is not returned in GET calls.
provisioningState	The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
roleProfile	Describes the role profile for the cloud service.
startCloudService	(Optional) Indicates whether to start the cloud service immediately after it is created. The default value is true. 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.
uniqueId	The unique identifier for the cloud service. NOTE: This property will not be serialized. It can only be populated by the server.
upgradeMode	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. Possible Values are Auto Manual Simultaneous 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.

Property Details

allowModelOverride

(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. The default value is false.

allowModelOverride?: boolean

Property Value

boolean

configuration

Specifies the XML service configuration (.cscfg) for the cloud service.

configuration?: string

Property Value

string

configurationUrl

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. This is a write-only property and is not returned in GET calls.

configurationUrl?: string

Property Value

string

extensionProfile

Describes a cloud service extension profile.

extensionProfile?: CloudServiceExtensionProfile

Property Value

CloudServiceExtensionProfile

networkProfile

Network Profile for the cloud service.

networkProfile?: CloudServiceNetworkProfile

Property Value

CloudServiceNetworkProfile

osProfile

Describes the OS profile for the cloud service.

osProfile?: CloudServiceOsProfile

Property Value

CloudServiceOsProfile

packageUrl

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. This is a write-only property and is not returned in GET calls.

packageUrl?: string

Property Value

string

provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

roleProfile

Describes the role profile for the cloud service.

roleProfile?: CloudServiceRoleProfile

Property Value

CloudServiceRoleProfile

startCloudService

(Optional) Indicates whether to start the cloud service immediately after it is created. The default value is true. 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.

startCloudService?: boolean

Property Value

boolean

uniqueId

The unique identifier for the cloud service. NOTE: This property will not be serialized. It can only be populated by the server.

uniqueId?: string

Property Value

string

upgradeMode

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. Possible Values are

Auto

Manual

Simultaneous

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.

upgradeMode?: string

Property Value

string