Overview

You can use the File Share component to represent and visualize file storage services from your Azure environment.

Toolbar

Use the toolbar to configure and customize the component. The following options are available:

• Color: Select accent and fill colors for the body of the component in 3D view.
• Tier: Select the storage tier for your file storage service.
• Redundancy: Select how your data is replicated in the primary and secondary regions.
• Data at-rest (GB): Enter the provisioned size of the file service.
• Snapshots (GB): Enter the total volume of data available for snapshots.
• Metadata at-rest (GB): Enter the total volume of data used for file system metadata.

API

Use the Cloudcraft API to programmatically access and render your architecture diagrams as JSON objects. The following is an example JSON object of a File share component:

Schema

{
	"type": "azurefiles",
	"id": "70cc1d82-30e1-4c62-bd29-634f72cd21cf",
	"region": "eastus",
	"mapPos": [2,6],
	"tier": "Standard",
	"redundancy": "LRS",
	"dataGb": 0,
	"snapshotsGb": 0,
	"metadataGb": 0,
	"color": {
		"isometric": null,
		"2d": null
	},
	"accentColor": {
		"isometric": null,
		"2d": null
	},
	"link": "https://azure.microsoft.com/products/storage/files/",
	"locked": true
}

• type: string: The type of component. Must be a string of value azurefiles for this component.
• id: string, uuid: The unique identifier for the component. The API uses a UUID v4 internally but accepts any unique string.
• resourceId: string: The globally unique identifier for the component within Azure.
• region: string: The Azure region for the component. The API supports all global regions, except China.
• mapPos: array: The position of the component in the blueprint. The API uses a unique X and Y coordinate pair to express positioning.
• tier: string: The storage tier for the storage service. Accepts one of four values, Premium, Hot, Cool, and Standard. Defaults to Standard.
• redundancy: string: The redundancy option for how data is replicated across regions. Accepts one of four values, LRS, ZRS, GRS, and GZRS. Defaults to LRS.
• dataGb: number: The provisioned size of the file service in gigabytes. Defaults to 0.
• snapshotGb: number: The total volume of data available for snapshots in gigabytes. Defaults to 0.
• metadataGb: number: The total volume of data used for file system metadata in gigabytes. Defaults to 0.
• color: object: The fill color for the component body.
  • isometric: string: A hexadecimal color for the component body in 3D view. Defaults to #CEE0F5.
  • 2d: string: A hexadecimal color for the component body in 2D view. Defaults to null.
• accentColor: object: The accent color for the component logo.
  • isometric: string: A hexadecimal color for the component logo in 3D view. Defaults to #0078D4.
  • 2d: string: A hexadecimal color for the component logo in 2D view. Defaults to null.
• link: string, uri: A URI that links the component to another diagram or an external website. Accepts one of two formats, blueprint:// or https://.
• locked: boolean: Whether to allow changes to the position of the component through the web interface. Defaults to false.