5.0.0 • Published 5 years ago
@datafire/azure_sql_servers v5.0.0
@datafire/azure_sql_servers
Client library for SqlManagementClient
Installation and Usage
npm install --save @datafire/azure_sql_servers
let azure_sql_servers = require('@datafire/azure_sql_servers').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
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.
Actions
Servers_List
Gets a list of all servers in the subscription.
azure_sql_servers.Servers_List({
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- subscriptionId required
string
: The subscription ID that identifies an Azure subscription. - api-version required
string
: The API version to use for the request.
- subscriptionId required
Output
- output ServerListResult
Servers_ListByResourceGroup
Gets a list of servers in a resource groups.
azure_sql_servers.Servers_ListByResourceGroup({
"resourceGroupName": "",
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. - subscriptionId required
string
: The subscription ID that identifies an Azure subscription. - api-version required
string
: The API version to use for the request.
- resourceGroupName required
Output
- output ServerListResult
Servers_Delete
Deletes a server.
azure_sql_servers.Servers_Delete({
"resourceGroupName": "",
"serverName": "",
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. - serverName required
string
: The name of the server. - subscriptionId required
string
: The subscription ID that identifies an Azure subscription. - api-version required
string
: The API version to use for the request.
- resourceGroupName required
Output
Output schema unknown
Servers_Get
Gets a server.
azure_sql_servers.Servers_Get({
"resourceGroupName": "",
"serverName": "",
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. - serverName required
string
: The name of the server. - subscriptionId required
string
: The subscription ID that identifies an Azure subscription. - api-version required
string
: The API version to use for the request.
- resourceGroupName required
Output
- output Server
Servers_Update
Updates a server.
azure_sql_servers.Servers_Update({
"resourceGroupName": "",
"serverName": "",
"parameters": {},
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. - serverName required
string
: The name of the server. - parameters required ServerUpdate
- subscriptionId required
string
: The subscription ID that identifies an Azure subscription. - api-version required
string
: The API version to use for the request.
- resourceGroupName required
Output
- output Server
Servers_CreateOrUpdate
Creates or updates a server.
azure_sql_servers.Servers_CreateOrUpdate({
"resourceGroupName": "",
"serverName": "",
"parameters": {
"location": ""
},
"subscriptionId": "",
"api-version": ""
}, context)
Input
- input
object
- resourceGroupName required
string
: The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal. - serverName required
string
: The name of the server. - parameters required Server
- subscriptionId required
string
: The subscription ID that identifies an Azure subscription. - api-version required
string
: The API version to use for the request.
- resourceGroupName required
Output
- output Server
Definitions
Server
- Server
object
: An Azure SQL Database server.- identity
object
: Azure Active Directory identity configuration for a resource.- principalId
string
: The Azure Active Directory principal id. - tenantId
string
: The Azure Active Directory tenant id. - type
string
(values: SystemAssigned): The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource.
- principalId
- kind
string
: Kind of sql server. This is metadata used for the Azure portal experience. - properties ServerProperties
- location required
string
: Resource location. - tags
object
: Resource tags. - id
string
: Resource ID. - name
string
: Resource name. - type
string
: Resource type.
- identity
ServerListResult
- ServerListResult
object
: A list of servers.- nextLink
string
: Link to retrieve next page of results. - value
array
: Array of results.- items Server
- nextLink
ServerProperties
- ServerProperties
object
: The properties of a server.- administratorLogin
string
: Administrator username for the server. Once created it cannot be changed. - administratorLoginPassword
string
: The administrator login password (required for server creation). - fullyQualifiedDomainName
string
: The fully qualified domain name of the server. - state
string
: The state of the server. - version
string
: The version of the server.
- administratorLogin
ServerUpdate
- ServerUpdate
object
: An update request for an Azure SQL Database server.- properties ServerProperties
- tags
object
: Resource tags.