infra_roles

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

Overview

Name	infra_roles
Type	Resource
Id	azure_stack.fabric_admin.infra_roles

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	Infrastructure role properties.
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	Infrastructure role properties.
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, infraRole		Returns the requested infrastructure role description.
list	select	subscriptionId, resourceGroupName, location	$filter	Returns a list of all infrastructure roles at a location.
restart	exec	subscriptionId, resourceGroupName, location, infraRole		Restarts the requested infrastructure role.

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
infraRole	string	Infrastructure role name.
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

Returns the requested infrastructure role description.

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

list

Returns a list of all infrastructure roles at a location.

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

Lifecycle Methods

restart

Restarts the requested infrastructure role.

EXEC azure_stack.fabric_admin.infra_roles.restart 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required, 
@infraRole='{{ infraRole }}' --required
;