diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json new file mode 100644 index 000000000000..15b028fb28f5 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json @@ -0,0 +1,1145 @@ +{ + "swagger": "2.0", + "info": { + "description": "Azure Managed Lustre provides a fully managed LustreĀ® file system, integrated with Blob storage, for use on demand. These operations create and manage Azure Managed Lustre file systems.", + "title": "Managed Lustre client", + "version": "2023-05-01" + }, + "host": "management.azure.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/amlFilesystems": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of AML file systems. Note that entity references might replace complete file system objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference", + "schema": { + "$ref": "#/definitions/AmlFilesystemsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "amlFilesystems_List": { + "$ref": "./examples/amlFilesystems_List.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Returns all AML file systems the user has access to under a subscription.", + "operationId": "amlFilesystems_List" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of AmlFilesystem objects. Note that entity references might replace complete AmlFilesystem objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference", + "schema": { + "$ref": "#/definitions/AmlFilesystemsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_ListByResourceGroup": { + "$ref": "./examples/amlFilesystems_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "amlFilesystems" + ], + "description": "Returns all AML file systems the user has access to under a resource group.", + "operationId": "amlFilesystems_ListByResourceGroup" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}": { + "delete": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "AML file system deleted." + }, + "202": { + "description": "Started the AML file system's transition to Deleted state. Poll the AML file system to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "AML file system deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_Delete": { + "$ref": "./examples/amlFilesystems_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "tags": [ + "amlFilesystems" + ], + "description": "Schedules an AML file system for deletion.", + "operationId": "amlFilesystems_Delete" + }, + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the AML file system object corresponding to amlFilesystemName.", + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_Get": { + "$ref": "./examples/amlFilesystems_Get.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Returns an AML file system.", + "operationId": "amlFilesystems_Get" + }, + "put": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "description": "Object containing the user-selectable properties of the AML file system. If read-only properties are included, they must match the existing values of those properties.", + "in": "body", + "name": "amlFilesystem", + "required": true, + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + } + ], + "responses": { + "200": { + "description": "The AML file system has been created or updated.", + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + }, + "201": { + "description": "AML file system creation has been initiated. Poll the AML file system's provisioningState property to monitor creation progress.", + "headers": { + "azure-async-operation": { + "description": "URI to poll for the operation status", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_CreateOrUpdate": { + "$ref": "./examples/amlFilesystems_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "amlFilesystems" + ], + "description": "Create or update an AML file system.", + "operationId": "amlFilesystems_CreateOrUpdate" + }, + "patch": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "description": "Object containing the user-selectable properties of the AML file system. If read-only properties are included, they must match the existing values of those properties.", + "in": "body", + "name": "amlFilesystem", + "required": true, + "schema": { + "$ref": "#/definitions/AmlFilesystemUpdate" + } + } + ], + "responses": { + "200": { + "description": "Updated the AML file system.", + "schema": { + "$ref": "#/definitions/AmlFilesystem" + } + }, + "202": { + "description": "AML file system update has been initiated. Poll the AML file system's provisioningState property to monitor update progress.", + "headers": { + "Location": { + "description": "URI to poll for the operation status", + "type": "string" + }, + "azure-async-operation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_Update": { + "$ref": "./examples/amlFilesystems_Update.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "amlFilesystems" + ], + "description": "Update an AML file system instance.", + "operationId": "amlFilesystems_Update" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/archive": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + }, + { + "name": "archiveInfo", + "in": "body", + "description": "Information about the archive operation", + "schema": { + "$ref": "#/definitions/AmlFilesystemArchiveInfo" + } + } + ], + "responses": { + "200": { + "description": "AML file system has started the archive operation. Poll the AML file system's hsm.archiveStatus field to monitor the progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_Archive": { + "$ref": "./examples/amlFilesystems_Archive.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Archive data from the AML file system.", + "operationId": "amlFilesystems_Archive" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/amlFilesystems/{amlFilesystemName}/cancelArchive": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/AmlFilesystemNameParameter" + } + ], + "responses": { + "200": { + "description": "AML file system has started the cancellation of the archive operation. Poll the AML file system's hsm.archiveStatus field to monitor the progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "amlFilesystems_cancelArchive": { + "$ref": "./examples/amlFilesystems_CancelArchive.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Cancel archiving data from the AML file system.", + "operationId": "amlFilesystems_CancelArchive" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/checkAmlFSSubnets": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "amlFilesystemSubnetInfo", + "in": "body", + "description": "Information about the subnets to validate.", + "schema": { + "$ref": "#/definitions/AmlFilesystemSubnetInfo" + } + } + ], + "responses": { + "200": { + "description": "The subnets provided meet the requirements for AML file system create." + }, + "400": { + "description": "The subnets provided do not meet the requirements for AML file system create.", + "schema": { + "$ref": "#/definitions/AmlFilesystemCheckSubnetError" + }, + "x-ms-error-response": true + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "checkAmlFSSubnets": { + "$ref": "./examples/checkAmlFSSubnets.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Check that subnets will be valid for AML file system create calls.", + "operationId": "checkAmlFSSubnets" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/getRequiredAmlFSSubnetsSize": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "requiredAMLFilesystemSubnetsSizeInfo", + "in": "body", + "description": "Information to determine the number of available IPs a subnet will need to host the AML file system.", + "schema": { + "$ref": "#/definitions/RequiredAmlFilesystemSubnetsSizeInfo" + } + } + ], + "responses": { + "200": { + "description": "The number of available IP addresses a subnet will need for an AML file system.", + "schema": { + "$ref": "#/definitions/RequiredAmlFilesystemSubnetsSize" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "storagecache.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "getRequiredAmlFilesystemSubnetsSize": { + "$ref": "./examples/getRequiredAmlFSSubnetsSize.json" + } + }, + "tags": [ + "amlFilesystems" + ], + "description": "Get the number of available IP addresses needed for the AML file system information provided.", + "operationId": "getRequiredAmlFSSubnetsSize" + } + } + }, + "definitions": { + "AmlFilesystemIdentity": { + "type": "object", + "description": "Managed Identity properties.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID for the user-assigned identity of the resource." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID associated with the resource." + }, + "type": { + "type": "string", + "description": "The type of identity used for the resource.", + "enum": [ + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "AmlFilesystemIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "description": "A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary.", + "$ref": "#/definitions/UserAssignedIdentities" + } + } + }, + "AmlFilesystem": { + "description": "An AML file system instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md", + "x-ms-azure-resource": true, + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/AmlFilesystemIdentity", + "description": "The managed identity used by the AML file system, if configured." + }, + "sku": { + "description": "SKU for the resource.", + "$ref": "#/definitions/SkuName" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability zones for resources. This field should only contain a single element in the array.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the AML file system.", + "properties": { + "storageCapacityTiB": { + "description": "The size of the AML file system, in TiB. This might be rounded up.", + "x-ms-mutability": [ + "read", + "create" + ], + "type": "number", + "format": "float" + }, + "health": { + "description": "Health of the AML file system.", + "readOnly": true, + "$ref": "#/definitions/AmlFilesystemHealth" + }, + "provisioningState": { + "description": "ARM provisioning state.", + "enum": [ + "Succeeded", + "Failed", + "Creating", + "Deleting", + "Updating", + "Canceled" + ], + "x-ms-enum": { + "name": "AmlFilesystemProvisioningStateType", + "modelAsString": true + }, + "type": "string", + "readOnly": true + }, + "filesystemSubnet": { + "description": "Subnet used for managing the AML file system and for client-facing operations. This subnet should have at least a /24 subnet mask within the VNET's address space.", + "x-ms-mutability": [ + "read", + "create" + ], + "$ref": "storagecache.json#/definitions/URLString" + }, + "clientInfo": { + "$ref": "#/definitions/AmlFilesystemClientInfo", + "description": "Client information for the AML file system." + }, + "throughputProvisionedMBps": { + "type": "integer", + "format": "int32", + "description": "Throughput provisioned in MB per sec, calculated as storageCapacityTiB * per-unit storage throughput", + "readOnly": true + }, + "encryptionSettings": { + "$ref": "#/definitions/AmlFilesystemEncryptionSettings", + "description": "Specifies encryption settings of the AML file system." + }, + "maintenanceWindow": { + "description": "Start time of a 30-minute weekly maintenance window.", + "type": "object", + "properties": { + "dayOfWeek": { + "type": "string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "MaintenanceDayOfWeekType", + "modelAsString": false + }, + "description": "Day of the week on which the maintenance window will occur." + }, + "timeOfDayUTC": { + "type": "string", + "pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$", + "description": "The time of day (in UTC) to start the maintenance window." + } + } + }, + "hsm": { + "type": "object", + "description": "Hydration and archive settings and status", + "properties": { + "settings": { + "$ref": "#/definitions/AmlFilesystemHsmSettings", + "description": "Specifies HSM settings of the AML file system." + }, + "archiveStatus": { + "type": "array", + "readOnly": true, + "description": "Archive status", + "items": { + "$ref": "#/definitions/AmlFilesystemArchive" + }, + "x-ms-identifiers": [ + "filesystemPath" + ] + } + } + } + }, + "type": "object", + "required": [ + "filesystemSubnet", + "storageCapacityTiB", + "maintenanceWindow" + ] + } + } + }, + "AmlFilesystemUpdate": { + "description": "An AML file system update instance.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "Properties of the AML file system.", + "properties": { + "encryptionSettings": { + "$ref": "#/definitions/AmlFilesystemEncryptionSettings", + "description": "Specifies encryption settings of the AML file system." + }, + "maintenanceWindow": { + "description": "Start time of a 30-minute weekly maintenance window.", + "type": "object", + "properties": { + "dayOfWeek": { + "type": "string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "MaintenanceDayOfWeekType", + "modelAsString": false + }, + "description": "Day of the week on which the maintenance window will occur." + }, + "timeOfDayUTC": { + "type": "string", + "pattern": "^([0-9]|0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]$", + "description": "The time of day (in UTC) to start the maintenance window." + } + } + } + } + } + } + }, + "AmlFilesystemName": { + "readOnly": true, + "description": "Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.", + "type": "string", + "pattern": "^[0-9a-zA-Z][-0-9a-zA-Z_]{0,78}[0-9a-zA-Z]$", + "minLength": 2, + "maxLength": 80 + }, + "AmlFilesystemsListResult": { + "description": "Result of the request to list AML file systems. It contains a list of AML file systems and a URL link to get the next set of results.", + "properties": { + "nextLink": { + "description": "URL to get the next set of AML file system list results, if there are any.", + "type": "string" + }, + "value": { + "description": "List of AML file systems.", + "items": { + "$ref": "#/definitions/AmlFilesystem" + }, + "type": "array" + } + }, + "type": "object" + }, + "AmlFilesystemHealth": { + "description": "An indication of AML file system health. Gives more information about health than just that related to provisioning.", + "readOnly": true, + "properties": { + "state": { + "description": "List of AML file system health states.", + "enum": [ + "Unavailable", + "Available", + "Degraded", + "Transitioning", + "Maintenance" + ], + "x-ms-enum": { + "name": "AmlFilesystemHealthStateType", + "modelAsString": true + }, + "type": "string" + }, + "statusCode": { + "description": "Server-defined error code for the AML file system health", + "type": "string" + }, + "statusDescription": { + "description": "Describes the health state.", + "type": "string" + } + }, + "type": "object" + }, + "AmlFilesystemEncryptionSettings": { + "description": "AML file system encryption settings.", + "properties": { + "keyEncryptionKey": { + "$ref": "storagecache.json#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the encryption key in Key Vault." + } + }, + "type": "object" + }, + "AmlFilesystemHsmSettings": { + "description": "AML file system HSM settings.", + "x-ms-mutability": [ + "read", + "create" + ], + "type": "object", + "properties": { + "container": { + "description": "Resource ID of storage container used for hydrating the namespace and archiving from the namespace. The resource provider must have permission to create SAS tokens on the storage account.", + "$ref": "storagecache.json#/definitions/URLString" + }, + "loggingContainer": { + "description": "Resource ID of storage container used for logging events and errors. Must be a separate container in the same storage account as the hydration and archive container. The resource provider must have permission to create SAS tokens on the storage account.", + "$ref": "storagecache.json#/definitions/URLString" + }, + "importPrefix": { + "description": "Only blobs in the non-logging container that start with this path/prefix get hydrated into the cluster namespace.", + "type": "string", + "default": "/" + } + }, + "required": [ + "container", + "loggingContainer" + ] + }, + "AmlFilesystemClientInfo": { + "type": "object", + "description": "AML file system client information", + "readOnly": true, + "properties": { + "mgsAddress": { + "description": "The IPv4 address used by clients to mount the AML file system's Lustre Management Service (MGS).", + "readOnly": true, + "type": "string" + }, + "mountCommand": { + "description": "Recommended command to mount the AML file system", + "readOnly": true, + "type": "string" + }, + "lustreVersion": { + "type": "string", + "description": "The version of Lustre running in the AML file system", + "readOnly": true + }, + "containerStorageInterface": { + "$ref": "#/definitions/AmlFilesystemContainerStorageInterface", + "description": "Container Storage Interface information for the AML file system." + } + } + }, + "AmlFilesystemContainerStorageInterface": { + "type": "object", + "description": "AML file system container storage interface information", + "readOnly": true, + "properties": { + "persistentVolumeClaim": { + "description": "Recommended AKS Persistent Volume Claim for the CSI driver, in Base64 encoded YAML", + "readOnly": true, + "type": "string" + }, + "persistentVolume": { + "description": "Recommended AKS Persistent Volume for the CSI driver, in Base64 encoded YAML", + "readOnly": true, + "type": "string" + }, + "storageClass": { + "description": "Recommended AKS Storage Class for the CSI driver, in Base64 encoded YAML", + "readOnly": true, + "type": "string" + } + } + }, + "AmlFilesystemArchiveInfo": { + "type": "object", + "description": "Information required to execute the archive operation", + "properties": { + "filesystemPath": { + "type": "string", + "description": "Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data.", + "default": "/" + } + } + }, + "AmlFilesystemArchive": { + "description": "Information about the AML file system archive", + "type": "object", + "readOnly": true, + "properties": { + "filesystemPath": { + "readOnly": true, + "type": "string", + "description": "Lustre file system path to archive relative to the file system root. Specify '/' to archive all modified data." + }, + "status": { + "description": "The status of the archive", + "type": "object", + "readOnly": true, + "properties": { + "state": { + "readOnly": true, + "description": "The state of the archive operation", + "type": "string", + "enum": [ + "NotConfigured", + "Idle", + "InProgress", + "Canceled", + "Completed", + "Failed", + "Cancelling", + "FSScanInProgress" + ], + "x-ms-enum": { + "name": "ArchiveStatusType", + "modelAsString": true + } + }, + "lastCompletionTime": { + "readOnly": true, + "description": "The time of the last completed archive operation", + "type": "string", + "format": "date-time" + }, + "lastStartedTime": { + "readOnly": true, + "description": "The time the latest archive operation started", + "type": "string", + "format": "date-time" + }, + "percentComplete": { + "readOnly": true, + "description": "The completion percentage of the archive operation", + "type": "integer", + "format": "int32" + }, + "errorCode": { + "readOnly": true, + "description": "Server-defined error code for the archive operation", + "type": "string" + }, + "errorMessage": { + "readOnly": true, + "description": "Server-defined error message for the archive operation", + "type": "string" + } + } + } + } + }, + "RequiredAmlFilesystemSubnetsSizeInfo": { + "type": "object", + "description": "Information required to get the number of available IP addresses a subnet should have that will be used in AML file system create", + "properties": { + "storageCapacityTiB": { + "description": "The size of the AML file system, in TiB.", + "type": "number", + "format": "float" + }, + "sku": { + "description": "SKU for the resource.", + "$ref": "#/definitions/SkuName" + } + } + }, + "RequiredAmlFilesystemSubnetsSize": { + "type": "object", + "description": "Information about the number of available IP addresses that are required for the AML file system.", + "properties": { + "filesystemSubnetSize": { + "description": "The number of available IP addresses that are required for the AML file system.", + "type": "integer", + "format": "int32" + } + } + }, + "AmlFilesystemSubnetInfo": { + "type": "object", + "description": "Information required to validate the subnet that will be used in AML file system create", + "properties": { + "filesystemSubnet": { + "description": "Subnet used for managing the AML file system and for client-facing operations. This subnet should have at least a /24 subnet mask within the VNET's address space.", + "$ref": "storagecache.json#/definitions/URLString" + }, + "storageCapacityTiB": { + "description": "The size of the AML file system, in TiB.", + "type": "number", + "format": "float" + }, + "sku": { + "description": "SKU for the resource.", + "$ref": "#/definitions/SkuName" + }, + "location": { + "description": "Region that the AML file system will be created in.", + "type": "string", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "AmlFilesystemCheckSubnetError": { + "type": "object", + "description": "The error details provided when the checkAmlFSSubnets call fails.", + "readOnly": true, + "properties": { + "filesystemSubnet": { + "type": "object", + "description": "The error details for the AML file system's subnet.", + "properties": { + "status": { + "type": "string", + "enum": [ + "Ok", + "Invalid" + ], + "x-ms-enum": { + "name": "FilesystemSubnetStatusType", + "modelAsString": true + }, + "description": "The status of the AML file system subnet check." + }, + "message": { + "type": "string", + "description": "The details of the AML file system subnet check." + } + } + } + } + }, + "UserAssignedIdentities": { + "type": "object", + "description": "A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary.", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "userAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the user-assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client ID of the user-assigned identity." + } + } + } + }, + "SkuName": { + "x-ms-mutability": [ + "read", + "create" + ], + "description": "SKU for the resource.", + "properties": { + "name": { + "description": "SKU name for this resource.", + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": { + "AmlFilesystemNameParameter": { + "description": "Name for the AML file system. Allows alphanumerics, underscores, and hyphens. Start and end with alphanumeric.", + "in": "path", + "name": "amlFilesystemName", + "pattern": "^[0-9a-zA-Z][-0-9a-zA-Z_]{0,78}[0-9a-zA-Z]$", + "required": true, + "type": "string", + "minLength": 2, + "maxLength": 80, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/AscOperations_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/AscOperations_Get.json new file mode 100644 index 000000000000..f83392034837 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/AscOperations_Get.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "westus", + "operationId": "testoperationid", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/ascOperations/testoperationid", + "name": "testoperationid", + "startTime": "2023-01-01T13:13:13.933Z", + "endTime": "2023-01-01T16:13:13.933Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/AscResourceUsages_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/AscResourceUsages_Get.json new file mode 100644 index 000000000000..485e554d9faf --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/AscResourceUsages_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "limit": 4, + "unit": "Count", + "currentValue": 1, + "name": { + "value": "Cache", + "localizedValue": "Cache" + } + }, + { + "limit": 4, + "unit": "Count", + "currentValue": 0, + "name": { + "value": "AmlFilesystem", + "localizedValue": "AmlFilesystem" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_CreateOrUpdate.json new file mode 100644 index 000000000000..539a04f123b7 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_CreateOrUpdate.json @@ -0,0 +1,324 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cache": { + "tags": { + "Dept": "Contoso" + }, + "location": "westus", + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "cacheSizeGB": 3072, + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2047/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "cacheNetBiosName": "contosoSmb", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "credentials": { + "username": "consotoAdmin", + "password": "" + } + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "credentials": { + "bindDn": "cn=ldapadmin,dc=contosoad,dc=contoso,dc=local", + "bindPassword": "" + } + } + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + } + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "responses": { + "202": {}, + "201": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "5.3.23", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "5.3.24" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "No" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "No" + } + }, + "primingJobs": [], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_CreateOrUpdate_ldap_only.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_CreateOrUpdate_ldap_only.json new file mode 100644 index 000000000000..b4860aa31025 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_CreateOrUpdate_ldap_only.json @@ -0,0 +1,291 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cache": { + "tags": { + "Dept": "Contoso" + }, + "location": "westus", + "properties": { + "cacheSizeGB": 3072, + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "credentials": { + "bindDn": "cn=ldapadmin,dc=contosoad,dc=contoso,dc=local", + "bindPassword": "" + } + } + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + } + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "responses": { + "202": {}, + "201": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "5.3.23", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "5.3.24" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "No" + } + }, + "primingJobs": [], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_DebugInfo.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_DebugInfo.json new file mode 100644 index 000000000000..9d20d6e9f67e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_DebugInfo.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Delete.json new file mode 100644 index 000000000000..9d20d6e9f67e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Flush.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Flush.json new file mode 100644 index 000000000000..9d20d6e9f67e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Flush.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Get.json new file mode 100644 index 000000000000..67073af73440 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Get.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_List.json new file mode 100644 index 000000000000..870ac78d0348 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_List.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [], + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ] + }, + "sku": { + "name": "Standard_2G" + } + }, + { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2", + "location": "westus", + "name": "sc2", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "AD", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "", + "ldapBaseDN": "", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_ListByResourceGroup.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_ListByResourceGroup.json new file mode 100644 index 000000000000..7ba7d95beaf9 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_ListByResourceGroup.json @@ -0,0 +1,267 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Succeeded", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [], + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ], + "zones": [ + "1" + ] + }, + "sku": { + "name": "Standard_2G" + } + }, + { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2", + "location": "westus", + "name": "sc2", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "AD", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "", + "ldapBaseDN": "", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [], + "zones": [ + "2" + ] + }, + "sku": { + "name": "Standard_2G" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Start.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Start.json new file mode 100644 index 000000000000..9d20d6e9f67e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Start.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Stop.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Stop.json new file mode 100644 index 000000000000..9d20d6e9f67e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Stop.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Update.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Update.json new file mode 100644 index 000000000000..15e2d9cc52b3 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Update.json @@ -0,0 +1,263 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cache": { + "tags": { + "Dept": "Contoso" + }, + "location": "westus", + "properties": { + "cacheSizeGB": 3072, + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + }, + { + "name": "restrictive", + "accessRules": [ + { + "scope": "host", + "filter": "10.99.3.145", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "network", + "filter": "10.99.1.0/24", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "default", + "access": "no", + "suid": false, + "submountAccess": true, + "rootSquash": true, + "anonymousUID": "65534", + "anonymousGID": "65534" + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "cacheNetBiosName": "contosoSmb", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "AD" + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + }, + { + "name": "restrictive", + "accessRules": [ + { + "scope": "host", + "filter": "10.99.3.145", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "network", + "filter": "10.99.1.0/24", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "default", + "access": "no", + "suid": false, + "submountAccess": true, + "rootSquash": true, + "anonymousUID": "65534", + "anonymousGID": "65534" + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "directoryServicesSettings": { + "activeDirectory": { + "primaryDnsIpAddress": "192.0.2.10", + "secondaryDnsIpAddress": "192.0.2.11", + "domainName": "contosoAd.contoso.local", + "domainNetBiosName": "contosoAd", + "cacheNetBiosName": "contosoSmb", + "domainJoined": "Yes" + }, + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "AD", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "", + "ldapBaseDN": "", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "Yes" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Update_ldap_only.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Update_ldap_only.json new file mode 100644 index 000000000000..d55f80f10ac0 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_Update_ldap_only.json @@ -0,0 +1,241 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cache": { + "tags": { + "Dept": "Contoso" + }, + "location": "westus", + "properties": { + "cacheSizeGB": 3072, + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + }, + { + "name": "restrictive", + "accessRules": [ + { + "scope": "host", + "filter": "10.99.3.145", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "network", + "filter": "10.99.1.0/24", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "default", + "access": "no", + "suid": false, + "submountAccess": true, + "rootSquash": true, + "anonymousUID": "65534", + "anonymousGID": "65534" + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "credentials": { + "bindDn": "cn=ldapadmin,dc=contosoad,dc=contoso,dc=local", + "bindPassword": "" + } + } + } + }, + "sku": { + "name": "Standard_2G" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "200": { + "body": { + "tags": { + "Dept": "Contoso" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", + "location": "westus", + "name": "sc1", + "type": "Microsoft.StorageCache/Cache", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "cacheSizeGB": 3072, + "health": { + "state": "Transitioning", + "statusDescription": "Cache is being created.", + "conditions": [ + { + "timestamp": "2021-04-21T18:25:43.511Z", + "message": "Cannot contact DNS server" + } + ] + }, + "mountAddresses": [ + "192.168.1.1", + "192.168.1.2" + ], + "provisioningState": "Updating", + "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", + "upgradeStatus": { + "currentFirmwareVersion": "2022.08.1", + "firmwareUpdateStatus": "available", + "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", + "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", + "pendingFirmwareVersion": "2022.08.1" + }, + "networkSettings": { + "mtu": 1500, + "dnsServers": [ + "10.1.22.33", + "10.1.12.33" + ], + "dnsSearchDomain": "contoso.com", + "ntpServer": "time.contoso.com" + }, + "securitySettings": { + "accessPolicies": [ + { + "name": "default", + "accessRules": [ + { + "scope": "default", + "access": "rw", + "suid": false, + "submountAccess": true, + "rootSquash": false + } + ] + }, + { + "name": "restrictive", + "accessRules": [ + { + "scope": "host", + "filter": "10.99.3.145", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "network", + "filter": "10.99.1.0/24", + "access": "rw", + "suid": true, + "submountAccess": true, + "rootSquash": false + }, + { + "scope": "default", + "access": "no", + "suid": false, + "submountAccess": true, + "rootSquash": true, + "anonymousUID": "65534", + "anonymousGID": "65534" + } + ] + } + ] + }, + "upgradeSettings": { + "upgradeScheduleEnabled": true, + "scheduledTime": "2022-04-26T18:25:43.511Z" + }, + "directoryServicesSettings": { + "usernameDownload": { + "extendedGroups": true, + "usernameSource": "LDAP", + "groupFileURI": "http://contoso.net/group.file", + "userFileURI": "http://contoso.net/passwd.file", + "ldapServer": "192.0.2.12", + "ldapBaseDN": "dc=contosoad,dc=contoso,dc=local", + "encryptLdapConnection": false, + "requireValidCertificate": false, + "autoDownloadCertificate": false, + "caCertificateURI": "http://contoso.net/cacert.pem", + "usernameDownloaded": "No" + } + }, + "primingJobs": [ + { + "primingJobName": "contosoJob1", + "primingJobId": "00000000000_0000000000", + "primingJobState": "Complete", + "primingJobStatus": "success", + "primingJobDetails": "Files: Cached=635, Failed=0, Excluded=80, Data=346030 bytes, Directories: Cached=1003, Failed=0, Excluded=0", + "primingJobPercentComplete": 100.0 + }, + { + "primingJobName": "contosoJob2", + "primingJobId": "11111111111_1111111111", + "primingJobState": "Queued", + "primingJobStatus": "", + "primingJobDetails": "", + "primingJobPercentComplete": 0.0 + } + ], + "spaceAllocation": [] + }, + "sku": { + "name": "Standard_2G" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_UpgradeFirmware.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_UpgradeFirmware.json new file mode 100644 index 000000000000..334c3accc28d --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Caches_UpgradeFirmware.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "201": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Operations_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Operations_List.json new file mode 100644 index 000000000000..03eaf5e1a2ff --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Operations_List.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-05-01", + "x-ms-client-request-id": [ + "7e655b68-e491-4cb6-90c3-6a5b10b7bd17" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.StorageCache/caches/write", + "display": { + "operation": "Create or Update Cache", + "provider": "Azure Storage Cache", + "resource": "Caches" + } + }, + { + "name": "Microsoft.StorageCache/caches/delete", + "display": { + "operation": "Delete Cache", + "provider": "Azure Storage Cache", + "resource": "Caches" + } + }, + { + "origin": "system", + "name": "Microsoft.StorageCache/caches/providers/Microsoft.Insights/metricDefinitions/read", + "isDataAction": false, + "display": { + "operation": "Get Cache Metric Definitions", + "provider": "Microsoft Azure HPC Cache", + "resource": "StorageCache Metric Definitions", + "description": "Reads Cache Metric Definitions." + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "ClientIOPS", + "displayName": "Total Client IOPS", + "displayDescription": "The rate of client file operations processed by the Cache.", + "unit": "Count", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricClass": "Transactions" + }, + { + "name": "ClientLatency", + "displayName": "Average Client Latency", + "displayDescription": "Average latency of client file operations to the Cache.", + "unit": "Milliseconds", + "aggregationType": "Average", + "supportedAggregationTypes": [ + "Minimum", + "Maximum", + "Average" + ], + "metricClass": "Latency" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/PausePrimingJob.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/PausePrimingJob.json new file mode 100644 index 000000000000..62b29844f711 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/PausePrimingJob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "primingJobId": { + "primingJobId": "00000000000_0000000000" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/44444444-4444-4444-4444-444444444444?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/44444444-4444-4444-4444-444444444444?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/ResumePrimingJob.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/ResumePrimingJob.json new file mode 100644 index 000000000000..66bb66f21ab9 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/ResumePrimingJob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "primingJobId": { + "primingJobId": "00000000000_0000000000" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/55555555-5555-5555-5555-555555555555?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/55555555-5555-5555-5555-555555555555?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Skus_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Skus_List.json new file mode 100644 index 000000000000..07e0f1d1ed7c --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/Skus_List.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "caches", + "name": "Standard_2G", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [] + } + ], + "capabilities": [ + { + "name": "throughput GB/s", + "value": "2" + }, + { + "name": "cache sizes(GB)", + "value": "3072,6144,12288" + } + ], + "restrictions": [] + }, + { + "resourceType": "caches", + "name": "Standard_4G", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [] + } + ], + "capabilities": [ + { + "name": "throughput GB/s", + "value": "4" + }, + { + "name": "cache sizes(GB)", + "value": "6144,12288,24576" + } + ], + "restrictions": [] + }, + { + "resourceType": "caches", + "name": "Standard_8G", + "locations": [ + "eastus" + ], + "locationInfo": [ + { + "location": "eastus", + "zones": [] + } + ], + "capabilities": [ + { + "name": "throughput GB/s", + "value": "8" + }, + { + "name": "cache sizes(GB)", + "value": "12288,24576,49152" + } + ], + "restrictions": [] + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/SpaceAllocation_Post.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/SpaceAllocation_Post.json new file mode 100644 index 000000000000..f850ba5a691d --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/SpaceAllocation_Post.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "spaceAllocation": [ + { + "name": "st1", + "allocationPercentage": 25 + }, + { + "name": "st2", + "allocationPercentage": 50 + }, + { + "name": "st3", + "allocationPercentage": 25 + } + ] + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/11111111-1111-1111-1111-111111111111?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/11111111-1111-1111-1111-111111111111?api-version=2023-05-01" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StartPrimingJob.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StartPrimingJob.json new file mode 100644 index 000000000000..9502fd61e054 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StartPrimingJob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "primingjob": { + "primingJobName": "contosoJob", + "primingManifestUrl": "https://contosostorage.blob.core.windows.net/contosoblob/00000000_00000000000000000000000000000000.00000000000.FFFFFFFF.00000000?sp=r&st=2021-08-11T19:33:35Z&se=2021-08-12T03:33:35Z&spr=https&sv=2020-08-04&sr=b&sig=" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/22222222-2222-2222-2222-222222222222?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/22222222-2222-2222-2222-222222222222?api-version=2023-05-01" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StopPrimingJob.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StopPrimingJob.json new file mode 100644 index 000000000000..9a37205ea2c1 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StopPrimingJob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "primingJobId": { + "primingJobId": "00000000000_0000000000" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/33333333-3333-3333-3333-333333333333?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/ascOperations/33333333-3333-3333-3333-333333333333?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_CreateOrUpdate.json new file mode 100644 index 000000000000..53c19f8b2527 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_CreateOrUpdate.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "storageTargetName": "st1", + "storagetarget": { + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "rootSquash" + } + ], + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "rootSquash" + } + ], + "state": "Ready", + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "201": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "rootSquash" + } + ], + "state": "Ready", + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_CreateOrUpdate_BlobNfs.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_CreateOrUpdate_BlobNfs.json new file mode 100644 index 000000000000..6370563f44d4 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_CreateOrUpdate_BlobNfs.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "storageTargetName": "st1", + "storagetarget": { + "properties": { + "targetType": "blobNfs", + "junctions": [ + { + "namespacePath": "/blobnfs" + } + ], + "blobNfs": { + "target": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/blofnfs/blobServices/default/containers/blobnfs", + "usageModel": "READ_WRITE", + "verificationTimer": 28800, + "writeBackTimer": 3600 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "targetType": "blobNfs", + "junctions": [ + { + "namespacePath": "/blobnfs" + } + ], + "state": "Ready", + "blobNfs": { + "target": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/blofnfs/blobServices/default/containers/blobnfs", + "usageModel": "READ_WRITE", + "verificationTimer": 28800, + "writeBackTimer": 3600 + } + } + } + }, + "201": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "targetType": "blobNfs", + "junctions": [ + { + "namespacePath": "/blobnfs" + } + ], + "state": "Ready", + "blobNfs": { + "target": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/blofnfs/blobServices/default/containers/blobnfs", + "usageModel": "READ_WRITE", + "verificationTimer": 28800, + "writeBackTimer": 3600 + } + } + } + }, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_CreateOrUpdate_NoJunctions.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_CreateOrUpdate_NoJunctions.json new file mode 100644 index 000000000000..635f186d08a2 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_CreateOrUpdate_NoJunctions.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "storageTargetName": "st1", + "storagetarget": { + "properties": { + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "targetType": "nfs3", + "state": "Ready", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "201": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "targetType": "nfs3", + "state": "Ready", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY", + "verificationTimer": 30 + } + } + } + }, + "202": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Delete.json new file mode 100644 index 000000000000..5059d899cb09 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_DnsRefresh.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_DnsRefresh.json new file mode 100644 index 000000000000..df78cfb9fcb3 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_DnsRefresh.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Flush.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Flush.json new file mode 100644 index 000000000000..897acfd8dc62 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Flush.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Get.json new file mode 100644 index 000000000000..ca70040ad5e3 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Get.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1", + "storageTargetName": "st1" + }, + "responses": { + "200": { + "body": { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "default" + } + ], + "state": "Ready", + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_HEAVY_FREQ" + }, + "allocationPercentage": 25 + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Invalidate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Invalidate.json new file mode 100644 index 000000000000..897acfd8dc62 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Invalidate.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_ListByCache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_ListByCache.json new file mode 100644 index 000000000000..2eeb8c7835a3 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_ListByCache.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "cacheName": "sc1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "st1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st1", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/path/on/cache", + "targetPath": "/path/on/exp1", + "nfsExport": "exp1", + "nfsAccessPolicy": "default" + }, + { + "namespacePath": "/path2/on/cache", + "targetPath": "/path2/on/exp2", + "nfsExport": "exp2", + "nfsAccessPolicy": "default" + } + ], + "state": "Ready", + "targetType": "nfs3", + "nfs3": { + "target": "10.0.44.44", + "usageModel": "READ_ONLY" + }, + "allocationPercentage": 25 + } + }, + { + "name": "st2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st2", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/some/arbitrary/place/on/cache", + "targetPath": "/", + "nfsAccessPolicy": "default" + } + ], + "state": "Ready", + "targetType": "clfs", + "clfs": { + "target": "https://contoso123.blob.core.windows.net/contoso123" + }, + "allocationPercentage": 50 + } + }, + { + "name": "st3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1/storagetargets/st3", + "type": "Microsoft.StorageCache/Cache/StorageTarget", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" + }, + "properties": { + "junctions": [ + { + "namespacePath": "/some/crazier/place/on/cache", + "targetPath": "/", + "nfsExport": "", + "nfsAccessPolicy": "default" + } + ], + "state": "Ready", + "targetType": "unknown", + "unknown": { + "attributes": { + "foo": "bar", + "foo2": "test" + } + }, + "allocationPercentage": 25 + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_RestoreDefaults.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_RestoreDefaults.json new file mode 100644 index 000000000000..df78cfb9fcb3 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_RestoreDefaults.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Resume.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Resume.json new file mode 100644 index 000000000000..897acfd8dc62 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Resume.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Suspend.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Suspend.json new file mode 100644 index 000000000000..897acfd8dc62 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/StorageTargets_Suspend.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "cacheName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "storageTargetName": "st1" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/UsageModels_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/UsageModels_List.json new file mode 100644 index 000000000000..5a1fa5356fa2 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/UsageModels_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "modelName": "READ_ONLY", + "targetType": "nfs3", + "display": { + "description": "Read only, with a default verification timer of 30 seconds. Verification timer has a minimum value of 1 and maximum value of 31536000. Write-back timer must have value of 0 or be null." + } + }, + { + "modelName": "READ_WRITE", + "targetType": "nfs3", + "display": { + "description": "Read-write, with a default verification timer of 8 hours and default write-back timer of 1 hour. Verification timer and write-back timer have a minimum value of 1 and maximum value of 31536000." + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Archive.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Archive.json new file mode 100644 index 000000000000..e8074c639d57 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Archive.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "archiveInfo": { + "filesystemPath": "/" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_CancelArchive.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_CancelArchive.json new file mode 100644 index 000000000000..1e3f59275cd9 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_CancelArchive.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "sc", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_CreateOrUpdate.json new file mode 100644 index 000000000000..af384a89531a --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_CreateOrUpdate.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "fs1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "amlFilesystem": { + "tags": { + "Dept": "ContosoAds" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "eastus", + "zones": [ + "1" + ], + "properties": { + "storageCapacityTiB": 16, + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + } + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + }, + "responses": { + "201": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-05-01" + }, + "body": { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + } + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + }, + "200": { + "body": { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Delete.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Delete.json new file mode 100644 index 000000000000..c016045786f5 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "fs1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/westus/azureAsyncOperation/e276a03a-1770-4549-86f5-0edffae8997c?api-version=2023-05-01" + } + }, + "204": {} + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Get.json new file mode 100644 index 000000000000..633859d860e5 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Get.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "fs1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://keyvault-cmk.vault.azure.net/keys/key2048/test", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_List.json new file mode 100644 index 000000000000..91b044a6fb8f --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_List.json @@ -0,0 +1,154 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub1", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + }, + { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs2", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs2", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub2", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_ListByResourceGroup.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_ListByResourceGroup.json new file mode 100644 index 000000000000..04272383b6f9 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_ListByResourceGroup.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub1", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + }, + { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs2", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs2", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub2", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + ] + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Update.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Update.json new file mode 100644 index 000000000000..65b084ce54e9 --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/amlFilesystems_Update.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "amlFilesystemName": "fs1", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "amlFilesystem": { + "tags": { + "Dept": "ContosoAds" + }, + "properties": { + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?monitor=true&api-version=2023-05-01", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.StorageCache/locations/eastus/ascOperations/00000000-0000-0000-0000-000000000000?api-version=2023-05-01" + } + }, + "200": { + "body": { + "tags": { + "Dept": "ContosoAds" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/amlFilesystems/fs1", + "location": "eastus", + "zones": [ + "1" + ], + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "name": "fs1", + "type": "Microsoft.StorageCache/amlFilesystem", + "properties": { + "storageCapacityTiB": 16, + "throughputProvisionedMBps": 500, + "health": { + "state": "Available", + "statusDescription": "amlFilesystem is ok." + }, + "provisioningState": "Succeeded", + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "clientInfo": { + "mgsAddress": "10.0.0.4", + "mountCommand": "mount -t lustre 10.0.0.4@tcp:/lustrefs /lustre/lustrefs", + "lustreVersion": "2.15.0", + "containerStorageInterface": { + "persistentVolumeClaim": "", + "persistentVolume": "", + "storageClass": "" + } + }, + "maintenanceWindow": { + "dayOfWeek": "Friday", + "timeOfDayUTC": "22:00" + }, + "encryptionSettings": { + "keyEncryptionKey": { + "keyUrl": "https://examplekv.vault.azure.net/keys/kvk/3540a47df75541378d3518c6a4bdf5af", + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.KeyVault/vaults/keyvault-cmk" + } + } + }, + "hsm": { + "settings": { + "container": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/containername", + "loggingContainer": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/blobServices/default/containers/loggingcontainername", + "importPrefix": "/" + }, + "archiveStatus": [ + { + "filesystemPath": "/", + "status": { + "state": "Completed", + "lastCompletionTime": "2019-04-21T18:25:43.511Z", + "lastStartedTime": "2019-04-21T17:25:43.511Z" + } + } + ] + } + }, + "sku": { + "name": "AMLFS-Durable-Premium-250" + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/checkAmlFSSubnets.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/checkAmlFSSubnets.json new file mode 100644 index 000000000000..11b9dd2e40bd --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/checkAmlFSSubnets.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "amlFilesystemSubnetInfo": { + "filesystemSubnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/fsSub", + "storageCapacityTiB": 16, + "sku": { + "name": "AMLFS-Durable-Premium-125" + } + } + }, + "responses": { + "200": {}, + "400": { + "body": { + "filesystemSubnet": { + "status": "Invalid", + "message": "A subnet with a minimum size of /24 is required." + } + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/getRequiredAmlFSSubnetsSize.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/getRequiredAmlFSSubnetsSize.json new file mode 100644 index 000000000000..ce0e2e60bd5f --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/examples/getRequiredAmlFSSubnetsSize.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceGroupName": "scgroup", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-05-01", + "amlFilesystemSubnetInfo": { + "storageCapacityTiB": 16, + "sku": { + "name": "AMLFS-Durable-Premium-125" + } + } + }, + "responses": { + "200": { + "body": { + "filesystemSubnetSize": 24 + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/storagecache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/storagecache.json new file mode 100644 index 000000000000..ba2dccfdf1bb --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2023-05-01/storagecache.json @@ -0,0 +1,3495 @@ +{ + "swagger": "2.0", + "info": { + "description": "A Storage Cache provides scalable caching service for NAS clients, serving data from either NFSv3 or Blob at-rest storage (referred to as \"Storage Targets\"). These operations allow you to manage Caches.", + "title": "Storage Cache Mgmt Client", + "version": "2023-05-01" + }, + "host": "management.azure.com", + "basePath": "/", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.StorageCache/operations": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of available Resource Provider operations.", + "schema": { + "$ref": "#/definitions/ApiOperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "tags": [ + "Operations" + ], + "description": "Lists all of the available Resource Provider operations.", + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + }, + "operationId": "Operations_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/skus": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of SKU descriptors.", + "schema": { + "$ref": "#/definitions/ResourceSkusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Skus_List": { + "$ref": "./examples/Skus_List.json" + } + }, + "tags": [ + "SKUs" + ], + "description": "Get the list of StorageCache.Cache SKUs available to this subscription.", + "operationId": "Skus_List" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/usageModels": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of UsageModel descriptors.", + "schema": { + "$ref": "#/definitions/UsageModelsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "UsageModels_List": { + "$ref": "./examples/UsageModels_List.json" + } + }, + "tags": [ + "UsageModels" + ], + "description": "Get the list of cache usage models available to this subscription.", + "operationId": "UsageModels_List" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/ascOperations/{operationId}": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/LocationParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "The asynchronous operation was returned.", + "schema": { + "$ref": "#/definitions/AscOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AscOperations_Get": { + "$ref": "./examples/AscOperations_Get.json" + } + }, + "tags": [ + "AscOperations" + ], + "description": "Gets the status of an asynchronous operation for the Azure HPC Cache", + "operationId": "AscOperations_Get" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/usages": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the region to query for usage information." + } + ], + "responses": { + "200": { + "description": "The usage information was returned.", + "schema": { + "$ref": "#/definitions/ResourceUsagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AscUsages_List": { + "$ref": "./examples/AscResourceUsages_Get.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "AscUsages" + ], + "description": "Gets the quantity used and quota limit for resources", + "operationId": "AscUsages_List" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of cache objects. Note that entity references might replace complete cache objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference", + "schema": { + "$ref": "#/definitions/CachesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Caches_List": { + "$ref": "./examples/Caches_List.json" + } + }, + "tags": [ + "Caches" + ], + "description": "Returns all caches the user has access to under a subscription.", + "operationId": "Caches_List" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A list of cache objects. Note that entity references might replace complete cache objects, as described in http://docs.oasis-open.org/odata/odata-json-format/v4.01/cs01/odata-json-format-v4.01-cs01.html#sec_EntityReference", + "schema": { + "$ref": "#/definitions/CachesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_ListByResourceGroup": { + "$ref": "./examples/Caches_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "Caches" + ], + "description": "Returns all caches the user has access to under a resource group.", + "operationId": "Caches_ListByResourceGroup" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}": { + "delete": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Cache deleted." + }, + "202": { + "description": "Started the cache's transition to Deleted state. Poll the cache to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Cache deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Delete": { + "$ref": "./examples/Caches_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "tags": [ + "Caches" + ], + "description": "Schedules a cache for deletion.", + "operationId": "Caches_Delete" + }, + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Returns the cache object corresponding to cache name.", + "schema": { + "$ref": "#/definitions/Cache" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Get": { + "$ref": "./examples/Caches_Get.json" + } + }, + "tags": [ + "Caches" + ], + "description": "Returns a cache.", + "operationId": "Caches_Get" + }, + "put": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "description": "Object containing the user-selectable properties of the new cache. If read-only properties are included, they must match the existing values of those properties.", + "in": "body", + "name": "cache", + "required": true, + "schema": { + "$ref": "#/definitions/Cache" + } + } + ], + "responses": { + "200": { + "description": "Cache created or updated.", + "schema": { + "$ref": "#/definitions/Cache" + } + }, + "201": { + "description": "Cache creation or update has been initiated. Poll the cache's provisioningState property to monitor creation/update progress.", + "schema": { + "$ref": "#/definitions/Cache" + } + }, + "202": { + "description": "Cache creation or update has been initiated. Poll the cache's provisioningState property to monitor creation/update progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_CreateOrUpdate": { + "$ref": "./examples/Caches_CreateOrUpdate.json" + }, + "Caches_CreateOrUpdate_ldap_only": { + "$ref": "./examples/Caches_CreateOrUpdate_ldap_only.json" + } + }, + "x-ms-long-running-operation": true, + "tags": [ + "Caches" + ], + "description": "Create or update a cache.", + "operationId": "Caches_CreateOrUpdate" + }, + "patch": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "description": "Object containing the user-selectable properties of the cache. If read-only properties are included, they must match the existing values of those properties.", + "in": "body", + "name": "cache", + "schema": { + "$ref": "#/definitions/Cache" + } + } + ], + "responses": { + "200": { + "description": "Updated the cache.", + "schema": { + "$ref": "#/definitions/Cache" + } + }, + "202": { + "description": "Cache update has been initiated. Poll the cache's provisioningState property to monitor update progress.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Update": { + "$ref": "./examples/Caches_Update.json" + }, + "Caches_Update_ldap_only": { + "$ref": "./examples/Caches_Update_ldap_only.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Update a cache instance.", + "operationId": "Caches_Update" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/dnsRefresh": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Cache has refreshed the storage target's DNS information." + }, + "202": { + "description": "Cache has started refreshing storage target DNS information.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_DnsRefresh": { + "$ref": "./examples/StorageTargets_DnsRefresh.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Tells a storage target to refresh its DNS information.", + "operationId": "StorageTargets_DnsRefresh" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/debugInfo": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Cache has started generating debug info." + }, + "202": { + "description": "Cache has started generating debug info.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Cache has started generating debug info." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_DebugInfo": { + "$ref": "./examples/Caches_DebugInfo.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Tells a cache to write generate debug info for support to process.", + "operationId": "Caches_DebugInfo" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/flush": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "All cached data has been flushed to the Storage Target(s)." + }, + "202": { + "description": "Cache has started flushing to its Storage Target(s). Poll the cache's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Cache flush already in progress or has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Flush": { + "$ref": "./examples/Caches_Flush.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Tells a cache to write all dirty data to the Storage Target(s). During the flush, clients will see errors returned until the flush is complete.", + "operationId": "Caches_Flush" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/start": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Cache is Active." + }, + "202": { + "description": "Cache has started the transition to Active. Poll the cache's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Restarted VMs associated with the cache." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Start": { + "$ref": "./examples/Caches_Start.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Tells a Stopped state cache to transition to Active state.", + "operationId": "Caches_Start" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stop": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Cache is stopped." + }, + "202": { + "description": "Cache has started the transition to Stopped. Poll the cache's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Stopped VMs associated with the cache." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_Stop": { + "$ref": "./examples/Caches_Stop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Tells an Active cache to transition to Stopped state.", + "operationId": "Caches_Stop" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Returns the list of Storage Targets defined by cache name.", + "schema": { + "$ref": "#/definitions/StorageTargetsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_List": { + "$ref": "./examples/StorageTargets_ListByCache.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "StorageTargets" + ], + "description": "Returns a list of Storage Targets for the specified cache.", + "operationId": "StorageTargets_ListByCache" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}": { + "delete": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + }, + { + "name": "force", + "in": "query", + "required": false, + "type": "string", + "description": "Boolean value requesting the force delete operation for a storage target. Force delete discards unwritten-data in the cache instead of flushing it to back-end storage." + } + ], + "responses": { + "200": { + "description": "Storage Target deleted." + }, + "202": { + "description": "Started the Storage Target's deletion. Poll the cache's Storage Targets to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Storage Target deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Delete": { + "$ref": "./examples/StorageTargets_Delete.json" + } + }, + "x-ms-long-running-operation": true, + "tags": [ + "StorageTargets" + ], + "description": "Removes a Storage Target from a cache. This operation is allowed at any time, but if the cache is down or unhealthy, the actual removal of the Storage Target may be delayed until the cache is healthy again. Note that if the cache has data to flush to the Storage Target, the data will be flushed before the Storage Target will be deleted.", + "operationId": "StorageTargets_Delete" + }, + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Returns the Storage Target object corresponding to storageTargetName.", + "schema": { + "$ref": "#/definitions/StorageTarget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Get": { + "$ref": "./examples/StorageTargets_Get.json" + } + }, + "tags": [ + "StorageTargets" + ], + "description": "Returns a Storage Target from a cache.", + "operationId": "StorageTargets_Get" + }, + "put": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + }, + { + "description": "Object containing the definition of a Storage Target.", + "in": "body", + "name": "storagetarget", + "required": true, + "schema": { + "$ref": "#/definitions/StorageTarget" + } + } + ], + "responses": { + "200": { + "description": "Storage Target has been created or updated.", + "schema": { + "$ref": "#/definitions/StorageTarget" + } + }, + "201": { + "description": "Storage Target creation or update has been initiated. Poll the Storage Target's provisioningState property to monitor creation/update progress.", + "schema": { + "$ref": "#/definitions/StorageTarget" + } + }, + "202": { + "description": "Storage Target creation or update has been initiated. Poll the Storage Target's provisioningState property to monitor creation/update progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_CreateOrUpdate": { + "$ref": "./examples/StorageTargets_CreateOrUpdate.json" + }, + "StorageTargets_CreateOrUpdate_NoJunctions": { + "$ref": "./examples/StorageTargets_CreateOrUpdate_NoJunctions.json" + }, + "StorageTargets_CreateOrUpdate_BlobNfs": { + "$ref": "./examples/StorageTargets_CreateOrUpdate_BlobNfs.json" + } + }, + "x-ms-long-running-operation": true, + "tags": [ + "StorageTargets" + ], + "description": "Create or update a Storage Target. This operation is allowed at any time, but if the cache is down or unhealthy, the actual creation/modification of the Storage Target may be delayed until the cache is healthy again.", + "operationId": "StorageTargets_CreateOrUpdate" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/flush": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "All data has been flushed to the storage target." + }, + "202": { + "description": "Cache has started flushing to the storage target. Poll the storage target's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Flush already in progress or has completed." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Flush": { + "$ref": "./examples/StorageTargets_Flush.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Tells the cache to write all dirty data to the Storage Target's backend storage. Client requests to this storage target's namespace will return errors until the flush operation completes.", + "operationId": "StorageTarget_Flush" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/suspend": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Client access to the storage target has been suspended." + }, + "202": { + "description": "Storage target suspend has started. Poll the storage target's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The storage target is already suspended or suspend is in progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Suspend": { + "$ref": "./examples/StorageTargets_Suspend.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Suspends client access to a storage target.", + "operationId": "StorageTarget_Suspend" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/resume": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Client access to the storage target has been resumed." + }, + "202": { + "description": "Storage target resume has started. Poll the storage target's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The storage target has already resumed or resume is in progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Resume": { + "$ref": "./examples/StorageTargets_Resume.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Resumes client access to a previously suspended storage target.", + "operationId": "StorageTarget_Resume" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/invalidate": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "All cached data for the storage target was invalidated" + }, + "202": { + "description": "Storage target invalidation has started. Poll the storage target's state field to monitor progress.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The storage target already has been invalidated, or invalidate is in progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_Invalidate": { + "$ref": "./examples/StorageTargets_Invalidate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "StorageTargets" + ], + "description": "Invalidate all cached data for a storage target. Cached files are discarded and fetched from the back end on the next request.", + "operationId": "StorageTarget_Invalidate" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/startPrimingJob": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "description": "Object containing the definition of a priming job.", + "in": "body", + "name": "primingjob", + "schema": { + "$ref": "#/definitions/PrimingJob" + } + } + ], + "responses": { + "202": { + "description": "The priming job is being created and will complete asynchronously.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StartPrimingJob": { + "$ref": "./examples/StartPrimingJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Create a priming job. This operation is only allowed when the cache is healthy.", + "operationId": "Caches_StartPrimingJob" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/stopPrimingJob": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Object containing the priming job ID.", + "in": "body", + "name": "primingJobId", + "schema": { + "$ref": "#/definitions/PrimingJobIdParameter" + } + } + ], + "responses": { + "202": { + "description": "Started priming job deletion.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The priming job is being deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StopPrimingJob": { + "$ref": "./examples/StopPrimingJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Schedule a priming job for deletion.", + "operationId": "Caches_StopPrimingJob" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/pausePrimingJob": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Object containing the priming job ID.", + "in": "body", + "name": "primingJobId", + "schema": { + "$ref": "#/definitions/PrimingJobIdParameter" + } + } + ], + "responses": { + "202": { + "description": "Priming job is being paused.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The priming job is paused." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PausePrimingJob": { + "$ref": "./examples/PausePrimingJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Schedule a priming job to be paused.", + "operationId": "Caches_PausePrimingJob" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/resumePrimingJob": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Object containing the priming job ID.", + "in": "body", + "name": "primingJobId", + "schema": { + "$ref": "#/definitions/PrimingJobIdParameter" + } + } + ], + "responses": { + "202": { + "description": "Priming job is being resumed.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "The priming job is running." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResumePrimingJob": { + "$ref": "./examples/ResumePrimingJob.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Resumes a paused priming job.", + "operationId": "Caches_ResumePrimingJob" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/upgrade": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + } + ], + "responses": { + "201": { + "description": "Cache firmware is up to date." + }, + "202": { + "description": "Cache has started the upgrade. Poll the cache's state field to monitor.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "204": { + "description": "Cache firmware is up to date." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Caches_UpgradeFirmware": { + "$ref": "./examples/Caches_UpgradeFirmware.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Upgrade a cache's firmware if a new version is available. Otherwise, this operation has no effect.", + "operationId": "Caches_UpgradeFirmware" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/spaceAllocation": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "description": "List containing storage target cache space percentage allocations.", + "in": "body", + "name": "spaceAllocation", + "schema": { + "$ref": "#/definitions/SpaceAllocationParameter" + } + } + ], + "responses": { + "202": { + "description": "Error response describing why the operation failed.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SpaceAllocation_Post": { + "$ref": "./examples/SpaceAllocation_Post.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "tags": [ + "Caches" + ], + "description": "Update cache space allocation.", + "operationId": "Caches_SpaceAllocation" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageCache/caches/{cacheName}/storageTargets/{storageTargetName}/restoreDefaults": { + "post": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/StorageTargetParameter" + } + ], + "responses": { + "200": { + "description": "Cache has restored the storage target's settings to their default values." + }, + "202": { + "description": "Cache has started restoring the storage target's settings to their default values.", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "URI to poll for the operation status", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageTargets_RestoreDefaults": { + "$ref": "./examples/StorageTargets_RestoreDefaults.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "tags": [ + "StorageTargets" + ], + "description": "Tells a storage target to restore its settings to their default values.", + "operationId": "StorageTargets_RestoreDefaults" + } + } + }, + "definitions": { + "ApiOperation": { + "description": "REST API operation description: see https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/openapi-authoring-automated-guidelines.md#r3023-operationsapiimplementation", + "properties": { + "display": { + "type": "object", + "description": "The object that represents the operation.", + "properties": { + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft.StorageCache", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Cache, etc.", + "type": "string" + }, + "description": { + "description": "The description of the operation", + "type": "string" + } + } + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "isDataAction": { + "description": "The flag that indicates whether the operation applies to data plane.", + "type": "boolean" + }, + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Additional details about an operation.", + "type": "object", + "properties": { + "serviceSpecification": { + "type": "object", + "description": "Specification of the all the metrics provided for a resource type.", + "properties": { + "metricSpecifications": { + "description": "Details about operations related to metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "logSpecifications": { + "description": "Details about operations related to logs.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + } + } + } + }, + "type": "object" + }, + "ApiOperationListResult": { + "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + }, + "value": { + "description": "List of Resource Provider operations supported by the Microsoft.StorageCache resource provider.", + "items": { + "$ref": "#/definitions/ApiOperation" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "CloudError": { + "x-ms-external": true, + "description": "An error response.", + "properties": { + "error": { + "description": "The body of the error.", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "type": "object" + }, + "CloudErrorBody": { + "description": "An error response.", + "properties": { + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", + "type": "string" + }, + "target": { + "description": "The target of the particular error. For example, the name of the property in error.", + "type": "string" + } + }, + "type": "object" + }, + "AscOperation": { + "description": "The status of operation.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The operation Id." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "startTime": { + "type": "string", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "description": "The end time of the operation." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "error": { + "type": "object", + "description": "The error detail of the operation if any.", + "$ref": "#/definitions/ErrorResponse" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Additional operation-specific properties", + "$ref": "#/definitions/AscOperationProperties" + } + } + }, + "AscOperationProperties": { + "type": "object", + "description": "Additional operation-specific output.", + "properties": { + "output": { + "type": "object", + "description": "Additional operation-specific output.", + "additionalProperties": { + "type": "object" + } + } + } + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "Cache": { + "description": "A cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "id": { + "description": "Resource ID of the cache.", + "readOnly": true, + "$ref": "#/definitions/URLString" + }, + "location": { + "description": "Region name string.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "name": { + "description": "Name of cache.", + "readOnly": true, + "$ref": "#/definitions/ResourceName" + }, + "type": { + "description": "Type of the cache; Microsoft.StorageCache/Cache", + "readOnly": true, + "type": "string" + }, + "identity": { + "$ref": "#/definitions/CacheIdentity", + "description": "The identity of the cache, if configured." + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the cache.", + "properties": { + "cacheSizeGB": { + "description": "The size of this Cache, in GB.", + "type": "integer", + "format": "int32", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "health": { + "description": "Health of the cache.", + "readOnly": true, + "$ref": "#/definitions/CacheHealth" + }, + "mountAddresses": { + "description": "Array of IPv4 addresses that can be used by clients mounting this cache.", + "readOnly": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "provisioningState": { + "description": "ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningStateType", + "modelAsString": true + }, + "type": "string", + "readOnly": true + }, + "subnet": { + "description": "Subnet used for the cache.", + "$ref": "#/definitions/URLString", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "upgradeStatus": { + "description": "Upgrade status of the cache.", + "$ref": "#/definitions/CacheUpgradeStatus", + "readOnly": true + }, + "upgradeSettings": { + "description": "Upgrade settings of the cache.", + "$ref": "#/definitions/CacheUpgradeSettings" + }, + "networkSettings": { + "$ref": "#/definitions/CacheNetworkSettings", + "description": "Specifies network settings of the cache." + }, + "encryptionSettings": { + "$ref": "#/definitions/CacheEncryptionSettings", + "description": "Specifies encryption settings of the cache." + }, + "securitySettings": { + "$ref": "#/definitions/CacheSecuritySettings", + "description": "Specifies security settings of the cache." + }, + "directoryServicesSettings": { + "$ref": "#/definitions/CacheDirectorySettings", + "description": "Specifies Directory Services settings of the cache." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability zones for resources. This field should only contain a single element in the array.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "primingJobs": { + "$ref": "#/definitions/PrimingJobList", + "description": "Specifies the priming jobs defined in the cache." + }, + "spaceAllocation": { + "$ref": "#/definitions/SpaceAllocationList", + "description": "Specifies the space allocation percentage for each storage target in the cache." + } + }, + "type": "object" + }, + "sku": { + "x-ms-mutability": [ + "read", + "create" + ], + "description": "SKU for the cache.", + "properties": { + "name": { + "description": "SKU name for this cache.", + "type": "string" + } + }, + "type": "object" + } + }, + "x-ms-azure-resource": true, + "type": "object" + }, + "CacheIdentity": { + "type": "object", + "description": "Cache identity properties.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID for the system-assigned identity of the cache." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID associated with the cache." + }, + "type": { + "type": "string", + "description": "The type of identity used for the cache", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "CacheIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "A dictionary where each key is a user assigned identity resource ID, and each key's value is an empty dictionary.", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "userAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the user-assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client ID of the user-assigned identity." + } + } + } + } + } + }, + "CacheNetworkSettings": { + "type": "object", + "description": "Cache network settings.", + "properties": { + "mtu": { + "description": "The IPv4 maximum transmission unit configured for the subnet.", + "type": "integer", + "format": "int32", + "minimum": 576, + "maximum": 1500, + "default": 1500 + }, + "utilityAddresses": { + "description": "Array of additional IP addresses used by this cache.", + "readOnly": true, + "items": { + "type": "string" + }, + "type": "array" + }, + "dnsServers": { + "description": "DNS servers for the cache to use. It will be set from the network configuration if no value is provided.", + "type": "array", + "items": { + "type": "string" + } + }, + "dnsSearchDomain": { + "description": "DNS search domain", + "type": "string" + }, + "ntpServer": { + "description": "NTP server IP Address or FQDN for the cache to use. The default is time.windows.com.", + "type": "string", + "default": "time.windows.com" + } + } + }, + "CacheEncryptionSettings": { + "type": "object", + "description": "Cache encryption settings.", + "properties": { + "keyEncryptionKey": { + "x-ms-secret": true, + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in key vault." + }, + "rotationToLatestKeyVersionEnabled": { + "type": "boolean", + "description": "Specifies whether the service will automatically rotate to the newest version of the key in the key vault." + } + } + }, + "CacheSecuritySettings": { + "type": "object", + "description": "Cache security settings.", + "properties": { + "accessPolicies": { + "description": "NFS access policies defined for this cache.", + "items": { + "$ref": "#/definitions/NfsAccessPolicy" + }, + "type": "array", + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "CacheDirectorySettings": { + "description": "Cache Directory Services settings.", + "type": "object", + "properties": { + "activeDirectory": { + "$ref": "#/definitions/CacheActiveDirectorySettings", + "description": "Specifies settings for joining the HPC Cache to an Active Directory domain." + }, + "usernameDownload": { + "$ref": "#/definitions/CacheUsernameDownloadSettings", + "description": "Specifies settings for Extended Groups. Extended Groups allows users to be members of more than 16 groups." + } + } + }, + "CacheActiveDirectorySettings": { + "description": "Active Directory settings used to join a cache to a domain.", + "properties": { + "primaryDnsIpAddress": { + "description": "Primary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.", + "type": "string" + }, + "secondaryDnsIpAddress": { + "description": "Secondary DNS IP address used to resolve the Active Directory domain controller's fully qualified domain name.", + "type": "string" + }, + "domainName": { + "description": "The fully qualified domain name of the Active Directory domain controller.", + "type": "string" + }, + "domainNetBiosName": { + "description": "The Active Directory domain's NetBIOS name.", + "type": "string" + }, + "cacheNetBiosName": { + "description": "The NetBIOS name to assign to the HPC Cache when it joins the Active Directory domain as a server. Length must 1-15 characters from the class [-0-9a-zA-Z].", + "pattern": "^[-0-9a-zA-Z]{1,15}$", + "type": "string" + }, + "domainJoined": { + "description": "True if the HPC Cache is joined to the Active Directory domain.", + "type": "string", + "readOnly": true, + "enum": [ + "Yes", + "No", + "Error" + ], + "x-ms-enum": { + "name": "DomainJoinedType", + "modelAsString": true + } + }, + "credentials": { + "type": "object", + "description": "Active Directory admin credentials used to join the HPC Cache to a domain.", + "properties": { + "username": { + "description": "Username of the Active Directory domain administrator. This value is stored encrypted and not returned on response.", + "type": "string" + }, + "password": { + "description": "Plain text password of the Active Directory domain administrator. This value is stored encrypted and not returned on response.", + "x-ms-secret": true, + "type": "string", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + } + }, + "required": [ + "username" + ] + } + }, + "type": "object", + "required": [ + "primaryDnsIpAddress", + "domainNetBiosName", + "domainName", + "cacheNetBiosName" + ] + }, + "CacheUsernameDownloadSettings": { + "description": "Settings for Extended Groups username and group download.", + "type": "object", + "properties": { + "extendedGroups": { + "type": "boolean", + "description": "Whether or not Extended Groups is enabled." + }, + "usernameSource": { + "description": "This setting determines how the cache gets username and group names for clients.", + "enum": [ + "AD", + "LDAP", + "File", + "None" + ], + "x-ms-enum": { + "name": "UsernameSource", + "modelAsString": true + }, + "type": "string", + "default": "None" + }, + "groupFileURI": { + "type": "string", + "description": "The URI of the file containing group information (in /etc/group file format). This field must be populated when 'usernameSource' is set to 'File'." + }, + "userFileURI": { + "type": "string", + "description": "The URI of the file containing user information (in /etc/passwd file format). This field must be populated when 'usernameSource' is set to 'File'." + }, + "ldapServer": { + "type": "string", + "description": "The fully qualified domain name or IP address of the LDAP server to use." + }, + "ldapBaseDN": { + "type": "string", + "description": "The base distinguished name for the LDAP domain." + }, + "encryptLdapConnection": { + "type": "boolean", + "description": "Whether or not the LDAP connection should be encrypted.", + "default": false + }, + "requireValidCertificate": { + "type": "boolean", + "description": "Determines if the certificates must be validated by a certificate authority. When true, caCertificateURI must be provided.", + "default": false + }, + "autoDownloadCertificate": { + "type": "boolean", + "description": "Determines if the certificate should be automatically downloaded. This applies to 'caCertificateURI' only if 'requireValidCertificate' is true.", + "default": false + }, + "caCertificateURI": { + "type": "string", + "description": "The URI of the CA certificate to validate the LDAP secure connection. This field must be populated when 'requireValidCertificate' is set to true." + }, + "usernameDownloaded": { + "description": "Indicates whether or not the HPC Cache has performed the username download successfully.", + "type": "string", + "readOnly": true, + "enum": [ + "Yes", + "No", + "Error" + ], + "x-ms-enum": { + "name": "UsernameDownloadedType", + "modelAsString": true + } + }, + "credentials": { + "type": "object", + "description": "When present, these are the credentials for the secure LDAP connection.", + "properties": { + "bindDn": { + "type": "string", + "description": "The Bind Distinguished Name identity to be used in the secure LDAP connection. This value is stored encrypted and not returned on response.", + "x-ms-mutability": [ + "read", + "create", + "update" + ] + }, + "bindPassword": { + "type": "string", + "x-ms-secret": true, + "description": "The Bind password to be used in the secure LDAP connection. This value is stored encrypted and not returned on response." + } + } + } + } + }, + "NfsAccessPolicy": { + "type": "object", + "description": "A set of rules describing access policies applied to NFSv3 clients of the cache.", + "properties": { + "name": { + "description": "Name identifying this policy. Access Policy names are not case sensitive.", + "type": "string" + }, + "accessRules": { + "description": "The set of rules describing client accesses allowed under this policy.", + "type": "array", + "items": { + "$ref": "#/definitions/NfsAccessRule" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name", + "accessRules" + ] + }, + "NfsAccessRule": { + "type": "object", + "description": "Rule to place restrictions on portions of the cache namespace being presented to clients.", + "properties": { + "scope": { + "description": "Scope for this rule. The scope and filter determine which clients match the rule.", + "type": "string", + "enum": [ + "default", + "network", + "host" + ], + "x-ms-enum": { + "name": "NfsAccessRuleScope", + "modelAsString": true + } + }, + "filter": { + "description": "Filter applied to the scope for this rule. The filter's format depends on its scope. 'default' scope matches all clients and has no filter value. 'network' scope takes a filter in CIDR format (for example, 10.99.1.0/24). 'host' takes an IP address or fully qualified domain name as filter. If a client does not match any filter rule and there is no default rule, access is denied.", + "type": "string" + }, + "access": { + "description": "Access allowed by this rule.", + "type": "string", + "enum": [ + "no", + "ro", + "rw" + ], + "x-ms-enum": { + "name": "NfsAccessRuleAccess", + "modelAsString": true + } + }, + "suid": { + "description": "Allow SUID semantics.", + "type": "boolean" + }, + "submountAccess": { + "description": "For the default policy, allow access to subdirectories under the root export. If this is set to no, clients can only mount the path '/'. If set to yes, clients can mount a deeper path, like '/a/b'.", + "type": "boolean" + }, + "rootSquash": { + "description": "Map root accesses to anonymousUID and anonymousGID.", + "type": "boolean" + }, + "anonymousUID": { + "description": "UID value that replaces 0 when rootSquash is true. 65534 will be used if not provided.", + "type": "string" + }, + "anonymousGID": { + "description": "GID value that replaces 0 when rootSquash is true. This will use the value of anonymousUID if not provided.", + "type": "string" + } + }, + "required": [ + "scope", + "access" + ] + }, + "KeyVaultKeyReference": { + "type": "object", + "description": "Describes a reference to key vault key.", + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in key vault." + }, + "sourceVault": { + "type": "object", + "description": "Describes a resource Id to source key vault.", + "properties": { + "id": { + "type": "string", + "description": "Resource Id." + } + } + } + }, + "required": [ + "keyUrl", + "sourceVault" + ] + }, + "CachesListResult": { + "description": "Result of the request to list caches. It contains a list of caches and a URL link to get the next set of results.", + "properties": { + "nextLink": { + "description": "URL to get the next set of cache list results, if there are any.", + "type": "string" + }, + "value": { + "description": "List of Caches.", + "items": { + "$ref": "#/definitions/Cache" + }, + "type": "array" + } + }, + "type": "object" + }, + "CacheHealth": { + "type": "object", + "description": "An indication of cache health. Gives more information about health than just that related to provisioning.", + "properties": { + "state": { + "description": "List of cache health states. Down is when the cluster is not responding. Degraded is when its functioning but has some alerts. Transitioning when it is creating or deleting. Unknown will be returned in old api versions when a new value is added in future versions. WaitingForKey is when the create is waiting for the system assigned identity to be given access to the encryption key in the encryption settings.", + "enum": [ + "Unknown", + "Healthy", + "Degraded", + "Down", + "Transitioning", + "Stopping", + "Stopped", + "Upgrading", + "Flushing", + "WaitingForKey", + "StartFailed", + "UpgradeFailed" + ], + "x-ms-enum": { + "name": "HealthStateType", + "modelAsString": true + }, + "type": "string" + }, + "statusDescription": { + "description": "Describes explanation of state.", + "type": "string" + }, + "conditions": { + "description": "Outstanding conditions that need to be investigated and resolved.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Condition" + }, + "x-ms-identifiers": [] + } + } + }, + "Condition": { + "type": "object", + "description": "Outstanding conditions that will need to be resolved.", + "properties": { + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the condition was raised." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The issue requiring attention." + } + } + }, + "CacheUpgradeStatus": { + "description": "Properties describing the software upgrade state of the cache.", + "properties": { + "currentFirmwareVersion": { + "description": "Version string of the firmware currently installed on this cache.", + "type": "string", + "readOnly": true + }, + "firmwareUpdateStatus": { + "description": "True if there is a firmware update ready to install on this cache. The firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.", + "enum": [ + "available", + "unavailable" + ], + "x-ms-enum": { + "name": "FirmwareStatusType", + "modelAsString": true + }, + "readOnly": true, + "type": "string" + }, + "firmwareUpdateDeadline": { + "description": "Time at which the pending firmware update will automatically be installed on the cache.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastFirmwareUpdate": { + "description": "Time of the last successful firmware update.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "pendingFirmwareVersion": { + "description": "When firmwareUpdateAvailable is true, this field holds the version string for the update.", + "type": "string", + "readOnly": true + } + }, + "type": "object" + }, + "CacheUpgradeSettings": { + "description": "Cache Upgrade Settings.", + "properties": { + "upgradeScheduleEnabled": { + "description": "True if the user chooses to select an installation time between now and firmwareUpdateDeadline. Else the firmware will automatically be installed after firmwareUpdateDeadline if not triggered earlier via the upgrade operation.", + "type": "boolean" + }, + "scheduledTime": { + "description": "When upgradeScheduleEnabled is true, this field holds the user-chosen upgrade time. At the user-chosen time, the firmware update will automatically be installed on the cache.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "UnknownProperties": { + "description": "Properties of an unknown type of Storage Target.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "StorageTarget": { + "type": "object", + "description": "Type of the Storage Target.", + "allOf": [ + { + "$ref": "#/definitions/StorageTargetResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "StorageTarget properties", + "$ref": "#/definitions/StorageTargetProperties" + } + } + }, + "StorageTargetResource": { + "type": "object", + "description": "Resource used by a cache.", + "properties": { + "name": { + "description": "Name of the Storage Target.", + "readOnly": true, + "$ref": "#/definitions/ResourceName" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID of the Storage Target." + }, + "type": { + "description": "Type of the Storage Target; Microsoft.StorageCache/Cache/StorageTarget", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "Region name string.", + "readOnly": true, + "type": "string" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "StorageTargetProperties": { + "type": "object", + "description": "Properties of the Storage Target.", + "required": [ + "targetType" + ], + "properties": { + "junctions": { + "description": "List of cache namespace junctions to target for namespace associations.", + "type": "array", + "items": { + "$ref": "#/definitions/NamespaceJunction" + }, + "x-ms-identifiers": [] + }, + "targetType": { + "description": "Type of the Storage Target.", + "enum": [ + "nfs3", + "clfs", + "unknown", + "blobNfs" + ], + "x-ms-enum": { + "name": "StorageTargetType", + "modelAsString": true + }, + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "provisioningState": { + "description": "ARM provisioning state, see https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/Addendum.md#provisioningstate-property", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Creating", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningStateType", + "modelAsString": true + }, + "type": "string", + "readOnly": true + }, + "state": { + "description": "Storage target operational state.", + "enum": [ + "Ready", + "Busy", + "Suspended", + "Flushing" + ], + "x-ms-enum": { + "name": "OperationalStateType", + "modelAsString": true + }, + "type": "string" + }, + "nfs3": { + "description": "Properties when targetType is nfs3.", + "$ref": "#/definitions/Nfs3Target" + }, + "clfs": { + "description": "Properties when targetType is clfs.", + "$ref": "#/definitions/ClfsTarget" + }, + "unknown": { + "description": "Properties when targetType is unknown.", + "$ref": "#/definitions/UnknownTarget" + }, + "blobNfs": { + "description": "Properties when targetType is blobNfs.", + "$ref": "#/definitions/BlobNfsTarget" + }, + "allocationPercentage": { + "description": "The percentage of cache space allocated for this storage target", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100, + "readOnly": true + } + } + }, + "Nfs3Target": { + "type": "object", + "description": "Properties pertaining to the Nfs3Target", + "properties": { + "target": { + "description": "IP address or host name of an NFSv3 host (e.g., 10.0.44.44).", + "pattern": "^[-.,0-9a-zA-Z]+$", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "usageModel": { + "description": "Identifies the StorageCache usage model to be used for this storage target.", + "type": "string" + }, + "verificationTimer": { + "description": "Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates.", + "type": "integer", + "format": "int32" + }, + "writeBackTimer": { + "description": "Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage.", + "type": "integer", + "format": "int32" + } + } + }, + "ClfsTarget": { + "type": "object", + "description": "Properties pertaining to the ClfsTarget", + "properties": { + "target": { + "description": "Resource ID of storage container.", + "$ref": "#/definitions/URLString", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "UnknownTarget": { + "type": "object", + "description": "Properties pertaining to the UnknownTarget", + "properties": { + "attributes": { + "description": "Dictionary of string->string pairs containing information about the Storage Target.", + "$ref": "#/definitions/UnknownProperties" + } + } + }, + "BlobNfsTarget": { + "type": "object", + "description": "Properties pertaining to the BlobNfsTarget.", + "properties": { + "target": { + "description": "Resource ID of the storage container.", + "$ref": "#/definitions/URLString", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "usageModel": { + "description": "Identifies the StorageCache usage model to be used for this storage target.", + "type": "string" + }, + "verificationTimer": { + "description": "Amount of time (in seconds) the cache waits before it checks the back-end storage for file updates.", + "type": "integer", + "format": "int32" + }, + "writeBackTimer": { + "description": "Amount of time (in seconds) the cache waits after the last file change before it copies the changed file to back-end storage.", + "type": "integer", + "format": "int32" + } + } + }, + "ResourceName": { + "description": "Schema for the name of resources served by this provider. Note that objects will contain an odata @id annotation as appropriate. This will contain the complete resource id of the object. These names are case-preserving, but not case sensitive.", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "type": "string" + }, + "ResourceSku": { + "description": "A resource SKU.", + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the SKU applies to." + }, + "capabilities": { + "description": "A list of capabilities of this SKU, such as throughput or ops/sec.", + "items": { + "$ref": "#/definitions/ResourceSkuCapabilities" + }, + "type": "array", + "x-ms-identifiers": [ + "name" + ] + }, + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations where the SKU is available. This is the supported and registered Azure Geo Regions (e.g., West US, East US, Southeast Asia, etc.)." + }, + "locationInfo": { + "description": "The set of locations where the SKU is available.", + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "name": { + "description": "The name of this SKU.", + "type": "string" + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Restriction" + }, + "description": "The restrictions preventing this SKU from being used. This is empty if there are no restrictions.", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "Restriction": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The type of restrictions. In this version, the only possible value for this is location." + }, + "values": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location, then this would be the different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "enum": [ + "QuotaId", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ReasonCode", + "modelAsString": true + }, + "description": "The reason for the restriction. As of now this can be \"QuotaId\" or \"NotAvailableForSubscription\". \"QuotaId\" is set when the SKU has requiredQuotas parameter as the subscription does not belong to that quota. \"NotAvailableForSubscription\" is related to capacity at the datacenter." + } + }, + "description": "The restrictions preventing this SKU from being used." + }, + "ResourceSkuCapabilities": { + "description": "A resource SKU capability.", + "properties": { + "name": { + "description": "Name of a capability, such as ops/sec.", + "type": "string" + }, + "value": { + "description": "Quantity, if the capability is measured by quantity.", + "type": "string" + } + }, + "type": "object" + }, + "ResourceSkuLocationInfo": { + "description": "Resource SKU location information.", + "properties": { + "location": { + "description": "Location where this SKU is available.", + "type": "string" + }, + "zones": { + "description": "Zones if any.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + }, + "ResourceSkusResult": { + "type": "object", + "description": "The response from the List Cache SKUs operation.", + "properties": { + "nextLink": { + "description": "The URI to fetch the next page of cache SKUs.", + "type": "string" + }, + "value": { + "description": "The list of SKUs available for the subscription.", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSku" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "NamespaceJunction": { + "description": "A namespace junction.", + "type": "object", + "properties": { + "namespacePath": { + "description": "Namespace path on a cache for a Storage Target.", + "type": "string" + }, + "targetPath": { + "description": "Path in Storage Target to which namespacePath points.", + "type": "string" + }, + "nfsExport": { + "description": "NFS export where targetPath exists.", + "type": "string" + }, + "nfsAccessPolicy": { + "description": "Name of the access policy applied to this junction.", + "type": "string", + "default": "default" + } + } + }, + "StorageTargetsResult": { + "description": "A list of Storage Targets.", + "properties": { + "nextLink": { + "description": "The URI to fetch the next page of Storage Targets.", + "type": "string" + }, + "value": { + "description": "The list of Storage Targets defined for the cache.", + "items": { + "$ref": "#/definitions/StorageTarget" + }, + "type": "array" + } + }, + "type": "object" + }, + "URLString": { + "description": "A fully qualified URL.", + "type": "string" + }, + "UsageModel": { + "description": "A usage model.", + "properties": { + "display": { + "description": "Localized information describing this usage model.", + "type": "object", + "properties": { + "description": { + "description": "String to display for this usage model.", + "type": "string" + } + } + }, + "modelName": { + "description": "Non-localized keyword name for this usage model.", + "type": "string" + }, + "targetType": { + "description": "The type of Storage Target to which this model is applicable (only nfs3 as of this version).", + "type": "string" + } + }, + "type": "object" + }, + "UsageModelsResult": { + "description": "A list of cache usage models.", + "properties": { + "nextLink": { + "description": "The URI to fetch the next page of cache usage models.", + "type": "string" + }, + "value": { + "description": "The list of usage models available for the subscription.", + "items": { + "$ref": "#/definitions/UsageModel" + }, + "type": "array", + "x-ms-identifiers": [ + "modelName" + ] + } + }, + "type": "object" + }, + "ResourceUsagesListResult": { + "description": "Result of the request to list resource usages. It contains a list of resource usages & limits and a URL link to get the next set of results.", + "properties": { + "nextLink": { + "description": "URL to get the next set of resource usage list results if there are any.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "List of usages and limits for resources controlled by the Microsoft.StorageCache resource provider.", + "items": { + "$ref": "#/definitions/ResourceUsage" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [ + "name" + ] + } + }, + "type": "object" + }, + "ResourceUsage": { + "description": "The usage and limit (quota) for a resource.", + "properties": { + "limit": { + "description": "The limit (quota) for this resource.", + "readOnly": true, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "unit": { + "description": "Unit that the limit and usages are expressed in, such as 'Count'.", + "readOnly": true, + "type": "string" + }, + "currentValue": { + "description": "The current usage of this resource.", + "readOnly": true, + "type": "integer", + "format": "int32", + "minimum": 0 + }, + "name": { + "description": "Naming information for this resource type.", + "readOnly": true, + "type": "object", + "properties": { + "value": { + "description": "Canonical name for this resource type.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name for this resource type.", + "type": "string" + } + } + } + }, + "type": "object" + }, + "MetricSpecification": { + "type": "object", + "description": "Details about operation related to metrics.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "Localized display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "The description of the metric." + }, + "unit": { + "type": "string", + "description": "The unit that the metric is measured in." + }, + "aggregationType": { + "type": "string", + "description": "The type of metric aggregation." + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "type": "array", + "items": { + "enum": [ + "NotSpecified", + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + }, + "metricClass": { + "description": "Type of metrics.", + "type": "string" + }, + "dimensions": { + "description": "Dimensions of the metric", + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "x-ms-identifiers": [] + } + } + }, + "LogSpecification": { + "type": "object", + "description": "Details about operation related to logs.", + "properties": { + "name": { + "type": "string", + "description": "The name of the log." + }, + "displayName": { + "type": "string", + "description": "Localized display name of the log." + } + } + }, + "MetricDimension": { + "type": "object", + "description": "Specifications of the Dimension of metrics.", + "properties": { + "name": { + "type": "string", + "description": "Name of the dimension" + }, + "displayName": { + "type": "string", + "description": "Localized friendly display name of the dimension" + }, + "internalName": { + "type": "string", + "description": "Internal name of the dimension." + }, + "toBeExportedForShoebox": { + "description": "To be exported to shoe box.", + "type": "boolean" + } + } + }, + "PrimingJob": { + "description": "A priming job instance.", + "properties": { + "primingJobName": { + "description": "The priming job name.", + "$ref": "#/definitions/ResourceName", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "primingManifestUrl": { + "description": "The URL for the priming manifest file to download. This file must be readable from the HPC Cache. When the file is in Azure blob storage the URL should include a Shared Access Signature (SAS) granting read permissions on the blob.", + "type": "string", + "x-ms-mutability": [ + "create" + ], + "x-ms-secret": true + }, + "primingJobId": { + "description": "The unique identifier of the priming job.", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "readOnly": true, + "type": "string" + }, + "primingJobState": { + "description": "The state of the priming operation.", + "enum": [ + "Queued", + "Running", + "Paused", + "Complete" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "PrimingJobState", + "modelAsString": true + } + }, + "primingJobStatus": { + "description": "The status code of the priming job.", + "type": "string", + "readOnly": true + }, + "primingJobDetails": { + "description": "The job details or error information if any.", + "type": "string", + "readOnly": true + }, + "primingJobPercentComplete": { + "description": "The current progress of the priming job, as a percentage.", + "type": "number", + "format": "double", + "maximum": 100, + "minimum": 0, + "readOnly": true + } + }, + "required": [ + "primingJobName", + "primingManifestUrl" + ], + "type": "object" + }, + "PrimingJobList": { + "description": "The list of priming jobs defined for the cache.", + "items": { + "$ref": "#/definitions/PrimingJob" + }, + "type": "array", + "x-ms-identifiers": [ + "primingJobId" + ], + "readOnly": true + }, + "PrimingJobIdParameter": { + "description": "Object containing the priming job ID.", + "properties": { + "primingJobId": { + "description": "The unique identifier of the priming job.", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "type": "string" + } + }, + "required": [ + "primingJobId" + ], + "type": "object" + }, + "SpaceAllocationList": { + "description": "List of storage target space allocations.", + "items": { + "$ref": "#/definitions/StorageTargetSpaceAllocation" + }, + "type": "array", + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "SpaceAllocationParameter": { + "description": "List of storage target space allocations.", + "items": { + "$ref": "#/definitions/StorageTargetSpaceAllocation" + }, + "type": "array", + "x-ms-identifiers": [ + "name" + ] + }, + "StorageTargetSpaceAllocation": { + "description": "Storage Target space allocation properties.", + "properties": { + "name": { + "description": "Name of the storage target.", + "$ref": "#/definitions/ResourceName" + }, + "allocationPercentage": { + "description": "The percentage of cache space allocated for this storage target", + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 100 + } + }, + "type": "object" + } + }, + "parameters": { + "CacheNameParameter": { + "description": "Name of cache. Length of name must not be greater than 80 and chars must be from the [-0-9a-zA-Z_] char class.", + "in": "path", + "name": "cacheName", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "StorageTargetParameter": { + "description": "Name of Storage Target.", + "in": "path", + "name": "storageTargetName", + "pattern": "^[-0-9a-zA-Z_]{1,80}$", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/storagecache/resource-manager/readme.md b/specification/storagecache/resource-manager/readme.md index 696e24ee9a6b..b4c0a99229c7 100644 --- a/specification/storagecache/resource-manager/readme.md +++ b/specification/storagecache/resource-manager/readme.md @@ -26,16 +26,26 @@ These are the global settings for the StorageCache API. ``` yaml openapi-type: arm -tag: package-2023-01 +tag: package-2023-05 add-credentials: true title: StorageCacheManagementClient ``` + +### Tag: package-2023-05 + +These settings apply only when `--tag=package-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-2023-05' +input-file: + - Microsoft.StorageCache/stable/2023-05-01/amlfilesystem.json + - Microsoft.StorageCache/stable/2023-05-01/storagecache.json +``` ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-03' +``` yaml $(tag) == 'package-preview-2023-03' input-file: - Microsoft.StorageCache/preview/2023-03-01-preview/storagecache.json - Microsoft.StorageCache/preview/2023-03-01-preview/amlfilesystem.json @@ -45,10 +55,11 @@ input-file: These settings apply only when `--tag=package-2023-01` is specified on the command line. -```yaml $(tag) == 'package-2023-01' +``` yaml $(tag) == 'package-2023-01' input-file: - Microsoft.StorageCache/stable/2023-01-01/storagecache.json ``` + ### Tag: package-2022-05 These settings apply only when `--tag=package-2022-05` is specified on the command line.