openapi-directory/api/azure.com/azsadmin-BackupLocations.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Admin Backup Management Client.","title":"BackupManagementClient","version":"2018-09-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/azsadmin/resource-manager/backup/Microsoft.Backup.Admin/preview/2018-09-01/BackupLocations.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"azsadmin-BackupLocations","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Backup.Admin/backupLocations":{"get":{"description":"Returns the list of backup locations.","operationId":"BackupLocations_List","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Returns the list of backup locations.":{"value":"11111111-2222-3333-4444-555555555555"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Returns the list of backup locations.":{"value":"System.local"}}},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2018-09-01"},"examples":{"Returns the list of backup locations.":{"value":"2018-09-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupLocationList"},"examples":{"Returns the list of backup locations.":{"$ref":"#/components/examples/Returns_the_list_of_backup_locations."}}}}}},"tags":["BackupLocations"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Backup.Admin/backupLocations/{location}":{"get":{"description":"Returns a specific backup location based on name.","operationId":"BackupLocations_Get","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Returns a specific backup location based on name.":{"value":"11111111-2222-3333-4444-555555555555"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Returns a specific backup location based on name.":{"value":"System.local"}}},{"$ref":"#/components/parameters/BackupLocationParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2018-09-01"},"examples":{"Returns a specific backup location based on name.":{"value":"2018-09-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupLocation"},"examples":{"Returns a specific backup location based on name.":{"$ref":"#/components/examples/Returns_a_specific_backup_location_based_on_name."}}}}}},"tags":["BackupLocations"]},"put":{"description":"Update a backup location.","operationId":"BackupLocations_Update","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Update new backup location.":{"value":"11111111-2222-3333-4444-555555555555"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Update new backup location.":{"value":"System.local"}}},{"$ref":"#/components/parameters/BackupLocationParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2018-09-01"},"examples":{"Update new backup location.":{"value":"2018-09-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupLocation"}}},"description":"Backup location object.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupLocation"},"examples":{"Update new backup location.":{"$ref":"#/components/examples/Update_new_backup_location."}}}}},"202":{"description":"ACCEPTED","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BackupLocation"},"examples":{"Update new backup location.":{"$ref":"#/components/examples/Update_new_backup_location."}}}}}},"tags":["BackupLocations"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Backup.Admin/backupLocations/{location}/createBackup":{"post":{"description":"Back up a specific location.","operationId":"BackupLocations_CreateBackup","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Back up a specific location.":{"value":"11111111-2222-3333-4444-555555555555"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Back up a specific location.":{"value":"System.local"}}},{"$ref":"#/components/parameters/BackupLocationParameter"},{"description":"Client API version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2018-09-01"},"examples":{"Back up a specific location.":{"value":"2018-09-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"description":"Base Resource Object","properties":{"id":{"description":"URI of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource.","readOnly":false,"type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"List of key value pairs.","readOnly":false,"type":"object"},"type":{"description":"Type of resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"Information related to a backup.","properties":{"properties":{"description":"Properties for a backup.","properties":{"backupInfo":{"description":"Holds information for a backup.","properties":{"backupDataVersion":{"description":"Version of the backup data.","readOnly":true,"type":"string"},"createdDateTime":{"description":"Creation time of the backup.","format":"date-time","readOnly":true,"type":"string"},"deploymentID":{"description":"Deployment Id of the stamp.","readOnly":true,"type":"string"},"encryptionCertThumbprint":{"description":"The thumbprint of the certificate used to encrypt the backup encryption key.","readOnly":true,"type":"string"},"isCloudRecoveryReady":{"description":"True if the backup can be used for cloud recovery scenario.","readOnly":true,"type":"boolean"},"oemVersion":{"description":"OEM version.","readOnly":true,"type":"string"},"roleStatus":{"description":"object","items":{"description":"Backup status for a role.","properties":{"roleName":{"description":"Name of the role.","type":"string"},"status":{"description":"Status of an operation.","enum":["Creating","Queued","Running","Deleted","Failed","PartialSucceeded","Succeeded"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"OperationStatus"}}},"type":"object"},"type":"array"},"stampVersion":{"description":"Azure Stack stamp version of the backup.","readOnly":true,"type":"string"},"status":{"description":"Status of an operation.","enum":["Creating","Queued","Running","Deleted","Failed","PartialSucceeded","Succeeded"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"OperationStatus"}},"timeTakenToCreate":{"description":"Duration to create the backup.","readOnly":true,"type":"string"}},"type":"object"}}}},"type":"object"},"examples":{"Back up a specific location.":{"$ref":"#/components/examples/Back_up_a_specific_location."}}}}},"202":{"description":"ACCEPTED","content":{"application/json":{"schema":{"allOf":[{"description":"Base Resource Object","properties":{"id":{"description":"URI of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource.","readOnly":false,"type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"List of key value pairs.","readOnly":false,"type":"object"},"type":{"description":"Type of resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"Information related to a backup.","properties":{"properties":{"description":"Properties for a backup.","properties":{"backupInfo":{"description":"Holds information for a backup.","properties":{"backupDataVersion":{"description":"Version of the backup data.","readOnly":true,"type":"string"},"createdDateTime":{"description":"Creation time of the backup.","format":"date-time","readOnly":true,"type":"string"},"deploymentID":{"description":"Deployment Id of the stamp.","readOnly":true,"type":"string"},"encryptionCertThumbprint":{"description":"The thumbprint of the certificate used to encrypt the backup encryption key.","readOnly":true,"type":"string"},"isCloudRecoveryReady":{"description":"True if the backup can be used for cloud recovery scenario.","readOnly":true,"type":"boolean"},"oemVersion":{"description":"OEM version.","readOnly":true,"type":"string"},"roleStatus":{"description":"object","items":{"description":"Backup status for a role.","properties":{"roleName":{"description":"Name of the role.","type":"string"},"status":{"description":"Status of an operation.","enum":["Creating","Queued","Running","Deleted","Failed","PartialSucceeded","Succeeded"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"OperationStatus"}}},"type":"object"},"type":"array"},"stampVersion":{"description":"Azure Stack stamp version of the backup.","readOnly":true,"type":"string"},"status":{"description":"Status of an operation.","enum":["Creating","Queued","Running","Deleted","Failed","PartialSucceeded","Succeeded"],"type":"string","x-ms-enum":{"modelAsString":false,"name":"OperationStatus"}},"timeTakenToCreate":{"description":"Duration to create the backup.","readOnly":true,"type":"string"}},"type":"object"}}}},"type":"object"},"examples":{"Back up a specific location.":{"$ref":"#/components/examples/Back_up_a_specific_location."}}}}}},"tags":["BackupLocations"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://adminmanagement.local.azurestack.external"}],"components":{"examples":{"Returns_the_list_of_backup_locations.":{"value":{"value":[{"id":"/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/System.local/providers/Microsoft.Backup.Admin/backupLocations/local","location":"local","name":"local","properties":{"externalStoreDefault":{"availableCapacity":"29.6 TB","backupFrequencyInHours":10,"backupRetentionPeriodInDays":6,"encryptionCertThumbprint":"BDB07F879C1F1A05B74EB43AEAF5E5B5F84DCEA8","isBackupSchedulerEnabled":false,"lastBackupTime":"2018-08-28T07:47:11.3081476Z","nextBackupTime":"2018-08-28T17:26:00.9454387Z","path":"\\\\su1fileserver\\SU1_Infrastructure_2\\BackupStore","userName":"azurestack\\azurestackadmin"}},"tags":{},"type":"Microsoft.Backup.Admin/backupLocations"}]}},"Returns_a_specific_backup_location_based_on_name.":{"value":{"id":"/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/System.local/providers/Microsoft.Backup.Admin/backupLocations/local","location":"local","name":"local","properties":{"externalStoreDefault":{"availableCapacity":"29.6 TB","backupFrequencyInHours":10,"backupRetentionPeriodInDays":6,"encryptionCertThumbprint":"BDB07F879C1F1A05B74EB43AEAF5E5B5F84DCEA8","isBackupSchedulerEnabled":false,"lastBackupTime":"2018-08-28T07:47:11.3081476Z","nextBackupTime":"2018-08-28T17:26:00.9454387Z","path":"\\\\su1fileserver\\SU1_Infrastructure_2\\BackupStore","userName":"azurestack\\azurestackadmin"}},"tags":{},"type":"Microsoft.Backup.Admin/backupLocations"}},"Update_new_backup_location.":{"value":{"id":"/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/System.local/providers/Microsoft.Backup.Admin/backupLocations/local","location":"local","name":"local","properties":{"externalStoreDefault":{"availableCapacity":"29.6 TB","backupFrequencyInHours":10,"backupRetentionPeriodInDays":6,"encryptionCertThumbprint":"BDB07F879C1F1A05B74EB43AEAF5E5B5F84DCEA8","isBackupSchedulerEnabled":false,"lastBackupTime":"2018-08-28T07:47:11.3081476Z","nextBackupTime":"2018-08-28T17:26:00.9454387Z","path":"\\\\su1fileserver\\SU1_Infrastructure_2\\BackupStore","userName":"azurestack\\azurestackadmin"}},"tags":{},"type":"Microsoft.Backup.Admin/backupLocations"}},"Back_up_a_specific_location.":{"value":{"id":"/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/system.local/providers/Microsoft.Backup.Admin/backupLocations/local/backups/64e8625a-8dc0-49df-a195-932901b4be81","location":"local","name":"local/64e8625a-8dc0-49df-a195-932901b4be81","properties":{"backupInfo":{"backupDataVersion":"1.0.1","createdDateTime":"2018-08-28T07:47:11.3081476Z","deploymentID":"d3236bc0-6a46-4877-a9da-6fe69e9661df","encryptionCertThumbprint":"BDB07F879C1F1A05B74EB43AEAF5E5B5F84DCEA8","isCloudRecoveryReady":true,"roleStatus":[{"roleName":"NRP","status":"Succeeded"},{"roleName":"SRP","status":"Succeeded"},{"roleName":"CRP","status":"Succeeded"},{"roleName":"KeyVaultInternalControlPlane","status":"Succeeded"},{"roleName":"KeyVaultInternalDataPlane","status":"Succeeded"},{"roleName":"KeyVaultControlPlane","status":"Succeeded"},{"roleName":"KeyVaultDataPlane","status":"Succeeded"},{"roleName":"KeyVaultNamingService","status":"Succeeded"},{"roleName":"WAS","status":"Succeeded"},{"roleName":"ECE","status":"Succeeded"},{"roleName":"Domain","status":"Succeeded"},{"roleName":"CA","status":"Succeeded"},{"roleName":"ACS","status":"Succeeded"}],"stampVersion":"1.1809.0.25","status":"Succeeded","timeTakenToCreate":"PT20M48.5970829S"}},"tags":{},"type":"Microsoft.Backup.Admin/backupLocations/backups"}}},"parameters":{"BackupLocationParameter":{"description":"Name of the backup location.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Returns a specific backup location based on name.":{"value":"local"},"Update new backup location.":{"value":"local"},"Back up a specific location.":{"value":"local"}}}},"securitySchemes":{"azure_auth":{"description":"Authorization uses an Azure Active Directory OAuth2 flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"BackupLocation":{"allOf":[{"description":"Base Resource Object","properties":{"id":{"description":"URI of the resource.","readOnly":true,"type":"string"},"location":{"description":"Location of the resource.","readOnly":false,"type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"List of key value pairs.","readOnly":false,"type":"object"},"type":{"description":"Type of resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"Information about the backup location.","properties":{"properties":{"$ref":"#/components/schemas/BackupLocationModel"}},"type":"object"},"BackupLocationList":{"description":"List of backup locations.","properties":{"nextLink":{"description":"URI to the next page.","type":"string"},"value":{"description":"List of backup locations.","items":{"$ref":"#/components/schemas/BackupLocation"},"type":"array"}},"type":"object"},"BackupLocationModel":{"description":"Properties of a backup location.","properties":{"externalStoreDefault":{"$ref":"#/components/schemas/ExternalStore"}},"type":"object"},"ExternalStore":{"description":"Information about an external storage location.","properties":{"availableCapacity":{"description":"Free space at the backup location.","readOnly":true,"type":"string"},"backupFrequencyInHours":{"description":"The interval, in hours, for the frequency that the scheduler takes a backup.","type":"integer"},"backupRetentionPeriodInDays":{"description":"The retention period, in days, for backs in the storage location.","type":"integer"},"encryptionCertBase64":{"description":"The base64 raw data for the backup encryption certificate.","type":"string"},"encryptionCertThumbprint":{"description":"The thumbprint of the encryption certificate.","readOnly":true,"type":"string"},"isBackupSchedulerEnabled":{"description":"True if the backup scheduler is enabled.","type":"boolean"},"lastBackupTime":{"description":"Time of backup.","format":"date-time","readOnly":true,"type":"string"},"nextBackupTime":{"description":"The scheduled time of the next backup.","format":"date-time","readOnly":true,"type":"string"},"password":{"description":"Password to access the location.","type":"string"},"path":{"description":"Path to the update location","type":"string"},"userName":{"description":"Username to access the location.","type":"string"}},"type":"object"}}}}