infra_role_instances

Creates, updates, deletes, gets or lists an infra_role_instances resource.

Overview

Name	infra_role_instances
Type	Resource
Id	azure_stack.fabric_admin.infra_role_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	All properties of an infrastructure role instance.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties	object	All properties of an infrastructure role instance.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, location, infraRoleInstance		Return the requested infrastructure role instance.
list	select	subscriptionId, resourceGroupName, location	$filter	Returns a list of all infrastructure role instances at a location.
power_off	exec	subscriptionId, resourceGroupName, location, infraRoleInstance		Power off an infrastructure role instance.
power_on	exec	subscriptionId, resourceGroupName, location, infraRoleInstance		Power on an infrastructure role instance.
shutdown	exec	subscriptionId, resourceGroupName, location, infraRoleInstance		Shut down an infrastructure role instance.
reboot	exec	subscriptionId, resourceGroupName, location, infraRoleInstance		Reboot an infrastructure 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
infraRoleInstance	string	Name of an infrastructure role instance.
location	string	The name of Azure region.
resourceGroupName	string	Name of the resource group.
subscriptionId	string	The ID of the target subscription.
$filter	string	OData filter parameter.

SELECT examples

get

Return the requested infrastructure role instance.

SELECT
id,
name,
properties,
type
FROM azure_stack.fabric_admin.infra_role_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND infraRoleInstance = '{{ infraRoleInstance }}' -- required
;

list

Returns a list of all infrastructure role instances at a location.

SELECT
id,
name,
properties,
type
FROM azure_stack.fabric_admin.infra_role_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND $filter = '{{ $filter }}'
;

Lifecycle Methods

power_off

Power off an infrastructure role instance.

EXEC azure_stack.fabric_admin.infra_role_instances.power_off 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@infraRoleInstance='{{ infraRoleInstance }}' --required
;

power_on

Power on an infrastructure role instance.

EXEC azure_stack.fabric_admin.infra_role_instances.power_on 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@infraRoleInstance='{{ infraRoleInstance }}' --required
;

shutdown

Shut down an infrastructure role instance.

EXEC azure_stack.fabric_admin.infra_role_instances.shutdown 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@infraRoleInstance='{{ infraRoleInstance }}' --required
;

reboot

Reboot an infrastructure role instance.

EXEC azure_stack.fabric_admin.infra_role_instances.reboot 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@infraRoleInstance='{{ infraRoleInstance }}' --required
;