openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 18 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":"2018-06-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/2018-06-01-preview/PrivateEndpointConnections.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-PrivateEndpointConnections","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateEndpointConnections":{"get":{"description":"Gets all private endpoint connections on a server.","operationId":"PrivateEndpointConnections_ListByServer","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved private endpoint connections.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateEndpointConnectionListResult"},"examples":{"Gets list of private endpoint connections on a server.":{"$ref":"#/components/examples/Gets_list_of_private_endpoint_connections_on_a_server."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 PrivateEndpointConnectionDoesNotExist - Private Endpoint Connection does not exist\n\n * 400 PrivateEndpointConnectionStatusNotPending - Private Endpoint Connection Status is not Pending\n\n * 400 NullRemotePrivateLinkServiceConnectionState - Remote Private Link Service Connection State is Null\n\n * 400 NullPrivateEndpointConnectionProperties - Private Endpoint Connection Properties is Null\n\n * 400 NullRemotePrivateLinkServiceConnectionStateStatus - Remote Private Link Service Connection State Status is Null\n\n * 400 IncorrectPrivateLinkServiceConnectionStateStatus - Private Link Service Connection State Status must be \"Approved\" or \"Rejected\"\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["PrivateEndpointConnections"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/privateEndpointConnections/{privateEndpointConnectionName}":{"delete":{"description":"Deletes a private endpoint connection with a given name.","operationId":"PrivateEndpointConnections_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"in":"path","name":"privateEndpointConnectionName","required":true,"schema":{"type":"string"},"examples":{"Deletes a private endpoint connection with a given name.":{"value":"private-endpoint-connection-name"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted private endpoint connection."},"202":{"description":"Accepted"},"204":{"description":"Private endpoint connection does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 400 PrivateEndpointConnectionDoesNotExist - Private Endpoint Connection does not exist\n\n * 400 PrivateEndpointConnectionStatusNotPending - Private Endpoint Connection Status is not Pending\n\n * 400 NullRemotePrivateLinkServiceConnectionState - Remote Private Link Service Connection State is Null\n\n * 400 NullPrivateEndpointConnectionProperties - Private Endpoint Connection Properties is Null\n\n * 400 NullRemotePrivateLinkServiceConnectionStateStatus - Remote Private Link Service Connection State Status is Null\n\n * 400 IncorrectPrivateLinkServiceConnectionStateStatus - Private Link Service Connection State Status must be \"Approved\" or \"Rejected\"\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation."}},"tags":["PrivateEndpointConnections"],"x-ms-long-running-operation":true},"get":{"description":"Gets a private endpoint connection.","operationId":"PrivateEndpointConnections_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the private endpoint connection.","in":"path","name":"privateEndpointConnectionName","required":true,"schema":{"type":"string"},"examples":{"Gets private endpoint connection.":{"value":"private-endpoint-connection-name"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved a specified private endpoint connection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateEndpointConnection"},"examples":{"Gets private endpoint connection.":{"$ref":"#/components/examples/Gets_private_endpoint_connection."}}}}},"default":{"description":"*** Error Responses: ***\n\n * 400 PrivateEndpointConnectionDoesNotExist - Private Endpoint Connection does not exist\n\n * 400 PrivateEndpointConnectionStatusNotPending - Private Endpoint Connection Status is not Pending\n\n * 400 NullRemotePrivateLinkServiceConnectionState - Remote Private Link Service Connection State is Null\n\n * 400 NullPrivateEndpointConnectionProperties - Private Endpoint Connection Properties is Null\n\n * 400 NullRemotePrivateLinkServiceConnectionStateStatus - Remote Private Link Service Connection State Status is Null\n\n * 400 IncorrectPrivateLinkServiceConnectionStateStatus - Private Link Service Connection State Status must be \"Approved\" or \"Rejected\"\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["PrivateEndpointConnections"]},"put":{"description":"Approve or reject a private endpoint connection with a given name.","operationId":"PrivateEndpointConnections_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"in":"path","name":"privateEndpointConnectionName","required":true,"schema":{"type":"string"},"examples":{"Approve or reject a private endpoint connection with a given name.":{"value":"private-endpoint-connection-name"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateEndpointConnection"}}},"required":true},"responses":{"200":{"description":"Successfully approved or rejected private endpoint connection.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateEndpointConnection"},"examples":{"Approve or reject a private endpoint connection with a given name.":{"$ref":"#/components/examples/Approve_or_reject_a_private_endpoint_connection_with_a_given_name."}}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 PrivateEndpointConnectionDoesNotExist - Private Endpoint Connection does not exist\n\n * 400 PrivateEndpointConnectionStatusNotPending - Private Endpoint Connection Status is not Pending\n\n * 400 NullRemotePrivateLinkServiceConnectionState - Remote Private Link Service Connection State is Null\n\n * 400 NullPrivateEndpointConnectionProperties - Private Endpoint Connection Properties is Null\n\n * 400 NullRemotePrivateLinkServiceConnectionStateStatus - Remote Private Link Service Connection State Status is Null\n\n * 400 IncorrectPrivateLinkServiceConnectionStateStatus - Private Link Service Connection State Status must be \"Approved\" or \"Rejected\"\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation."}},"tags":["PrivateEndpointConnections"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Gets_list_of_private_endpoint_connections_on_a_server.":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name-2","name":"private-endpoint-connection-name","properties":{"privateEndpoint":{"id":"/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"},"privateLinkServiceConnectionState":{"actionsRequired":"None","description":"Auto-approved","status":"Approved"},"provisioningState":"Ready"},"type":"Microsoft.Sql/servers/privateEndpointConnections"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name-2","name":"private-endpoint-connection-name-2","properties":{"privateEndpoint":{"id":"/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name-2"},"privateLinkServiceConnectionState":{"actionsRequired":"None","description":"Auto-approved","status":"Approved"},"provisioningState":"Ready"},"type":"Microsoft.Sql/servers/privateEndpointConnections"}]}},"Gets_private_endpoint_connection.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name","name":"private-endpoint-connection-name","properties":{"privateEndpoint":{"id":"/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"},"privateLinkServiceConnectionState":{"actionsRequired":"None","description":"Auto-approved","status":"Approved"},"provisioningState":"Ready"},"type":"Microsoft.Sql/servers/privateEndpointConnections"}},"Approve_or_reject_a_private_endpoint_connection_with_a_given_name.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/test-svr/privateEndpointConnections/private-endpoint-connection-name","name":"private-endpoint-connection-name","properties":{"privateEndpoint":{"id":"/subscriptions/55555555-6666-7777-8888-999999999999/resourceGroups/Default-Network/providers/Microsoft.Network/privateEndpoints/private-endpoint-name"},"privateLinkServiceConnectionState":{"actionsRequired":"None","description":"Approved by johndoe@contoso.com","status":"Approved"},"provisioningState":"Ready"},"type":"Microsoft.Sql/servers/privateEndpointConnections"}}},"parameters":{"ApiVersionParameter":{"description":"The API version to use for the request.","in":"query","name":"api-version","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Gets list of private endpoint connections on a server.":{"value":"2018-06-01-preview"},"Deletes a private endpoint connection with a given name.":{"value":"2018-06-01-preview"},"Gets private endpoint connection.":{"value":"2018-06-01-preview"},"Approve or reject a private endpoint connection with a given name.":{"value":"2018-06-01-preview"}}},"BlobAuditingPolicyNameParameter":{"description":"The name of the blob auditing policy.","in":"path","name":"blobAuditingPolicyName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","enum":["default"]}},"DatabaseNameParameter":{"description":"The name of the database.","in":"path","name":"databaseName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ManagedInstanceNameParameter":{"description":"The name of the managed instance.","in":"path","name":"managedInstanceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"ResourceGroupParameter":{"description":"The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Gets list of private endpoint connections on a server.":{"value":"Default"},"Deletes a private endpoint connection with a given name.":{"value":"Default"},"Gets private endpoint connection.":{"value":"Default"},"Approve or reject a private endpoint connection with a given name.":{"value":"Default"}}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Gets list of private endpoint connections on a server.":{"value":"test-svr"},"Deletes a private endpoint connection with a given name.":{"value":"test-svr"},"Gets private endpoint connection.":{"value":"test-svr"},"Approve or reject a private endpoint connection with a given name.":{"value":"test-svr"}}},"SqlVirtualMachineContainerNameParameter":{"description":"The name of the SqlVirtualMachineContainer.","in":"path","name":"sqlVirtualMachineContainerName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SqlVirtualMachineInstanceNameParameter":{"description":"The name of the SqlVirtualMachineInstance.","in":"path","name":"sqlVirtualMachineInstanceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},"SubscriptionIdParameter":{"description":"The subscription ID that identifies an Azure subscription.","in":"path","name":"subscriptionId","required":true,"x-ms-parameter-location":"client","schema":{"type":"string"},"examples":{"Gets list of private endpoint connections on a server.":{"value":"00000000-1111-2222-3333-444444444444"},"Deletes a private endpoint connection with a given name.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets private endpoint connection.":{"value":"00000000-1111-2222-3333-444444444444"},"Approve or reject a private endpoint connection with a given name.":{"value":"00000000-1111-2222-3333-444444444444"}}},"VirtualClusterNameParameter":{"description":"The name of the virtual cluster.","in":"path","name":"virtualClusterName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"PrivateEndpointConnection":{"allOf":[{"$ref":"#/components/schemas/ProxyResource"}],"description":"A private endpoint connection","properties":{"properties":{"$ref":"#/components/schemas/PrivateEndpointConnectionProperties"}},"type":"object"},"PrivateEndpointConnectionListResult":{"description":"A list of private endpoint connections.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/PrivateEndpointConnection"},"readOnly":true,"type":"array"}},"type":"object"},"PrivateEndpointConnectionProperties":{"description":"Properties of a private endpoint connection.","properties":{"privateEndpoint":{"$ref":"#/components/schemas/PrivateEndpointProperty"},"privateLinkServiceConnectionState":{"$ref":"#/components/schemas/PrivateLinkServiceConnectionStateProperty"},"provisioningState":{"description":"State of the private endpoint connection.","readOnly":true,"type":"string"}},"type":"object"},"PrivateEndpointProperty":{"properties":{"id":{"description":"Resource id of the private endpoint.","type":"string"}},"type":"object","x-ms-azure-resource":true},"PrivateLinkServiceConnectionStateProperty":{"properties":{"actionsRequired":{"description":"The actions required for private link service connection.","readOnly":true,"type":"string"},"description":{"description":"The private link service connection description.","type":"string"},"status":{"description":"The private link service connection status.","type":"string"}},"required":["status","description"],"type":"object"},"ProxyResource":{"allOf":[{"$ref":"#/components/schemas/Resource"}],"description":"ARM proxy resource.","properties":{},"type":"object"},"Resource":{"description":"ARM resource.","properties":{"id":{"description":"Resource ID.","readOnly":true,"type":"string"},"name":{"description":"Resource name.","readOnly":true,"type":"string"},"type":{"description":"Resource type.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}}}}