{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-sql-jobs","description":"SqlManagementClient","version":"2017-03-01-preview","base_url":"https://management.azure.com","endpoints":36,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api SqlManagementClient\n@base https://management.azure.com\n@version 2017-03-01-preview\n@auth OAuth2\n@common_fields {resourceGroupName: any # The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal., serverName: any # The name of the server., subscriptionId: any # The subscription ID that identifies an Azure subscription., api-version: any # The API version to use for the request., jobAgentName: any # The name of the job agent to be retrieved.}\n@endpoints 36\n@hint download_for_search\n@toc subscriptions(36)\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents\n@desc Gets a list of job agents in a server.\n@returns(200) Successfully retrieved the list of job agents.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}\n@desc Gets a job agent.\n@returns(200) Successfully retrieved the specified job agent.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}\n@desc Creates or updates a job agent.\n@required {parameters: map # The requested job agent resource state.}\n@returns(200) Successfully updated the job agent.\n@returns(201) Successfully created the job agent.\n@returns(202) Accepted\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}\n@desc Deletes a job agent.\n@returns(200) Successfully deleted the job agent.\n@returns(202) Accepted\n@returns(204) The specified job agent does not exist.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}\n@desc Updates a job agent.\n@required {parameters: map # The update to the job agent.}\n@returns(200) Successfully updated the job agent.\n@returns(202) Accepted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials\n@desc Gets a list of jobs credentials.\n@returns(200) Successfully retrieved the list of job credentials.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials/{credentialName}\n@desc Gets a jobs credential.\n@required {credentialName: any # The name of the credential.}\n@returns(200) Successfully retrieved the job credential.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials/{credentialName}\n@desc Creates or updates a job credential.\n@required {credentialName: any # The name of the credential., parameters: map # The requested job credential state.}\n@returns(200) Successfully updated the credential.\n@returns(201) Successfully created the credential.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials/{credentialName}\n@desc Deletes a job credential.\n@required {credentialName: any # The name of the credential.}\n@returns(200) Successfully deleted the credential.\n@returns(204) A credential with the specified name does not exist.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions\n@desc Lists all executions in a job agent.\n@optional {createTimeMin: any # If specified, only job executions created at or after the specified time are included., createTimeMax: any # If specified, only job executions created before the specified time are included., endTimeMin: any # If specified, only job executions completed at or after the specified time are included., endTimeMax: any # If specified, only job executions completed before the specified time are included., isActive: any # If specified, only active or only completed job executions are included., $skip: any # The number of elements in the collection to skip., $top: any # The number of elements to return from the collection.}\n@returns(200) Successfully retrieved job executions.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/cancel\n@desc Requests cancellation of a job execution.\n@required {jobName: any # The name of the job., jobExecutionId: any # The id of the job execution to cancel.}\n@returns(200) Successfully requested cancellation of the job execution.\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/start\n@desc Starts an elastic job execution.\n@required {jobName: any # The name of the job to get.}\n@returns(200) Successfully started an execution for the job.\n@returns(202) Accepted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions\n@desc Lists a job's executions.\n@required {jobName: any # The name of the job to get.}\n@optional {createTimeMin: any # If specified, only job executions created at or after the specified time are included., createTimeMax: any # If specified, only job executions created before the specified time are included., endTimeMin: any # If specified, only job executions completed at or after the specified time are included., endTimeMax: any # If specified, only job executions completed before the specified time are included., isActive: any # If specified, only active or only completed job executions are included., $skip: any # The number of elements in the collection to skip., $top: any # The number of elements to return from the collection.}\n@returns(200) Successfully retrieved job executions.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}\n@desc Gets a job execution.\n@required {jobName: any # The name of the job., jobExecutionId: any # The id of the job execution}\n@returns(200) Successfully retrieved the job.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}\n@desc Creates or updates a job execution.\n@required {jobName: any # The name of the job to get., jobExecutionId: any # The job execution id to create the job execution under.}\n@returns(200) A job execution for the job with the given id already existed.\n@returns(201) Successfully started an execution for the job.\n@returns(202) Accepted\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs\n@desc Gets a list of jobs.\n@returns(200) Successfully retrieved the list of jobs.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}\n@desc Gets a job.\n@required {jobName: any # The name of the job to get.}\n@returns(200) Successfully retrieved the job.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}\n@desc Creates or updates a job.\n@required {jobName: any # The name of the job to get., parameters: map # The requested job state.}\n@returns(200) Successfully updated the job.\n@returns(201) Successfully created the job.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}\n@desc Deletes a job.\n@required {jobName: any # The name of the job to delete.}\n@returns(200) Successfully deleted the job.\n@returns(204) The specified job does not exist.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps\n@desc Lists the step executions of a job execution.\n@required {jobName: any # The name of the job to get., jobExecutionId: any # The id of the job execution}\n@optional {createTimeMin: any # If specified, only job executions created at or after the specified time are included., createTimeMax: any # If specified, only job executions created before the specified time are included., endTimeMin: any # If specified, only job executions completed at or after the specified time are included., endTimeMax: any # If specified, only job executions completed before the specified time are included., isActive: any # If specified, only active or only completed job executions are included., $skip: any # The number of elements in the collection to skip., $top: any # The number of elements to return from the collection.}\n@returns(200) Successfully retrieved the step executions.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}\n@desc Gets a step execution of a job execution.\n@required {jobName: any # The name of the job to get., jobExecutionId: any # The unique id of the job execution, stepName: any # The name of the step.}\n@returns(200) Successfully retrieved the step execution.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions/{jobVersion}/steps\n@desc Gets all job steps in the specified job version.\n@required {jobName: any # The name of the job to get., jobVersion: any # The version of the job to get.}\n@returns(200) Successfully retrieved the list of job steps.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions/{jobVersion}/steps/{stepName}\n@desc Gets the specified version of a job step.\n@required {jobName: any # The name of the job., jobVersion: any # The version of the job to get., stepName: any # The name of the job step.}\n@returns(200) Successfully retrieved the job step.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps\n@desc Gets all job steps for a job's current version.\n@required {jobName: any # The name of the job to get.}\n@returns(200) Successfully retrieved the list of job steps.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}\n@desc Gets a job step in a job's current version.\n@required {jobName: any # The name of the job., stepName: any # The name of the job step.}\n@returns(200) Successfully retrieved the job step.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}\n@desc Creates or updates a job step. This will implicitly create a new job version.\n@required {jobName: any # The name of the job., stepName: any # The name of the job step., parameters: map # The requested state of the job step.}\n@returns(200) Successfully updated the job step.\n@returns(201) Successfully added the job step.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}\n@desc Deletes a job step. This will implicitly create a new job version.\n@required {jobName: any # The name of the job., stepName: any # The name of the job step to delete.}\n@returns(200) Successfully deleted the job step.\n@returns(204) The specified job step does not exist.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/targets\n@desc Lists target executions for all steps of a job execution.\n@required {jobName: any # The name of the job to get., jobExecutionId: any # The id of the job execution}\n@optional {createTimeMin: any # If specified, only job executions created at or after the specified time are included., createTimeMax: any # If specified, only job executions created before the specified time are included., endTimeMin: any # If specified, only job executions completed at or after the specified time are included., endTimeMax: any # If specified, only job executions completed before the specified time are included., isActive: any # If specified, only active or only completed job executions are included., $skip: any # The number of elements in the collection to skip., $top: any # The number of elements to return from the collection.}\n@returns(200) Successfully retrieved the target executions.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets\n@desc Lists the target executions of a job step execution.\n@required {jobName: any # The name of the job to get., jobExecutionId: any # The id of the job execution, stepName: any # The name of the step.}\n@optional {createTimeMin: any # If specified, only job executions created at or after the specified time are included., createTimeMax: any # If specified, only job executions created before the specified time are included., endTimeMin: any # If specified, only job executions completed at or after the specified time are included., endTimeMax: any # If specified, only job executions completed before the specified time are included., isActive: any # If specified, only active or only completed job executions are included., $skip: any # The number of elements in the collection to skip., $top: any # The number of elements to return from the collection.}\n@returns(200) Successfully retrieved the target executions.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets/{targetId}\n@desc Gets a target execution.\n@required {jobName: any # The name of the job to get., jobExecutionId: any # The unique id of the job execution, stepName: any # The name of the step., targetId: any # The target id.}\n@returns(200) Successfully retrieved the target execution.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups\n@desc Gets all target groups in an agent.\n@returns(200) Successfully retrieved the list of target groups.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}\n@desc Gets a target group.\n@required {targetGroupName: any # The name of the target group.}\n@returns(200) Successfully retrieved the target group.\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}\n@desc Creates or updates a target group.\n@required {targetGroupName: any # The name of the target group., parameters: map # The requested state of the target group.}\n@returns(200) Successfully updated the target group.\n@returns(201) Successfully created the target group.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/targetGroups/{targetGroupName}\n@desc Deletes a target group.\n@required {targetGroupName: any # The name of the target group.}\n@returns(200) Successfully deleted the target group.\n@returns(204) A target group with the specified name does not exist.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions\n@desc Gets all versions of a job.\n@required {jobName: any # The name of the job to get.}\n@returns(200) Successfully retrieved the list of versions.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/versions/{jobVersion}\n@desc Gets a job version.\n@required {jobName: any # The name of the job., jobVersion: any # The version of the job to get.}\n@returns(200) Successfully retrieved the job version.\n\n@end\n"}