openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 130 kB
JSON
{"openapi":"3.0.0","info":{"description":"The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities.","title":"SqlManagementClient","version":"2017-03-01-preview","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/sql/resource-manager/Microsoft.Sql/preview/2017-03-01-preview/jobs.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-jobs","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents":{"get":{"description":"Gets a list of job agents in a server.","operationId":"JobAgents_ListByServer","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of job agents.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAgentListResult"},"examples":{"List job agents in a server":{"$ref":"#/components/examples/List_job_agents_in_a_server"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobAgents"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}":{"delete":{"description":"Deletes a job agent.","operationId":"JobAgents_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent to be deleted.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Delete a job agent":{"value":"agent1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the job agent."},"202":{"description":"Accepted"},"204":{"description":"The specified job agent does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server."}},"tags":["JobAgents"],"x-ms-long-running-operation":true},"get":{"description":"Gets a job agent.","operationId":"JobAgents_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent to be retrieved.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Get a job agent":{"value":"agent1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specified job agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAgent"},"examples":{"Get a job agent":{"$ref":"#/components/examples/Get_a_job_agent"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server."}},"tags":["JobAgents"]},"patch":{"description":"Updates a job agent.","operationId":"JobAgents_Update","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent to be updated.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Update a job agent's tags.":{"value":"agent1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAgentUpdate"}}},"description":"The update to the job agent.","required":true},"responses":{"200":{"description":"Successfully updated the job agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAgent"},"examples":{"Update a job agent's tags.":{"$ref":"#/components/examples/Update_a_job_agent_s_tags."}}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 PropertyChangeUnsupported - Property cannot be modified."}},"tags":["JobAgents"],"x-ms-long-running-operation":true},"put":{"description":"Creates or updates a job agent.","operationId":"JobAgents_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent to be created or updated.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Create or update a job agent with all properties":{"value":"agent1"},"Create or update a job agent with minimum properties":{"value":"agent1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAgent"}}},"description":"The requested job agent resource state.","required":true},"responses":{"200":{"description":"Successfully updated the job agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAgent"},"examples":{"Create or update a job agent with all properties":{"$ref":"#/components/examples/Create_or_update_a_job_agent_with_all_properties"},"Create or update a job agent with minimum properties":{"$ref":"#/components/examples/Create_or_update_a_job_agent_with_minimum_properties"}}}}},"201":{"description":"Successfully created the job agent.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAgent"},"examples":{"Create or update a job agent with all properties":{"$ref":"#/components/examples/Create_or_update_a_job_agent_with_all_properties"},"Create or update a job agent with minimum properties":{"$ref":"#/components/examples/Create_or_update_a_job_agent_with_minimum_properties"}}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 MissingSkuName - Sku name is required.\n\n * 400 InvalidDatabaseResourceId - Invalid database resource identifier.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 DatabaseDoesNotExist - The requested database was not found\n\n * 400 JobAgentExceededQuota - Could not create job agent because it would exceed the quota.\n\n * 400 JobAgentAlreadyExists - The job agent already exists on the server.\n\n * 400 JobAgentDatabaseEditionUnsupported - The specified database's service level objective is not supported for use as a job agent database.\n\n * 400 JobAgentDatabaseSecondary - A job agent cannot be linked to a geo-secondary database.\n\n * 400 JobAgentDatabaseAlreadyLinked - The specified database is already linked to another job agent.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 SubscriptionNotFound - The requested subscription was not found.\n\n * 404 PropertyChangeUnsupported - Property cannot be modified."}},"tags":["JobAgents"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials":{"get":{"description":"Gets a list of jobs credentials.","operationId":"JobCredentials_ListByAgent","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"List credentials in a job agent":{"value":"agent1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of job credentials.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCredentialListResult"},"examples":{"List credentials in a job agent":{"$ref":"#/components/examples/List_credentials_in_a_job_agent"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobCredentials"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/credentials/{credentialName}":{"delete":{"description":"Deletes a job credential.","operationId":"JobCredentials_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Delete a credential":{"value":"agent1"}}},{"description":"The name of the credential.","in":"path","name":"credentialName","required":true,"schema":{"type":"string"},"examples":{"Delete a credential":{"value":"cred1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the credential."},"204":{"description":"A credential with the specified name does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 403 JobCredentialPermissionError - Azure Resource Manager does not have permission to use or manage the credential.\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["JobCredentials"]},"get":{"description":"Gets a jobs credential.","operationId":"JobCredentials_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Get a credential":{"value":"agent1"}}},{"description":"The name of the credential.","in":"path","name":"credentialName","required":true,"schema":{"type":"string"},"examples":{"Get a credential":{"value":"cred1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the job credential.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCredential"},"examples":{"Get a credential":{"$ref":"#/components/examples/Get_a_credential"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["JobCredentials"]},"put":{"description":"Creates or updates a job credential.","operationId":"JobCredentials_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Create or update a credential":{"value":"agent1"}}},{"description":"The name of the credential.","in":"path","name":"credentialName","required":true,"schema":{"type":"string"},"examples":{"Create or update a credential":{"value":"cred1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCredential"}}},"description":"The requested job credential state.","required":true},"responses":{"200":{"description":"Successfully updated the credential.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCredential"},"examples":{"Create or update a credential":{"$ref":"#/components/examples/Create_or_update_a_credential"}}}}},"201":{"description":"Successfully created the credential.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobCredential"},"examples":{"Create or update a credential":{"$ref":"#/components/examples/Create_or_update_a_credential"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidJobCredentialUsername - Invalid credential username.\n\n * 403 JobCredentialPermissionError - Azure Resource Manager does not have permission to use or manage the credential.\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobCredentials"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/executions":{"get":{"description":"Lists all executions in a job agent.","operationId":"JobExecutions_ListByAgent","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"List all job executions in a job agent with filtering.":{"value":"agent1"},"List all job executions in a job agent.":{"value":"agent1"}}},{"description":"If specified, only job executions created at or after the specified time are included.","in":"query","name":"createTimeMin","required":false,"schema":{"type":"string","format":"date-time"},"examples":{"List all job executions in a job agent with filtering.":{"value":"2017-03-21T19:00:00.0000000Z"}}},{"description":"If specified, only job executions created before the specified time are included.","in":"query","name":"createTimeMax","required":false,"schema":{"type":"string","format":"date-time"},"examples":{"List all job executions in a job agent with filtering.":{"value":"2017-03-21T19:05:00.0000000Z"}}},{"description":"If specified, only job executions completed at or after the specified time are included.","in":"query","name":"endTimeMin","required":false,"schema":{"type":"string","format":"date-time"},"examples":{"List all job executions in a job agent with filtering.":{"value":"2017-03-21T19:20:00.0000000Z"}}},{"description":"If specified, only job executions completed before the specified time are included.","in":"query","name":"endTimeMax","required":false,"schema":{"type":"string","format":"date-time"},"examples":{"List all job executions in a job agent with filtering.":{"value":"2017-03-21T19:25:00.0000000Z"}}},{"description":"If specified, only active or only completed job executions are included.","in":"query","name":"isActive","required":false,"schema":{"type":"boolean"},"examples":{"List all job executions in a job agent with filtering.":{"value":false}}},{"description":"The number of elements in the collection to skip.","in":"query","name":"$skip","required":false,"schema":{"type":"integer"}},{"description":"The number of elements to return from the collection.","in":"query","name":"$top","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved job executions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecutionListResult"},"examples":{"List all job executions in a job agent with filtering.":{"$ref":"#/components/examples/List_all_job_executions_in_a_job_agent_with_filtering."},"List all job executions in a job agent.":{"$ref":"#/components/examples/List_all_job_executions_in_a_job_agent."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobExecutions"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs":{"get":{"description":"Gets a list of jobs.","operationId":"Jobs_ListByAgent","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"List jobs in a job agent":{"value":"agent1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of jobs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobListResult"},"examples":{"List jobs in a job agent":{"$ref":"#/components/examples/List_jobs_in_a_job_agent"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["Jobs"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}":{"delete":{"description":"Deletes a job.","operationId":"Jobs_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Delete a job":{"value":"agent1"}}},{"description":"The name of the job to delete.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Delete a job":{"value":"job1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the job."},"204":{"description":"The specified job does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["Jobs"]},"get":{"description":"Gets a job.","operationId":"Jobs_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Get a job":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Get a job":{"value":"job1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"},"examples":{"Get a job":{"$ref":"#/components/examples/Get_a_job"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["Jobs"]},"put":{"description":"Creates or updates a job.","operationId":"Jobs_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Create a job with all properties specified":{"value":"agent1"},"Create a job with default properties":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Create a job with all properties specified":{"value":"job1"},"Create a job with default properties":{"value":"job1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}},"description":"The requested job state.","required":true},"responses":{"200":{"description":"Successfully updated the job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"},"examples":{"Create a job with all properties specified":{"$ref":"#/components/examples/Create_a_job_with_all_properties_specified"},"Create a job with default properties":{"$ref":"#/components/examples/Create_a_job_with_default_properties"}}}}},"201":{"description":"Successfully created the job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"},"examples":{"Create a job with all properties specified":{"$ref":"#/components/examples/Create_a_job_with_all_properties_specified"},"Create a job with default properties":{"$ref":"#/components/examples/Create_a_job_with_default_properties"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 400 InvalidResourceRequestBody - The resource or resource properties in the request body is empty or invalid.\n\n * 400 InvalidDuration - Invalid duration.\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["Jobs"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions":{"get":{"description":"Lists a job's executions.","operationId":"JobExecutions_ListByJob","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"List a job's executions.":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"List a job's executions.":{"value":"job1"}}},{"description":"If specified, only job executions created at or after the specified time are included.","in":"query","name":"createTimeMin","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions created before the specified time are included.","in":"query","name":"createTimeMax","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions completed at or after the specified time are included.","in":"query","name":"endTimeMin","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions completed before the specified time are included.","in":"query","name":"endTimeMax","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only active or only completed job executions are included.","in":"query","name":"isActive","required":false,"schema":{"type":"boolean"}},{"description":"The number of elements in the collection to skip.","in":"query","name":"$skip","required":false,"schema":{"type":"integer"}},{"description":"The number of elements to return from the collection.","in":"query","name":"$top","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved job executions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecutionListResult"},"examples":{"List a job's executions.":{"$ref":"#/components/examples/List_a_job_s_executions."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobExecutions"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}":{"get":{"description":"Gets a job execution.","operationId":"JobExecutions_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Get a job execution.":{"value":"agent1"}}},{"description":"The name of the job.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Get a job execution.":{"value":"job1"}}},{"description":"The id of the job execution","in":"path","name":"jobExecutionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Get a job execution.":{"value":"5555-6666-7777-8888-999999999999"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecution"},"examples":{"Get a job execution.":{"$ref":"#/components/examples/Get_a_job_execution."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobExecutions"]},"put":{"description":"Creates or updates a job execution.","operationId":"JobExecutions_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Create job execution.":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Create job execution.":{"value":"job1"}}},{"description":"The job execution id to create the job execution under.","in":"path","name":"jobExecutionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Create job execution.":{"value":"5555-6666-7777-8888-999999999999"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"A job execution for the job with the given id already existed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecution"},"examples":{"Create job execution.":{"$ref":"#/components/examples/Create_job_execution."}}}}},"201":{"description":"Successfully started an execution for the job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecution"},"examples":{"Create job execution.":{"$ref":"#/components/examples/Create_job_execution."}}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobExecutions"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/cancel":{"post":{"description":"Requests cancellation of a job execution.","operationId":"JobExecutions_Cancel","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Cancel a job execution.":{"value":"agent1"}}},{"description":"The name of the job.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Cancel a job execution.":{"value":"job1"}}},{"description":"The id of the job execution to cancel.","in":"path","name":"jobExecutionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Cancel a job execution.":{"value":"5555-6666-7777-8888-999999999999"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully requested cancellation of the job execution."},"default":{"description":"*** Error Responses: ***\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["JobExecutions"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps":{"get":{"description":"Lists the step executions of a job execution.","operationId":"JobStepExecutions_ListByJobExecution","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"List job step executions":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"List job step executions":{"value":"job1"}}},{"description":"The id of the job execution","in":"path","name":"jobExecutionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"List job step executions":{"value":"5555-6666-7777-8888-999999999999"}}},{"description":"If specified, only job executions created at or after the specified time are included.","in":"query","name":"createTimeMin","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions created before the specified time are included.","in":"query","name":"createTimeMax","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions completed at or after the specified time are included.","in":"query","name":"endTimeMin","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions completed before the specified time are included.","in":"query","name":"endTimeMax","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only active or only completed job executions are included.","in":"query","name":"isActive","required":false,"schema":{"type":"boolean"}},{"description":"The number of elements in the collection to skip.","in":"query","name":"$skip","required":false,"schema":{"type":"integer"}},{"description":"The number of elements to return from the collection.","in":"query","name":"$top","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the step executions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecutionListResult"},"examples":{"List job step executions":{"$ref":"#/components/examples/List_job_step_executions"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobStepExecutions"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}":{"get":{"description":"Gets a step execution of a job execution.","operationId":"JobStepExecutions_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Get a job step execution":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Get a job step execution":{"value":"job1"}}},{"description":"The unique id of the job execution","in":"path","name":"jobExecutionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Get a job step execution":{"value":"5555-6666-7777-8888-999999999999"}}},{"description":"The name of the step.","in":"path","name":"stepName","required":true,"schema":{"type":"string"},"examples":{"Get a job step execution":{"value":"step1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the step execution.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecution"},"examples":{"Get a job step execution":{"$ref":"#/components/examples/Get_a_job_step_execution"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["JobStepExecutions"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets":{"get":{"description":"Lists the target executions of a job step execution.","operationId":"JobTargetExecutions_ListByStep","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"List job step target executions":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"List job step target executions":{"value":"job1"}}},{"description":"The id of the job execution","in":"path","name":"jobExecutionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"List job step target executions":{"value":"5555-6666-7777-8888-999999999999"}}},{"description":"The name of the step.","in":"path","name":"stepName","required":true,"schema":{"type":"string"},"examples":{"List job step target executions":{"value":"step1"}}},{"description":"If specified, only job executions created at or after the specified time are included.","in":"query","name":"createTimeMin","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions created before the specified time are included.","in":"query","name":"createTimeMax","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions completed at or after the specified time are included.","in":"query","name":"endTimeMin","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions completed before the specified time are included.","in":"query","name":"endTimeMax","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only active or only completed job executions are included.","in":"query","name":"isActive","required":false,"schema":{"type":"boolean"}},{"description":"The number of elements in the collection to skip.","in":"query","name":"$skip","required":false,"schema":{"type":"integer"}},{"description":"The number of elements to return from the collection.","in":"query","name":"$top","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the target executions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecutionListResult"},"examples":{"List job step target executions":{"$ref":"#/components/examples/List_job_step_target_executions"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobTargetExecutions"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/steps/{stepName}/targets/{targetId}":{"get":{"description":"Gets a target execution.","operationId":"JobTargetExecutions_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Get a job step target execution":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Get a job step target execution":{"value":"job1"}}},{"description":"The unique id of the job execution","in":"path","name":"jobExecutionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Get a job step target execution":{"value":"5555-6666-7777-8888-999999999999"}}},{"description":"The name of the step.","in":"path","name":"stepName","required":true,"schema":{"type":"string"},"examples":{"Get a job step target execution":{"value":"step1"}}},{"description":"The target id.","in":"path","name":"targetId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"Get a job step target execution":{"value":"aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the target execution.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecution"},"examples":{"Get a job step target execution":{"$ref":"#/components/examples/Get_a_job_step_target_execution"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["JobTargetExecutions"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/executions/{jobExecutionId}/targets":{"get":{"description":"Lists target executions for all steps of a job execution.","operationId":"JobTargetExecutions_ListByJobExecution","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"List job step target executions":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"List job step target executions":{"value":"job1"}}},{"description":"The id of the job execution","in":"path","name":"jobExecutionId","required":true,"schema":{"type":"string","format":"uuid"},"examples":{"List job step target executions":{"value":"5555-6666-7777-8888-999999999999"}}},{"description":"If specified, only job executions created at or after the specified time are included.","in":"query","name":"createTimeMin","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions created before the specified time are included.","in":"query","name":"createTimeMax","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions completed at or after the specified time are included.","in":"query","name":"endTimeMin","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only job executions completed before the specified time are included.","in":"query","name":"endTimeMax","required":false,"schema":{"type":"string","format":"date-time"}},{"description":"If specified, only active or only completed job executions are included.","in":"query","name":"isActive","required":false,"schema":{"type":"boolean"}},{"description":"The number of elements in the collection to skip.","in":"query","name":"$skip","required":false,"schema":{"type":"integer"}},{"description":"The number of elements to return from the collection.","in":"query","name":"$top","required":false,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the target executions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecutionListResult"},"examples":{"List job step target executions":{"$ref":"#/components/examples/List_job_step_target_executions"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobTargetExecutions"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/start":{"post":{"description":"Starts an elastic job execution.","operationId":"JobExecutions_Create","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Start a job execution.":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Start a job execution.":{"value":"job1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully started an execution for the job.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobExecution"},"examples":{"Start a job execution.":{"$ref":"#/components/examples/Start_a_job_execution."}}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 400 ElasticJobsOperationFailed - Elastic jobs management operation failed.\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["JobExecutions"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps":{"get":{"description":"Gets all job steps for a job's current version.","operationId":"JobSteps_ListByJob","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"List job steps for the latest version of a job.":{"value":"agent1"}}},{"description":"The name of the job to get.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"List job steps for the latest version of a job.":{"value":"job1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of job steps.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobStepListResult"},"examples":{"List job steps for the latest version of a job.":{"$ref":"#/components/examples/List_job_steps_for_the_latest_version_of_a_job."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 JobAgentNotFound - Specified job agent does not exist in the specified logical server.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found"}},"tags":["JobSteps"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/jobs/{jobName}/steps/{stepName}":{"delete":{"description":"Deletes a job step. This will implicitly create a new job version.","operationId":"JobSteps_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the job agent.","in":"path","name":"jobAgentName","required":true,"schema":{"type":"string"},"examples":{"Delete a job step.":{"value":"agent1"}}},{"description":"The name of the job.","in":"path","name":"jobName","required":true,"schema":{"type":"string"},"examples":{"Delete a job step.":{"value":"job1"}}},{"description":"The name of the job step to delete.","in":"path","name":"stepName","required":true,"schema":{"type":"string"},"examples":{"Delete a job step.":{"value":"step1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"resp