Microsoft.Compute (stable:2024-11-04)

2025/06/25 • 5 updated methods

CloudServices_CreateOrUpdate (updated)
Description :  Create or update a cloud service. Please note some properties can be set only during cloud service creation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudServices_CreateOrUpdate",
  "$parameters": {
    "parameters": {
      "$properties": [
        {
          "#name": "systemData",
          "Description": {
            "new": "Metadata pertaining to creation and last modification of the resource.",
            "old": "The system meta data relating to this resource."
          },
          "$properties": [
            {
              "@added_005bdbbc62a04d409694783a0efde9f1": {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_4510b9b738974383aee8315ccca25102": {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "createdAt",
              "Description": {
                "new": "The timestamp of resource creation (UTC).",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was created. 
Minimum api-version: 2022-04-04."
              }
            },
            {
              "@added_941545ef03974761ac394f360cf98209": {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_207a0d064b524d549dd0c0d556f2af66": {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "lastModifiedAt",
              "Description": {
                "new": "The timestamp of resource last modification (UTC)",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. 
Minimum api-version: 2022-04-04."
              }
            }
          ]
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "systemData",
          "Description": {
            "new": "Metadata pertaining to creation and last modification of the resource.",
            "old": "The system meta data relating to this resource."
          },
          "$properties": [
            {
              "@added_42596c86e10546d7beb966b3939788c9": {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_f6b60dced4164060ba9b30c1e03b6e8c": {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "createdAt",
              "Description": {
                "new": "The timestamp of resource creation (UTC).",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was created. 
Minimum api-version: 2022-04-04."
              }
            },
            {
              "@added_d5a6984f2bf74c06a71e97a740841bf3": {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_3d857834453c49cf8eae8790d211bf00": {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "lastModifiedAt",
              "Description": {
                "new": "The timestamp of resource last modification (UTC)",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. 
Minimum api-version: 2022-04-04."
              }
            }
          ]
        }
      ]
    },
    "201": {
      "$properties": [
        {
          "#name": "systemData",
          "Description": {
            "new": "Metadata pertaining to creation and last modification of the resource.",
            "old": "The system meta data relating to this resource."
          },
          "$properties": [
            {
              "@added_8628ac1ffb294e8a9884cf698a5a5e9b": {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_84936b833b6c43ec901e650a5fd58c6a": {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "createdAt",
              "Description": {
                "new": "The timestamp of resource creation (UTC).",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was created. 
Minimum api-version: 2022-04-04."
              }
            },
            {
              "@added_b8dc19c44aa74d9e982d170d6b7b6f12": {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_5ed906df8db540c098319f208de47cb8": {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "lastModifiedAt",
              "Description": {
                "new": "The timestamp of resource last modification (UTC)",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. 
Minimum api-version: 2022-04-04."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cloud service object. ,
Required: False ,
}
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
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. 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. ,
Enum:
{
Auto: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
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. 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. ,
Enum:
{
Auto: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (201)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
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. 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. ,
Enum:
{
Auto: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
CloudServices_Update (updated)
Description :  Update a cloud service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudServices_Update",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "systemData",
          "Description": {
            "new": "Metadata pertaining to creation and last modification of the resource.",
            "old": "The system meta data relating to this resource."
          },
          "$properties": [
            {
              "@added_31dce8407a034ac88c37f5e233825d9d": {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_48be607873054b0ab9094cd143779845": {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "createdAt",
              "Description": {
                "new": "The timestamp of resource creation (UTC).",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was created. 
Minimum api-version: 2022-04-04."
              }
            },
            {
              "@added_498c8a5681cd467dbaf2c92b4c73ba63": {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_5da24a01e1394d1fa30e4c8372606872": {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "lastModifiedAt",
              "Description": {
                "new": "The timestamp of resource last modification (UTC)",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. 
Minimum api-version: 2022-04-04."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: The cloud service object. ,
Required: False ,
}
{
tags:
{
Description: Resource tags ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
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. 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. ,
Enum:
{
Auto: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
CloudServices_Get (updated)
Description :  Display information about a cloud service.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudServices_Get",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "systemData",
          "Description": {
            "new": "Metadata pertaining to creation and last modification of the resource.",
            "old": "The system meta data relating to this resource."
          },
          "$properties": [
            {
              "@added_874cac6b20334c5c951c794a9a7f5a82": {
                "#name": "createdBy",
                "Description": "The identity that created the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_8445e839b0a04a50b074bc946746a89a": {
                "#name": "createdByType",
                "Description": "The type of identity that created the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "createdAt",
              "Description": {
                "new": "The timestamp of resource creation (UTC).",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was created. 
Minimum api-version: 2022-04-04."
              }
            },
            {
              "@added_ea0bb70c9e1043fca75cb38ae92c9797": {
                "#name": "lastModifiedBy",
                "Description": "The identity that last modified the resource.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_5c425fb28a8e4f0b9a1f50cbd5387755": {
                "#name": "lastModifiedByType",
                "Description": "The type of identity that last modified the resource.",
                "Enum": [
                  [
                    "User",
                    ""
                  ],
                  [
                    "Application",
                    ""
                  ],
                  [
                    "ManagedIdentity",
                    ""
                  ],
                  [
                    "Key",
                    ""
                  ]
                ],
                "Required": false,
                "Type": "string"
              }
            },
            {
              "#name": "lastModifiedAt",
              "Description": {
                "new": "The timestamp of resource last modification (UTC)",
                "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. 
Minimum api-version: 2022-04-04."
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices/{cloudServiceName}
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
cloudServiceName:
{
Description: Name of the cloud service. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
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. 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. ,
Enum:
{
Auto: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
CloudServices_ListAll (updated)
Description :  Gets a list of all cloud services in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of Cloud Services. Do this till nextLink is null to fetch all the Cloud Services.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudServices_ListAll",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "systemData",
              "Description": {
                "new": "Metadata pertaining to creation and last modification of the resource.",
                "old": "The system meta data relating to this resource."
              },
              "$properties": [
                {
                  "@added_67beb59bf2a64035b143a410a121d85c": {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "@added_334a862f9faf4bba81a1b313e643cf16": {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "#name": "createdAt",
                  "Description": {
                    "new": "The timestamp of resource creation (UTC).",
                    "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was created. 
Minimum api-version: 2022-04-04."
                  }
                },
                {
                  "@added_3dfb8950e46f4602bcdfd20dc5d40201": {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "@added_e759eef575b44447aca7311c934e0e19": {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "#name": "lastModifiedAt",
                  "Description": {
                    "new": "The timestamp of resource last modification (UTC)",
                    "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. 
Minimum api-version: 2022-04-04."
                  }
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Compute/cloudServices
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: True ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
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. 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. ,
Enum:
{
Auto: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. ,
Required: False ,
}
string ,
}
CloudServices_List (updated)
Description :  Gets a list of all cloud services under a resource group. Use nextLink property in the response to get the next page of Cloud Services. Do this till nextLink is null to fetch all the Cloud Services.
Reference :  Link ¶

⚶ Changes

{
  "#id": "CloudServices_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": [
            {
              "#name": "systemData",
              "Description": {
                "new": "Metadata pertaining to creation and last modification of the resource.",
                "old": "The system meta data relating to this resource."
              },
              "$properties": [
                {
                  "@added_b8c2705f5d3847cdbe4af99dd6b27a78": {
                    "#name": "createdBy",
                    "Description": "The identity that created the resource.",
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "@added_67878619b0004872b3cdfb6cb2c8651e": {
                    "#name": "createdByType",
                    "Description": "The type of identity that created the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "#name": "createdAt",
                  "Description": {
                    "new": "The timestamp of resource creation (UTC).",
                    "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was created. 
Minimum api-version: 2022-04-04."
                  }
                },
                {
                  "@added_4a723f91437b4beb83b5d7f47702c4c9": {
                    "#name": "lastModifiedBy",
                    "Description": "The identity that last modified the resource.",
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "@added_fff39a27a4ec43cfa65b55bec78f50c4": {
                    "#name": "lastModifiedByType",
                    "Description": "The type of identity that last modified the resource.",
                    "Enum": [
                      [
                        "User",
                        ""
                      ],
                      [
                        "Application",
                        ""
                      ],
                      [
                        "ManagedIdentity",
                        ""
                      ],
                      [
                        "Key",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  }
                },
                {
                  "#name": "lastModifiedAt",
                  "Description": {
                    "new": "The timestamp of resource last modification (UTC)",
                    "old": "Specifies the time in UTC at which the Cloud Service (extended support) resource was last modified. 
Minimum api-version: 2022-04-04."
                  }
                }
              ]
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/cloudServices
{
resourceGroupName:
{
Description: Name of the resource group. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: Api error. ,
Required: False ,
}
{
details:
{
Description: The Api error details ,
Required: False ,
}
[
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
]
,
innererror:
{
Description: The Api inner error ,
Required: False ,
}
{
exceptiontype:
{
Description: The exception type. ,
Required: False ,
}
string ,
errordetail:
{
Description: The internal error message or exception dump. ,
Required: False ,
}
string ,
}
,
code:
{
Description: The error code. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: True ,
}
[
{
id:
{
Description: Resource Id. ,
Required: False ,
}
string ,
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
type:
{
Description: Resource type. ,
Required: False ,
}
string ,
location:
{
Description: Resource location. ,
Required: True ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
properties:
{
Description: Cloud service properties ,
Required: False ,
}
{
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
configuration:
{
Description: Specifies the XML service configuration (.cscfg) for the cloud service. ,
Required: False ,
}
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. This is a write-only property and is not returned in GET calls. ,
Required: False ,
}
string ,
startCloudService:
{
Description: (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. ,
Required: False ,
}
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. The default value is `false`. ,
Required: False ,
}
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. 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. ,
Enum:
{
Auto: No description available. ,
Manual: No description available. ,
Simultaneous: No description available. ,
}
,
Required: False ,
}
enum ,
roleProfile:
{
Description: Describes the role profile for the cloud service. ,
Required: False ,
}
{
roles:
{
Description: List of roles for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
sku:
{
Description: Describes the cloud service role sku. ,
Required: False ,
}
{
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. ,
Required: False ,
}
string ,
tier:
{
Description: Specifies the tier of the cloud service. Possible Values are

**Standard**

**Basic** ,
Required: False ,
}
string ,
capacity:
{
Description: Specifies the number of role instances in the cloud service. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
}
,
osProfile:
{
Description: Describes the OS profile for the cloud service. ,
Required: False ,
}
{
secrets:
{
Description: Specifies set of certificates that should be installed onto the role instances. ,
Required: False ,
}
[
{
sourceVault:
{
Description: The relative URL of the Key Vault containing all of the certificates in VaultCertificates. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
vaultCertificates:
{
Description: The list of key vault references in SourceVault which contain certificates. ,
Required: False ,
}
[
{
certificateUrl:
{
Description: This is the URL of a certificate that has been uploaded to Key Vault as a secret. ,
Required: False ,
}
string ,
isBootstrapCertificate:
{
Description: Flag indicating if the certificate provided is a bootstrap certificate to be used by the Key Vault Extension to fetch the remaining certificates. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
networkProfile:
{
Description: Network Profile for the cloud service. ,
Required: False ,
}
{
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. ,
Required: False ,
}
[
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
name:
{
Description: The name of the Load balancer ,
Required: True ,
}
string ,
properties:
{
Description: Properties of the load balancer configuration. ,
Required: True ,
}
{
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. ,
Required: True ,
}
[
{
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. ,
Required: True ,
}
string ,
properties:
{
Description: Properties of load balancer frontend ip configuration. ,
Required: True ,
}
{
publicIPAddress:
{
Description: The reference to the public ip address resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
subnet:
{
Description: The reference to the virtual network subnet resource. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
privateIPAddress:
{
Description: The virtual network private IP address of the IP configuration. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
slotType:
{
Description: Slot type for the cloud service. Possible values are

**Production**

**Staging**

If not specified, the default value is Production. ,
Enum:
{
Production: No description available. ,
Staging: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
}
,
extensionProfile:
{
Description: Describes a cloud service extension profile. ,
Required: False ,
}
{
extensions:
{
Description: List of extensions for the cloud service. ,
Required: False ,
}
[
{
name:
{
Description: The name of the extension. ,
Required: False ,
}
string ,
properties:
{
Description: Extension Properties. ,
Required: False ,
}
{
publisher:
{
Description: The name of the extension handler publisher. ,
Required: False ,
}
string ,
type:
{
Description: Specifies the type of the extension. ,
Required: False ,
}
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. ,
Required: False ,
}
string ,
autoUpgradeMinorVersion:
{
Description: Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available. ,
Required: False ,
}
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. ,
Required: False ,
}
object ,
protectedSettings:
{
Description: Protected settings for the extension which are encrypted before sent to the role instance. ,
Required: False ,
}
object ,
protectedSettingsFromKeyVault:
{
Description: Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance. ,
Required: False ,
}
{
sourceVault:
{
Description: The ARM Resource ID of the Key Vault ,
Required: False ,
}
{
id:
{
Description: Resource Id ,
Required: False ,
}
string ,
}
,
secretUrl:
{
Description: Secret URL which contains the protected settings of the extension ,
Required: False ,
}
string ,
}
,
forceUpdateTag:
{
Description: Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
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. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
provisioningState:
{
Description: The provisioning state, which only appears in the response. ,
Required: False ,
}
string ,
uniqueId:
{
Description: The unique identifier for the cloud service. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
zones:
{
Description: List of logical availability zone of the resource. List should contain only 1 zone where cloud service should be provisioned. This field is optional. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
nextLink:
{
Description: The URI to fetch the next page of resources. Use this to get the next page of resources. Do this till nextLink is null to fetch all the resources. ,
Required: False ,
}
string ,
}