openapi-directory/api/azure.com/mysql-PrivateEndpointConnections.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.","title":"MySQLManagementClient","version":"2018-06-01-privatepreview","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/mysql/resource-manager/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"mysql-PrivateEndpointConnections","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/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 response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["PrivateEndpointConnections"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/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 response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"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 response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["PrivateEndpointConnections"]},"patch":{"description":"Updates private endpoint connection with the specified tags.","operationId":"PrivateEndpointConnections_UpdateTags","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"in":"path","name":"privateEndpointConnectionName","required":true,"schema":{"type":"string"},"examples":{"Update private endpoint connection Tags":{"value":"private-endpoint-connection-name"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagsObject"}}},"description":"Parameters supplied to the Update private endpoint connection Tags operation.","required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateEndpointConnection"},"examples":{"Update private endpoint connection Tags":{"$ref":"#/components/examples/Update_private_endpoint_connection_Tags"}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"summary":"Updates tags on private endpoint connection.","tags":["PrivateEndpointConnections"],"x-ms-long-running-operation":true},"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 response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"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.DBforMySQL/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.DBforMySQL/servers/privateEndpointConnections"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DBforMySQL/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.DBforMySQL/servers/privateEndpointConnections"}]}},"Gets_private_endpoint_connection.":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DBforMySQL/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.DBforMySQL/servers/privateEndpointConnections"}},"Update_private_endpoint_connection_Tags":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DBforMySQL/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.DBforMySQL/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.DBforMySQL/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.DBforMySQL/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-privatepreview"},"Deletes a private endpoint connection with a given name.":{"value":"2018-06-01-privatepreview"},"Gets private endpoint connection.":{"value":"2018-06-01-privatepreview"},"Update private endpoint connection Tags":{"value":"2018-06-01-privatepreview"},"Approve or reject a private endpoint connection with a given name.":{"value":"2018-06-01-privatepreview"}}},"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"},"Update private endpoint connection Tags":{"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"},"Update private endpoint connection Tags":{"value":"test-svr"},"Approve or reject a private endpoint connection with a given name.":{"value":"test-svr"}}},"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"},"Update private endpoint connection Tags":{"value":"00000000-1111-2222-3333-444444444444"},"Approve or reject a private endpoint connection with a given name.":{"value":"00000000-1111-2222-3333-444444444444"}}}},"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":{"CloudError":{"description":"An error response from the Batch service.","properties":{"error":{"$ref":"#/components/schemas/CloudErrorBody"}},"x-ms-external":true},"CloudErrorBody":{"description":"An error response from the Batch service.","properties":{"code":{"description":"An identifier for the error. Codes are invariant and are intended to be consumed programmatically.","type":"string"},"details":{"description":"A list of additional details about the error.","items":{"$ref":"#/components/schemas/CloudErrorBody"},"type":"array"},"message":{"description":"A message describing the error, intended to be suitable for display in a user interface.","type":"string"},"target":{"description":"The target of the particular error. For example, the name of the property in error.","type":"string"}},"x-ms-external":true},"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},"TagsObject":{"description":"Tags object for patch operations.","properties":{"tags":{"additionalProperties":{"type":"string"},"description":"Resource tags.","type":"object"}}}}}}