ResourceExtensionReference [SPFSDK][VMROLE]

 

Applies To: Windows Azure Pack

A resource definition can only use resource extensions that it declares. The ResourceExtensionReference type holds a reference to a resource declaration. A resource extension reference defines a common name to identify the resource extension and values for any parameters that the resource extension declares.

Type Hierarchy

VirtualMachineRole (Instance) [SPFSDK][VMROLE].ResourceDefinition [SPFSDK][VMROLE].ResourceExtensionReference

Syntax

{       
    "ReferenceName" : "Name of extension reference",

    "Name" : "Name of imported resource extension",
    "Version" : "1.0.0.0",  
    "Publisher" : "Publisher Name",

    "ResourceExtensionParameterValues" : "{
            \"MyParameter1\" : \"Value1\",
            \"MyParameter2\" : \"Value2\"  
    }"
}

Properties

Name	Type	Required	Default value	Description
ReferenceName	String	Yes	None	The name of this resource extension reference that the resource definition uses.
Name	String	Yes	None	The name of the referenced resource extension.
Version	String	Yes	None	The version of referenced resource extension. The format of the version is: <major>.<minor>.<build>.<release>. For example, 6.33.2.10.
Publisher	String	Yes	None	The publisher name of the referenced resource extension.
ResourceExtensionParameterValues	String	No	null	A string of inline JSON name-value pairs that supply the values for the parameters, which the referenced resource extension defines. For more information about how to declare parameters, see ResourceConfiguration [SPFSDK][VMROLE].

Remarks

The following code example provides a sample ResourceExtensionReference object.

{ 
    "ReferenceName" : "MyExtensionReference",

    "Name" : "NameOfImportedResourceExtension",
    "Version" : "1.0.0.0",  
    "Publisher" : "Publisher Name"

    "ResourceExtensionParameterValues" : "{
            \"SQLInstance\" : \"[Param.MyParameter1]\"
    }"
}

See Also

ResourceDefinition [SPFSDK][VMROLE]
IntrinsicSettings [SPFSDK][VMROLE]
ResourceConfiguration [SPFSDK][VMROLE]