{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-hybriddatamanager-hybriddata","description":"HybridDataManagementClient","version":"2016-06-01","base_url":"https://management.azure.com","endpoints":29,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api HybridDataManagementClient\n@base https://management.azure.com\n@version 2016-06-01\n@auth OAuth2\n@common_fields {api-version: any # The API Version, subscriptionId: any # The Subscription Id}\n@endpoints 29\n@hint download_for_search\n@toc providers(1), subscriptions(28)\n\n@group providers\n@endpoint GET /providers/Microsoft.HybridData/operations\n@desc This method gets all the operations.\n@returns(200) This method gets all the operations.\n\n@endgroup\n\n@group subscriptions\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.HybridData/dataManagers\n@desc Lists all the data manager resources available under the subscription.\n@returns(200) List of data manager resources available under the subscription.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers\n@desc Lists all the data manager resources available under the given resource group.\n@required {resourceGroupName: any # The Resource Group Name}\n@returns(200) List of data manager resources by resource group.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}\n@desc Gets information about the specified data manager resource.\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) Data Manager Resource object.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}\n@desc Creates a new data manager resource with the specified parameters. Existing resources cannot be updated with this API\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only, dataManager: map # Data manager resource details from request body.}\n@returns(200) Data Manager Resource object.\n@returns(202) Accepted request for create/update.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}\n@desc Deletes a data manager resource in Microsoft Azure.\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(202) Data Manager Resource deleted.\n@returns(204) Data Manager Resource deleted.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}\n@desc Updates the properties of an existing data manager resource.\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only, dataManagerUpdateParameter: map # Data manager resource details from request body.}\n@optional {If-Match: any # Defines the If-Match condition. The patch will be performed only if the ETag of the data manager resource on the server matches this value.}\n@returns(200) Data Manager Resource object.\n@returns(202) Data Manager Resource updated.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices\n@desc This method gets all the data services.\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) The list of data services.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}\n@desc Gets the data service that match the data service name given.\n@required {dataServiceName: any # The name of the data service that is being queried., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) The data service that matches the name.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions\n@desc This method gets all the job definitions of the given data service name.\n@required {dataServiceName: any # The data service type of interest., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@optional {$filter: any # OData Filter options}\n@returns(200) The list of job definitions of the given data service type.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}\n@desc This method gets job definition object by name.\n@required {dataServiceName: any # The data service name of the job definition, jobDefinitionName: any # The job definition name that is being queried., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) The job definition that matches the criteria.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}\n@desc Creates or updates a job definition.\n@required {dataServiceName: any # The data service type of the job definition., jobDefinitionName: any # The job definition name to be created or updated., jobDefinition: map # Job Definition object to be created or updated., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) JobDefinition object.\n@returns(202) Accepted request for create/update.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}\n@desc This method deletes the given job definition.\n@required {dataServiceName: any # The data service type of the job definition., jobDefinitionName: any # The job definition name to be deleted., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(202) Accepted request for JobDefinition deletion.\n@returns(204) JobDefinition deleted.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs\n@desc This method gets all the jobs of a given job definition.\n@required {dataServiceName: any # The name of the data service of the job definition., jobDefinitionName: any # The name of the job definition for which jobs are needed., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@optional {$filter: any # OData Filter options}\n@returns(200) The list of jobs.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}\n@desc This method gets a data manager job given the jobId.\n@required {dataServiceName: any # The name of the data service of the job definition., jobDefinitionName: any # The name of the job definition of the job., jobId: any # The job id of the job queried., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@optional {$expand: any # $expand is supported on details parameter for job, which provides details on the job stages.}\n@returns(200) The job that matches the given criteria.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/cancel\n@desc Cancels the given job.\n@required {dataServiceName: any # The name of the data service of the job definition., jobDefinitionName: any # The name of the job definition of the job., jobId: any # The job id of the job queried., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(202) Accepted job cancellation request.\n@returns(204) Job cancelled.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/jobs/{jobId}/resume\n@desc Resumes the given job.\n@required {dataServiceName: any # The name of the data service of the job definition., jobDefinitionName: any # The name of the job definition of the job., jobId: any # The job id of the job queried., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(202) Accepted job resume request.\n@returns(204) Job resumed.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobDefinitions/{jobDefinitionName}/run\n@desc This method runs a job instance of the given job definition.\n@required {dataServiceName: any # The data service type of the job definition., jobDefinitionName: any # Name of the job definition., runParameters: map # Run time parameters for the job definition., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(202) Job run accepted.\n@returns(204) Job run started.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataServices/{dataServiceName}/jobs\n@desc This method gets all the jobs of a data service type in a given resource.\n@required {dataServiceName: any # The name of the data service of interest., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@optional {$filter: any # OData Filter options}\n@returns(200) The list of jobs that match the service and resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores\n@desc Gets all the data stores/repositories in the given resource.\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@optional {$filter: any # OData Filter options}\n@returns(200) The list of data stores/repositories in the given resource.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores/{dataStoreName}\n@desc This method gets the data store/repository by name.\n@required {dataStoreName: any # The data store/repository name queried., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) The data store/repository which matches the name given.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores/{dataStoreName}\n@desc Creates or updates the data store/repository in the data manager.\n@required {dataStoreName: any # The data store/repository name to be created or updated., dataStore: map # The data store/repository object to be created or updated., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) The data store/repository object.\n@returns(202) Accepted request for create/update.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStores/{dataStoreName}\n@desc This method deletes the given data store/repository.\n@required {dataStoreName: any # The data store/repository name to be deleted., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(202) Accepted request for DataStore deletion.\n@returns(204) DataStore deleted.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStoreTypes\n@desc Gets all the data store/repository types that the resource supports.\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) The list of data store types that are supported.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/dataStoreTypes/{dataStoreTypeName}\n@desc Gets the data store/repository type given its name.\n@required {dataStoreTypeName: any # The data store/repository type name for which details are needed., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) The data store/repository type.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/jobDefinitions\n@desc This method gets all the job definitions of the given data manager resource.\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@optional {$filter: any # OData Filter options}\n@returns(200) The list of job definitions in that resource.OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/jobs\n@desc This method gets all the jobs at the data manager resource level.\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@optional {$filter: any # OData Filter options}\n@returns(200) The list of jobs in the resource specified.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/publicKeys\n@desc This method gets the list view of public keys, however it will only have one element.\n@required {resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) The list of public keys.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridData/dataManagers/{dataManagerName}/publicKeys/{publicKeyName}\n@desc This method gets the public keys.\n@required {publicKeyName: any # Name of the public key., resourceGroupName: any # The Resource Group Name, dataManagerName: any # The name of the DataManager Resource within the specified resource group. DataManager names must be between 3 and 24 characters in length and use any alphanumeric and underscore only}\n@returns(200) The public keys.\n\n@endgroup\n\n@end\n"}