cloud_service_role_instances

Creates, updates, deletes, gets or lists a cloud_service_role_instances resource.

Overview

Name	cloud_service_role_instances
Type	Resource
Id	azure.compute.cloud_service_role_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name.
location	string	Resource Location.
properties	object	Role instance properties.
sku	object	The role instance SKU.
tags	object	Resource tags.
type	string	Resource Type.

get_instance_view

Name	Datatype	Description
platformFaultDomain	integer (int32)	The Fault Domain.
platformUpdateDomain	integer (int32)	The Update Domain.
privateId	string	Specifies a unique identifier generated internally for the cloud service associated with this role instance. NOTE: If you are using Azure Diagnostics extension, this property can be used as 'DeploymentId' for querying details.
statuses	array

list

Name	Datatype	Description
id	string	Resource Id
name	string	Resource Name.
location	string	Resource Location.
properties	object	Role instance properties.
sku	object	The role instance SKU.
tags	object	Resource tags.
type	string	Resource Type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	roleInstanceName, resourceGroupName, cloudServiceName, subscriptionId	$expand	Gets a role instance from a cloud service.
get_instance_view	select	roleInstanceName, resourceGroupName, cloudServiceName, subscriptionId		Retrieves information about the run-time state of a role instance in a cloud service.
list	select	resourceGroupName, cloudServiceName, subscriptionId	$expand	Gets the list of all role instances in a cloud service. Use nextLink property in the response to get the next page of role instances. Do this till nextLink is null to fetch all the role instances.
delete	delete	roleInstanceName, resourceGroupName, cloudServiceName, subscriptionId		Deletes a role instance from a cloud service.
restart	exec	roleInstanceName, resourceGroupName, cloudServiceName, subscriptionId		The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.
reimage	exec	roleInstanceName, resourceGroupName, cloudServiceName, subscriptionId		The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.
rebuild	exec	roleInstanceName, resourceGroupName, cloudServiceName, subscriptionId		The Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
cloudServiceName	string	Name of the cloud service.
resourceGroupName	string	Name of the resource group.
roleInstanceName	string	Name of the role instance.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
$expand	string	The expand expression to apply to the operation. 'UserData' is not supported for cloud services.

SELECT examples

get

Gets a role instance from a cloud service.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.compute.cloud_service_role_instances
WHERE roleInstanceName = '{{ roleInstanceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND cloudServiceName = '{{ cloudServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

get_instance_view

Retrieves information about the run-time state of a role instance in a cloud service.

SELECT
platformFaultDomain,
platformUpdateDomain,
privateId,
statuses
FROM azure.compute.cloud_service_role_instances
WHERE roleInstanceName = '{{ roleInstanceName }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND cloudServiceName = '{{ cloudServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Gets the list of all role instances in a cloud service. Use nextLink property in the response to get the next page of role instances. Do this till nextLink is null to fetch all the role instances.

SELECT
id,
name,
location,
properties,
sku,
tags,
type
FROM azure.compute.cloud_service_role_instances
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND cloudServiceName = '{{ cloudServiceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND $expand = '{{ $expand }}'
;

DELETE examples

delete

Deletes a role instance from a cloud service.

DELETE FROM azure.compute.cloud_service_role_instances
WHERE roleInstanceName = '{{ roleInstanceName }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND cloudServiceName = '{{ cloudServiceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

restart

The Reboot Role Instance asynchronous operation requests a reboot of a role instance in the cloud service.

EXEC azure.compute.cloud_service_role_instances.restart 
@roleInstanceName='{{ roleInstanceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudServiceName='{{ cloudServiceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

reimage

The Reimage Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles.

EXEC azure.compute.cloud_service_role_instances.reimage 
@roleInstanceName='{{ roleInstanceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudServiceName='{{ cloudServiceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;

rebuild

The Rebuild Role Instance asynchronous operation reinstalls the operating system on instances of web roles or worker roles and initializes the storage resources that are used by them. If you do not want to initialize storage resources, you can use Reimage Role Instance.

EXEC azure.compute.cloud_service_role_instances.rebuild 
@roleInstanceName='{{ roleInstanceName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@cloudServiceName='{{ cloudServiceName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required
;