openapi-directory/api/azure.com/sql-serverDnsAliases.json

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

{"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/serverDnsAliases.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"sql-serverDnsAliases","x-tags":["Azure","Microsoft"]},"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases":{"get":{"description":"Gets a list of server DNS aliases for a server.","operationId":"ServerDnsAliases_ListByServer","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server that the alias is pointing to.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"List server DNS aliases":{"value":"dns-alias-server"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the list of server DNS aliases.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerDnsAliasListResult"},"examples":{"List server DNS aliases":{"$ref":"#/components/examples/List_server_DNS_aliases"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["ServerDnsAliases"],"x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}":{"delete":{"description":"Deletes the server DNS alias with the given name.","operationId":"ServerDnsAliases_Delete","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server that the alias is pointing to.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Delete server DNS alias":{"value":"dns-alias-server"}}},{"description":"The name of the server DNS alias.","in":"path","name":"dnsAliasName","required":true,"schema":{"type":"string"},"examples":{"Delete server DNS alias":{"value":"dns-alias-name-1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully deleted the server DNS alias."},"202":{"description":"Accepted"},"204":{"description":"The specified server DNS alias does not exist."},"default":{"description":"*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["ServerDnsAliases"],"x-ms-long-running-operation":true},"get":{"description":"Gets a server DNS alias.","operationId":"ServerDnsAliases_Get","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server that the alias is pointing to.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Get server DNS alias":{"value":"dns-alias-server"}}},{"description":"The name of the server DNS alias.","in":"path","name":"dnsAliasName","required":true,"schema":{"type":"string"},"examples":{"Get server DNS alias":{"value":"dns-alias-name-1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"Successfully retrieved the specified server DNS alias.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerDnsAlias"},"examples":{"Get server DNS alias":{"$ref":"#/components/examples/Get_server_DNS_alias"}}}}},"default":{"description":"*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found."}},"tags":["ServerDnsAliases"]},"put":{"description":"Creates a server dns alias.","operationId":"ServerDnsAliases_CreateOrUpdate","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server that the alias is pointing to.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Create server DNS alias":{"value":"dns-alias-server"}}},{"description":"The name of the server DNS alias.","in":"path","name":"dnsAliasName","required":true,"schema":{"type":"string"},"examples":{"Create server DNS alias":{"value":"dns-alias-name-1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"The server DNS alias already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerDnsAlias"},"examples":{"Create server DNS alias":{"$ref":"#/components/examples/Create_server_DNS_alias"}}}}},"201":{"description":"Successfully created a server DNS alias.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerDnsAlias"},"examples":{"Create server DNS alias":{"$ref":"#/components/examples/Create_server_DNS_alias"}}}}},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidServerDnsAliasAcquireRequest - The acquire server DNS alias request body is empty or invalid (it should contain the old server alias id, for example: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1).\n\n * 400 ServerDnsAliasAcquireRequestInvalidOldServerDnsAliasId - \n\n * 400 UnableToResolveRemoteServer - \n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 ServerDnsAliasAlreadyExists - \n\n * 409 ServerDnsAliasAlreadyExists - \n\n * 409 ServerDnsAliasBusy - \n\n * 409 ServerDnsAliasDnsRecordInUse - \n\n * 409 InvalidServerDnsAliasName - \n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["ServerDnsAliases"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/dnsAliases/{dnsAliasName}/acquire":{"post":{"description":"Acquires server DNS alias from another server.","operationId":"ServerDnsAliases_Acquire","parameters":[{"$ref":"#/components/parameters/ResourceGroupParameter"},{"description":"The name of the server that the alias is pointing to.","in":"path","name":"serverName","required":true,"schema":{"type":"string"},"examples":{"Acquire server DNS alias":{"value":"dns-alias-new-server"}}},{"description":"The name of the server dns alias.","in":"path","name":"dnsAliasName","required":true,"schema":{"type":"string"},"examples":{"Acquire server DNS alias":{"value":"dns-alias-name-1"}}},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/ApiVersionParameter"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServerDnsAliasAcquisition"}}},"required":true},"responses":{"200":{"description":"Successfully acquired server DNS alias."},"202":{"description":"Accepted"},"default":{"description":"*** Error Responses: ***\n\n * 400 InvalidServerDnsAliasAcquireRequest - The acquire server DNS alias request body is empty or invalid (it should contain the old server alias id, for example: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-old-server/dnsAliases/dns-alias-name-1).\n\n * 400 ServerDnsAliasAcquireRequestInvalidOldServerDnsAliasId - \n\n * 400 UnableToResolveRemoteServer - \n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\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 * 409 ServerDnsAliasAlreadyExists - \n\n * 409 ServerDnsAliasAlreadyExists - \n\n * 409 ServerDnsAliasBusy - \n\n * 409 ServerDnsAliasDnsRecordInUse - \n\n * 409 InvalidServerDnsAliasName - \n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 ConflictingServerOperation - An operation is currently in progress for the server.\n\n * 429 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout."}},"tags":["ServerDnsAliases"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_server_DNS_aliases":{"value":{"value":[{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-server/dnsAliases/dns-alias-1","name":"server-dns-alias-1","properties":{"azureDnsRecord":"dns-alias-1.database.windows.net"},"type":"Microsoft.Sql/servers/dnsAliases"},{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-server/dnsAliases/dns-alias-2","name":"server-dns-alias-2","properties":{"azureDnsRecord":"dns-alias-2.database.windows.net"},"type":"Microsoft.Sql/servers/dnsAliases"}]}},"Get_server_DNS_alias":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-server/dnsAliases/dns-alias-name-1","name":"dns-alias-name-1","properties":{"azureDnsRecord":"dns-alias-name-1.database.windows.net"},"type":"Microsoft.Sql/servers/dnsAliases"}},"Create_server_DNS_alias":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-server/dnsAliases/dns-alias-name-1","name":"dns-alias-name-1","properties":{"azureDnsRecord":"dns-alias-name-1.database.windows.net"},"type":"Microsoft.Sql/servers/dnsAliases"}},"Acquire_server_DNS_alias":{"value":{"id":"/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default/providers/Microsoft.Sql/servers/dns-alias-new-server/dnsAliases/dns-alias-name-1","name":"server-dns-alias-name-1","properties":{"azureDnsRecord":"dns-alias-name-1.database.windows.net"},"type":"Microsoft.Sql/servers/dnsAliases"}}},"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":{"List server DNS aliases":{"value":"2017-03-01-preview"},"Delete server DNS alias":{"value":"2017-03-01-preview"},"Get server DNS alias":{"value":"2017-03-01-preview"},"Create server DNS alias":{"value":"2017-03-01-preview"},"Acquire server DNS alias":{"value":"2017-03-01-preview"}}},"DatabaseNameParameter":{"description":"The name of the database.","in":"path","name":"databaseName","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":{"List server DNS aliases":{"value":"Default"},"Delete server DNS alias":{"value":"Default"},"Get server DNS alias":{"value":"Default"},"Create server DNS alias":{"value":"Default"},"Acquire server DNS alias":{"value":"Default"}}},"ServerNameParameter":{"description":"The name of the server.","in":"path","name":"serverName","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":{"List server DNS aliases":{"value":"00000000-1111-2222-3333-444444444444"},"Delete server DNS alias":{"value":"00000000-1111-2222-3333-444444444444"},"Get server DNS alias":{"value":"00000000-1111-2222-3333-444444444444"},"Create server DNS alias":{"value":"00000000-1111-2222-3333-444444444444"},"Acquire server DNS alias":{"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":{"ServerDnsAlias":{"allOf":[{"allOf":[{"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}],"description":"ARM proxy resource.","properties":{},"type":"object"}],"description":"A server DNS alias.","properties":{"properties":{"$ref":"#/components/schemas/ServerDnsAliasProperties"}},"type":"object"},"ServerDnsAliasAcquisition":{"description":"A server DNS alias acquisition request.","properties":{"oldServerDnsAliasId":{"description":"The id of the server alias that will be acquired to point to this server instead.","type":"string"}},"type":"object"},"ServerDnsAliasListResult":{"description":"A list of server DNS aliases.","properties":{"nextLink":{"description":"Link to retrieve next page of results.","readOnly":true,"type":"string"},"value":{"description":"Array of results.","items":{"$ref":"#/components/schemas/ServerDnsAlias"},"readOnly":true,"type":"array"}},"type":"object"},"ServerDnsAliasProperties":{"description":"Properties of a server DNS alias.","properties":{"azureDnsRecord":{"description":"The fully qualified DNS record for alias","readOnly":true,"type":"string"}},"type":"object"}}}}