swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector StorageTargets API schemes: - https tags: - name: StorageTargets paths: ? /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: microsoftAzureStoragetargetsDnsrefresh summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets Storagetargetname Dnsrefresh ? /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: microsoftAzureStoragetargetsListbycache summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets ? /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: microsoftAzureStoragetargetsDelete summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets Storagetargetname 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: microsoftAzureStoragetargetsGet summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets Storagetargetname 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: microsoftAzureStoragetargetsCreateorupdate summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets Storagetargetname ? /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: microsoftAzureStoragetargetFlush summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets Storagetargetname 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: microsoftAzureStoragetargetSuspend summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets Storagetargetname 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: microsoftAzureStoragetargetResume summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets Storagetargetname 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: microsoftAzureStoragetargetInvalidate summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets Storagetargetname Invalidate ? /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: microsoftAzureStoragetargetsRestoredefaults summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Storagecache Caches Cachename Storagetargets Storagetargetname Restoredefaults definitions: 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 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' UnknownProperties: description: Properties of an unknown type of Storage Target. type: object additionalProperties: type: string 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 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' 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 CloudError: x-ms-external: true description: An error response. properties: error: description: The body of the error. $ref: '#/definitions/CloudErrorBody' type: object 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 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 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 URLString: description: A fully qualified URL. type: string 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 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 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 parameters: 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 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 x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'