Partilhar via

CloudServiceProperties Class

  • Reference
Package:
com.azure.resourcemanager.compute.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-compute:2.46.0
  • java.lang.Object
    • com.azure.resourcemanager.compute.models.CloudServiceProperties

Implements

JsonSerializable<CloudServiceProperties>

public final class CloudServiceProperties
implements JsonSerializable<CloudServiceProperties>

Cloud service properties.

Constructor Summary

Constructor Description
CloudServiceProperties()

Creates an instance of CloudServiceProperties class.

Method Summary

Modifier and Type Method and Description
Boolean allowModelOverride()

Get the allowModelOverride property: (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.
String configuration()

Get the configuration property: Specifies the XML service configuration (.cscfg) for the cloud service.
String configurationUrl()

Get the configurationUrl property: Specifies a URL that refers to the location of the service configuration in the Blob service.
CloudServiceExtensionProfile extensionProfile()

Get the extensionProfile property: Describes a cloud service extension profile.
static CloudServiceProperties fromJson(JsonReader jsonReader)

Reads an instance of CloudServiceProperties from the JsonReader.
CloudServiceNetworkProfile networkProfile()

Get the networkProfile property: Network Profile for the cloud service.
CloudServiceOsProfile osProfile()

Get the osProfile property: Describes the OS profile for the cloud service.
String packageUrl()

Get the packageUrl property: Specifies a URL that refers to the location of the service package in the Blob service.
String provisioningState()

Get the provisioningState property: The provisioning state, which only appears in the response.
CloudServiceRoleProfile roleProfile()

Get the roleProfile property: Describes the role profile for the cloud service.
Boolean startCloudService()

Get the startCloudService property: (Optional) Indicates whether to start the cloud service immediately after it is created.
JsonWriter toJson(JsonWriter jsonWriter)
String uniqueId()

Get the uniqueId property: The unique identifier for the cloud service.
CloudServiceUpgradeMode upgradeMode()

Get the upgradeMode property: Update mode for the cloud service.
void validate()

Validates the instance.
CloudServiceProperties withAllowModelOverride(Boolean allowModelOverride)

Set the allowModelOverride property: (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.
CloudServiceProperties withConfiguration(String configuration)

Set the configuration property: Specifies the XML service configuration (.cscfg) for the cloud service.
CloudServiceProperties withConfigurationUrl(String configurationUrl)

Set the configurationUrl property: Specifies a URL that refers to the location of the service configuration in the Blob service.
CloudServiceProperties withExtensionProfile(CloudServiceExtensionProfile extensionProfile)

Set the extensionProfile property: Describes a cloud service extension profile.
CloudServiceProperties withNetworkProfile(CloudServiceNetworkProfile networkProfile)

Set the networkProfile property: Network Profile for the cloud service.
CloudServiceProperties withOsProfile(CloudServiceOsProfile osProfile)

Set the osProfile property: Describes the OS profile for the cloud service.
CloudServiceProperties withPackageUrl(String packageUrl)

Set the packageUrl property: Specifies a URL that refers to the location of the service package in the Blob service.
CloudServiceProperties withRoleProfile(CloudServiceRoleProfile roleProfile)

Set the roleProfile property: Describes the role profile for the cloud service.
CloudServiceProperties withStartCloudService(Boolean startCloudService)

Set the startCloudService property: (Optional) Indicates whether to start the cloud service immediately after it is created.
CloudServiceProperties withUpgradeMode(CloudServiceUpgradeMode upgradeMode)

Set the upgradeMode property: Update mode for the cloud service.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

CloudServiceProperties

public CloudServiceProperties()

Creates an instance of CloudServiceProperties class.

Method Details

allowModelOverride

public Boolean allowModelOverride()

Get the allowModelOverride property: (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`.

Returns:

the allowModelOverride value.

configuration

public String configuration()

Get the configuration property: Specifies the XML service configuration (.cscfg) for the cloud service.

Returns:

the configuration value.

configurationUrl

public String configurationUrl()

Get the configurationUrl property: 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.

Returns:

the configurationUrl value.

extensionProfile

public CloudServiceExtensionProfile extensionProfile()

Get the extensionProfile property: Describes a cloud service extension profile.

Returns:

the extensionProfile value.

fromJson

public static CloudServiceProperties fromJson(JsonReader jsonReader)

Reads an instance of CloudServiceProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of CloudServiceProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the CloudServiceProperties.

networkProfile

public CloudServiceNetworkProfile networkProfile()

Get the networkProfile property: Network Profile for the cloud service.

Returns:

the networkProfile value.

osProfile

public CloudServiceOsProfile osProfile()

Get the osProfile property: Describes the OS profile for the cloud service.

Returns:

the osProfile value.

packageUrl

public String packageUrl()

Get the packageUrl property: 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.

Returns:

the packageUrl value.

provisioningState

public String provisioningState()

Get the provisioningState property: The provisioning state, which only appears in the response.

Returns:

the provisioningState value.

roleProfile

public CloudServiceRoleProfile roleProfile()

Get the roleProfile property: Describes the role profile for the cloud service.

Returns:

the roleProfile value.

startCloudService

public Boolean startCloudService()

Get the startCloudService property: (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.

Returns:

the startCloudService value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

uniqueId

public String uniqueId()

Get the uniqueId property: The unique identifier for the cloud service.

Returns:

the uniqueId value.

upgradeMode

public CloudServiceUpgradeMode upgradeMode()

Get the upgradeMode property: 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.

Returns:

the upgradeMode value.

validate

public void validate()

Validates the instance.

withAllowModelOverride

public CloudServiceProperties withAllowModelOverride(Boolean allowModelOverride)

Set the allowModelOverride property: (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`.

Parameters:

allowModelOverride - the allowModelOverride value to set.

Returns:

the CloudServiceProperties object itself.

withConfiguration

public CloudServiceProperties withConfiguration(String configuration)

Set the configuration property: Specifies the XML service configuration (.cscfg) for the cloud service.

Parameters:

configuration - the configuration value to set.

Returns:

the CloudServiceProperties object itself.

withConfigurationUrl

public CloudServiceProperties withConfigurationUrl(String configurationUrl)

Set the configurationUrl property: 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.

Parameters:

configurationUrl - the configurationUrl value to set.

Returns:

the CloudServiceProperties object itself.

withExtensionProfile

public CloudServiceProperties withExtensionProfile(CloudServiceExtensionProfile extensionProfile)

Set the extensionProfile property: Describes a cloud service extension profile.

Parameters:

extensionProfile - the extensionProfile value to set.

Returns:

the CloudServiceProperties object itself.

withNetworkProfile

public CloudServiceProperties withNetworkProfile(CloudServiceNetworkProfile networkProfile)

Set the networkProfile property: Network Profile for the cloud service.

Parameters:

networkProfile - the networkProfile value to set.

Returns:

the CloudServiceProperties object itself.

withOsProfile

public CloudServiceProperties withOsProfile(CloudServiceOsProfile osProfile)

Set the osProfile property: Describes the OS profile for the cloud service.

Parameters:

osProfile - the osProfile value to set.

Returns:

the CloudServiceProperties object itself.

withPackageUrl

public CloudServiceProperties withPackageUrl(String packageUrl)

Set the packageUrl property: 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.

Parameters:

packageUrl - the packageUrl value to set.

Returns:

the CloudServiceProperties object itself.

withRoleProfile

public CloudServiceProperties withRoleProfile(CloudServiceRoleProfile roleProfile)

Set the roleProfile property: Describes the role profile for the cloud service.

Parameters:

roleProfile - the roleProfile value to set.

Returns:

the CloudServiceProperties object itself.

withStartCloudService

public CloudServiceProperties withStartCloudService(Boolean startCloudService)

Set the startCloudService property: (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.

Parameters:

startCloudService - the startCloudService value to set.

Returns:

the CloudServiceProperties object itself.

withUpgradeMode

public CloudServiceProperties withUpgradeMode(CloudServiceUpgradeMode upgradeMode)

Set the upgradeMode property: 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.

Parameters:

upgradeMode - the upgradeMode value to set.

Returns:

the CloudServiceProperties object itself.

Applies to