cloud_service_roles

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

Overview

Name	cloud_service_roles
Type	Resource
Id	azure.compute.cloud_service_roles

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	The cloud service role properties.
sku	object	Describes the cloud service role sku.
type	string	Resource type

list

Name	Datatype	Description
id	string	Resource id
name	string	Resource name
location	string	Resource location
properties	object	The cloud service role properties.
sku	object	Describes the cloud service role sku.
type	string	Resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	roleName, resourceGroupName, cloudServiceName, subscriptionId		Gets a role from a cloud service.
list	select	resourceGroupName, cloudServiceName, subscriptionId		Gets a list of all roles in a cloud service. Use nextLink property in the response to get the next page of roles. Do this till nextLink is null to fetch all the roles.

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.
roleName	string	Name of the role.
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets a role from a cloud service.

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

list

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

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