{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-storagesync","description":"Microsoft Storage Sync","version":"2019-03-01","base_url":"https://management.azure.com","endpoints":37,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Microsoft Storage Sync\n@base https://management.azure.com\n@version 2019-03-01\n@auth OAuth2\n@endpoints 37\n@hint download_for_search\n@toc providers(1), subscriptions(36)\n\n@group providers\n@endpoint GET /providers/Microsoft.StorageSync/operations\n@desc Lists all of the available Storage Sync Rest API operations.\n@returns(200) Array of operations resources in the Resource Provider\n\n@endgroup\n\n@group subscriptions\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/locations/{locationName}/checkNameAvailability\n@desc Check the give namespace name availability.\n@required {locationName: any # The desired region for the name check., parameters: any # Parameters to check availability of the given namespace name}\n@returns(200) check availability returned successfully.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}\n@desc Create a new StorageSyncService.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., parameters: any # Storage Sync Service resource name.}\n@returns(200) Storage Sync Service object created/updated\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}\n@desc Get a given StorageSyncService.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource.}\n@returns(200) Storage Sync Service object\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}\n@desc Patch a given StorageSyncService.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource.}\n@optional {parameters: any # Storage Sync Service resource.}\n@returns(200) Storage Sync Service object created/updated\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}\n@desc Delete a given StorageSyncService.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource.}\n@returns(200) Storage Sync Service object was deleted.\n@returns(204) Storage Sync Service Resource doesn't exist\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices\n@desc Get a StorageSyncService list by Resource group name.\n@returns(200) Array of registered Storage Sync Service resources in the Resource Group\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.StorageSync/storageSyncServices\n@desc Get a StorageSyncService list by subscription.\n@returns(200) Array of registered Storage Sync Service resources in the subscription.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups\n@desc Get a SyncGroup List.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource.}\n@returns(200) Array of Sync Group resources in Storage Sync Service\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}\n@desc Create a new SyncGroup.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., parameters: map # Sync Group Body}\n@returns(200) Sync Group object\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}\n@desc Get a given SyncGroup.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource.}\n@returns(200) Sync Group object\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}\n@desc Delete a given SyncGroup.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource.}\n@returns(200) Sync Group object was deleted\n@returns(204) Resource doesn't exist\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}\n@desc Create a new CloudEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., cloudEndpointName: any # Name of Cloud Endpoint object., parameters: map # Body of Cloud Endpoint resource.}\n@returns(200) Cloud Endpoint object\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}\n@desc Get a given CloudEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., cloudEndpointName: any # Name of Cloud Endpoint object.}\n@returns(200) Cloud Endpoint object\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}\n@desc Delete a given CloudEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., cloudEndpointName: any # Name of Cloud Endpoint object.}\n@returns(200) Ok\n@returns(202) Asynchronous Operation Status Location\n@returns(204) Resource doesn't exist\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints\n@desc Get a CloudEndpoint List.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource.}\n@returns(200) Array of Cloud Endpoint resources in Sync Group\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prebackup\n@desc Pre Backup a given CloudEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., cloudEndpointName: any # Name of Cloud Endpoint object., parameters: map # Body of Backup request.}\n@returns(200) Ok\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postbackup\n@desc Post Backup a given CloudEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., cloudEndpointName: any # Name of Cloud Endpoint object., parameters: map # Body of Backup request.}\n@returns(200) Ok\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/prerestore\n@desc Pre Restore a given CloudEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., cloudEndpointName: any # Name of Cloud Endpoint object., parameters: map # Body of Cloud Endpoint object.}\n@returns(200) Ok\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/restoreheartbeat\n@desc Restore Heartbeat a given CloudEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., cloudEndpointName: any # Name of Cloud Endpoint object.}\n@returns(200) Restore Heartbeat Operation has ran successfully.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/postrestore\n@desc Post Restore a given CloudEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., cloudEndpointName: any # Name of Cloud Endpoint object., parameters: map # Body of Cloud Endpoint object.}\n@returns(200) Ok\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/cloudEndpoints/{cloudEndpointName}/triggerChangeDetection\n@desc Triggers detection of changes performed on Azure File share connected to the specified Azure File Sync Cloud Endpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., cloudEndpointName: any # Name of Cloud Endpoint object., parameters: any # Trigger Change Detection Action parameters.}\n@returns(200) Ok\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}\n@desc Create a new ServerEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., serverEndpointName: any # Name of Server Endpoint object., parameters: map # Body of Server Endpoint object.}\n@returns(200) Server Endpoint object\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}\n@desc Patch a given ServerEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., serverEndpointName: any # Name of Server Endpoint object.}\n@optional {parameters: any # Any of the properties applicable in PUT request.}\n@returns(200) Server Endpoint object\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}\n@desc Get a ServerEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., serverEndpointName: any # Name of Server Endpoint object.}\n@returns(200) Server Endpoint object\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}\n@desc Delete a given ServerEndpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., serverEndpointName: any # Name of Server Endpoint object.}\n@returns(200) Ok\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints\n@desc Get a ServerEndpoint list.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource.}\n@returns(200) Array of Server Endpoint resources in Sync Group\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/syncGroups/{syncGroupName}/serverEndpoints/{serverEndpointName}/recallAction\n@desc Recall a server endpoint.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., syncGroupName: any # Name of Sync Group resource., serverEndpointName: any # Name of Server Endpoint object., parameters: any # Body of Recall Action object.}\n@returns(200) Server Endpoint object\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers\n@desc Get a given registered server list.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource.}\n@returns(200) Array of Registered Server resources in Storage Sync Service\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}\n@desc Get a given registered server.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., serverId: any # GUID identifying the on-premises server.}\n@returns(200) Registered Server resources in Sync Group\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}\n@desc Add a new registered server.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., serverId: any # GUID identifying the on-premises server., parameters: map # Body of Registered Server object.}\n@returns(200) Registered Server resources in Sync Group\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}\n@desc Delete the given registered server.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., serverId: any # GUID identifying the on-premises server.}\n@returns(200) Ok\n@returns(202) Asynchronous Operation Status Location\n@returns(204) Resource doesn't exist\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/registeredServers/{serverId}/triggerRollover\n@desc Triggers Server certificate rollover.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., serverId: any # Server Id, parameters: map # Body of Trigger Rollover request.}\n@returns(200) Trigger Rollover success status\n@returns(202) Asynchronous Operation Status Location\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows\n@desc Get a Workflow List\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource.}\n@returns(200) Array of Workflow resources in Storage Sync Service\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}\n@desc Get Workflows resource\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., workflowId: any # workflow Id}\n@returns(200) Workflow object\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/storageSyncServices/{storageSyncServiceName}/workflows/{workflowId}/abort\n@desc Abort the given workflow.\n@required {storageSyncServiceName: any # Name of Storage Sync Service resource., workflowId: any # workflow Id}\n@returns(200) success\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageSync/locations/{locationName}/workflows/{workflowId}/operations/{operationId}\n@desc Get Operation status\n@required {locationName: any # The desired region to obtain information from., workflowId: any # workflow Id, operationId: any # operation Id}\n@returns(200) Operation Status\n\n@endgroup\n\n@end\n"}