{ "swagger": "2.0", "info": { "title": "SqlManagementClient", "version": "2025-01-01", "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.", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "host": "management.azure.com", "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "azure_auth": [ "user_impersonation" ] } ], "securityDefinitions": { "azure_auth": { "type": "oauth2", "description": "Azure Active Directory OAuth2 Flow.", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "scopes": { "user_impersonation": "impersonate your user account" } } }, "tags": [ { "name": "JobPrivateEndpoints" } ], "paths": { "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/privateEndpoints": { "get": { "operationId": "JobPrivateEndpoints_ListByAgent", "tags": [ "JobPrivateEndpoints" ], "description": "Gets a list of job agent private endpoints.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "jobAgentName", "in": "path", "description": "The name of the job agent to be retrieved.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobPrivateEndpointListResult" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "List private endpoints in a job agent": { "$ref": "./examples/ListJobPrivateEndpointsByAgent.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/privateEndpoints/{privateEndpointName}": { "get": { "operationId": "JobPrivateEndpoints_Get", "tags": [ "JobPrivateEndpoints" ], "description": "Gets a private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "jobAgentName", "in": "path", "description": "The name of the job agent to be retrieved.", "required": true, "type": "string" }, { "name": "privateEndpointName", "in": "path", "description": "The name of the private endpoint to get.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Azure operation completed successfully.", "schema": { "$ref": "#/definitions/JobPrivateEndpoint" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Get a private endpoint.": { "$ref": "./examples/GetJobPrivateEndpoint.json" } } }, "put": { "operationId": "JobPrivateEndpoints_CreateOrUpdate", "tags": [ "JobPrivateEndpoints" ], "description": "Creates or updates a private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "jobAgentName", "in": "path", "description": "The name of the job agent to be retrieved.", "required": true, "type": "string" }, { "name": "privateEndpointName", "in": "path", "description": "The name of the private endpoint to get.", "required": true, "type": "string" }, { "name": "parameters", "in": "body", "description": "The requested private endpoint state.", "required": true, "schema": { "$ref": "#/definitions/JobPrivateEndpoint" } } ], "responses": { "200": { "description": "Resource 'JobPrivateEndpoint' update operation succeeded", "schema": { "$ref": "#/definitions/JobPrivateEndpoint" } }, "201": { "description": "Resource 'JobPrivateEndpoint' create operation succeeded", "schema": { "$ref": "#/definitions/JobPrivateEndpoint" }, "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "202": { "description": "Resource operation accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Create a private endpoint.": { "$ref": "./examples/CreateOrUpdateJobPrivateEndpoint.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location", "final-state-schema": "#/definitions/JobPrivateEndpoint" }, "x-ms-long-running-operation": true }, "delete": { "operationId": "JobPrivateEndpoints_Delete", "tags": [ "JobPrivateEndpoints" ], "description": "Deletes a private endpoint.", "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "serverName", "in": "path", "description": "The name of the server.", "required": true, "type": "string" }, { "name": "jobAgentName", "in": "path", "description": "The name of the job agent to be retrieved.", "required": true, "type": "string" }, { "name": "privateEndpointName", "in": "path", "description": "The name of the private endpoint to get.", "required": true, "type": "string" } ], "responses": { "200": { "description": "Resource deleted successfully." }, "202": { "description": "Resource deletion accepted.", "headers": { "Location": { "type": "string", "description": "The Location header contains the URL where the status of the long running operation can be checked." }, "Retry-After": { "type": "integer", "format": "int32", "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." } } }, "204": { "description": "Resource does not exist." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse" } } }, "x-ms-examples": { "Delete a private endpoint": { "$ref": "./examples/DeleteJobPrivateEndpoint.json" } }, "x-ms-long-running-operation-options": { "final-state-via": "location" }, "x-ms-long-running-operation": true } } }, "definitions": { "JobPrivateEndpoint": { "type": "object", "description": "A job agent private endpoint.", "properties": { "properties": { "$ref": "#/definitions/JobPrivateEndpointProperties", "description": "Resource properties.", "x-ms-client-flatten": true } }, "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource" } ] }, "JobPrivateEndpointListResult": { "type": "object", "description": "The response of a JobPrivateEndpoint list operation.", "properties": { "value": { "type": "array", "description": "The JobPrivateEndpoint items on this page", "items": { "$ref": "#/definitions/JobPrivateEndpoint" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "JobPrivateEndpointProperties": { "type": "object", "description": "Properties of job agent private endpoint.", "properties": { "targetServerAzureResourceId": { "type": "string", "format": "arm-id", "description": "ARM resource id of the server the private endpoint will target.", "x-ms-arm-id-details": { "allowedResources": [ { "type": "Microsoft.Sql/servers" } ] } }, "privateEndpointId": { "type": "string", "description": "Private endpoint id of the private endpoint.", "readOnly": true } }, "required": [ "targetServerAzureResourceId" ] } }, "parameters": {} }