This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Folder State by Storage Account ID and Container Name
This section explains how to get a folder state to know if the specified folder is already used as a backup repository.
Request
GET https://<hostname>/api/v1/cloudInfrastructure/storageAccounts/{azureStorageId}/containers/{containerName}/folderState?FolderName=<folder_name>&connectionID=<id> |
Request Headers
The request header must contain an authorization token of the current session.
Request Parameters
The following parameters must be posted as URL.
Parameter | Description |
storageAccountId | The identification numbers of the Azure storage account. Can be obtained as described in Getting Storage Accounts. |
containerName | The name if the Azure container. Can be obtained as described in Getting Containers by Storage ID. |
FolderName | Sets the folder name the of which you want to verify. |
connectionID | Sets the identification number of the Azure account used to access the storage account. Can be obtained as described in Getting Connections. |
Request Body
None.
Response
The server returns the following response to the client.
Response Codes
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTPS headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the response body message: application/json; charset=utf-8 |
Response Body
Property | Type | Description |
|---|---|---|
offset | integer | Shows the offset value. |
limit | integer | Shows the offset limit. |
totalCount | integer | Shows the number of records in the results array. |
results | Contains the result object. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the Azure storage account. |
resourceId | string | Shows the identification number of the resource. |
name | string | Shows the identification number of the storage account. |
skuName | string | Shows Azure SKU. |
performance | string | Shows the snapshot performance. For more information, see this Microsoft article. |
redundancy | string | Shows the snapshot redundancy. For more information, see this Microsoft article. |
accessTier | string | Shows the access tier type. |
regionId | string | Shows the identification number of the Azure region to which the snapshot belongs. |
regionName | string | Shows the identification number of the region. |
removedFromAzure | boolean | Shows if the snapshot was removed from Azure. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Example
The following example shows that the specified folder (OSRv2) is being used as a backup repository.
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/storageAccounts/6s9rdnqsnnmebudp49abg8gg44k3t4huhka9anrca1smd9u8wowo/containers/container1/folderState?FolderName=OSRv2&connectionID=9
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "ContainsRepository" } |