openapi-directory/api/azure.com/postgresql-PrivateLinkResources.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 PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files and configurations with new business model.","title":"PostgreSQLManagementClient","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/postgresql/resource-manager/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"postgresql-PrivateLinkResources","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/privateLinkResources":{"get":{"description":"Gets the private link resources for PostgreSQL server.","operationId":"PrivateLinkResources_ListByServer","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved private link resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateLinkResourceListResult"},"examples":{"Gets private link resources for PostgreSQL.":{"$ref":"#/components/examples/Gets_private_link_resources_for_PostgreSQL."}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["PrivateLinkResources"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/privateLinkResources/{groupName}":{"get":{"description":"Gets a private link resource for PostgreSQL server.","operationId":"PrivateLinkResources_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"$ref":"#/components/parameters/ServerNameParameter"},{"description":"The name of the private link resource.","in":"path","name":"groupName","required":true,"schema":{"type":"string"},"examples":{"Gets a private link resource for PostgreSQL.":{"value":"plr"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved private link resources.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrivateLinkResource"},"examples":{"Gets a private link resource for PostgreSQL.":{"$ref":"#/components/examples/Gets_a_private_link_resource_for_PostgreSQL."}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloudError"}}}}},"tags":["PrivateLinkResources"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"Gets_private_link_resources_for_PostgreSQL.":{"value":{"value":[{"id":"subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/servers/test-svr/privateLinkResources/plr","name":"plr","properties":{"groupId":"postgresqlServer","requiredMembers":["postgresqlServer"]},"type":"Microsoft.DBforPostgreSQL/servers/privateLinkResources"}]}},"Gets_a_private_link_resource_for_PostgreSQL.":{"value":{"id":"subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.DBforPostgreSQL/servers/test-svr/privateLinkResources/plr","name":"plr","properties":{"groupId":"postgresqlServer","requiredMembers":["postgresqlServer"]},"type":"Microsoft.DBforPostgreSQL/servers/privateLinkResources"}}},"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 private link resources for PostgreSQL.":{"value":"2018-06-01-privatepreview"},"Gets a private link resource for PostgreSQL.":{"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 private link resources for PostgreSQL.":{"value":"Default"},"Gets a private link resource for PostgreSQL.":{"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 private link resources for PostgreSQL.":{"value":"test-svr"},"Gets a private link resource for PostgreSQL.":{"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 private link resources for PostgreSQL.":{"value":"00000000-1111-2222-3333-444444444444"},"Gets a private link resource for PostgreSQL.":{"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},"PrivateLinkResource":{"allOf":[{"$ref":"#/components/schemas/ProxyResource"}],"description":"A private link resource","properties":{"properties":{"$ref":"#/components/schemas/PrivateLinkResourceProperties"}},"type":"object"},"PrivateLinkResourceListResult":{"description":"A list of private link resources","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/PrivateLinkResource"},"readOnly":true,"type":"array"}},"type":"object"},"PrivateLinkResourceProperties":{"description":"Properties of a private link resource.","properties":{"groupId":{"description":"The private link resource group id.","readOnly":true,"type":"string"},"requiredMembers":{"description":"The private link resource required member names.","items":{"type":"string"},"readOnly":true,"type":"array"}},"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}}}}