@datafire/azure_postgresql

Client library for PostgreSQLManagementClient

Installation and Usage

``bash
npm install --save @datafire/azure_postgresql
`
`js
let azure_postgresql = require('@datafire/azure_postgresql').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});

.then(data => {
console.log(data);
});
`

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.

Actions

$3

Lists all of the available REST API operations.


`js
azure_postgresql.Operations_List({
"api-version": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.

#### Output
* output OperationListResult

$3

Check the availability of name for resource


`js
azure_postgresql.CheckNameAvailability_Execute({
"api-version": "",
"subscriptionId": "",
"nameAvailabilityRequest": null
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* nameAvailabilityRequest required NameAvailabilityRequest

#### Output
* output NameAvailability

$3

List all the performance tiers at specified location in a given subscription.


`js
azure_postgresql.LocationBasedPerformanceTier_List({
"api-version": "",
"subscriptionId": "",
"locationName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* locationName required string: The name of the location.

#### Output
* output PerformanceTierListResult

$3

List all the servers in a given subscription.


`js
azure_postgresql.Servers_List({
"api-version": "",
"subscriptionId": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.

#### Output
* output ServerListResult

$3

List all the servers in a given resource group.


`js
azure_postgresql.Servers_ListByResourceGroup({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output ServerListResult

$3

Deletes a server.


`js
azure_postgresql.Servers_Delete({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
Output schema unknown

$3

Gets information about a server.


`js
azure_postgresql.Servers_Get({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output Server

$3

Updates an existing server. The request body can contain one to many of the properties present in the normal server definition.


`js
azure_postgresql.Servers_Update({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"parameters": null
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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 ServerUpdateParameters

#### Output
* output Server

$3

Creates a new server, or will overwrite an existing server.


`js
azure_postgresql.Servers_Create({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"parameters": null
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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 ServerForCreate

#### Output
* output Server

$3

Deletes AAD Administrator.


`js
azure_postgresql.ServerAdministrators_Delete({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output ServerAdministratorResource

$3

Gets information about a AAD server administrator.


`js
azure_postgresql.ServerAdministrators_Get({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output ServerAdministratorResource

$3

Creates or update active directory administrator on an existing server. The update action will overwrite the existing administrator.


`js
azure_postgresql.ServerAdministrators_CreateOrUpdate({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"properties": null
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.
* properties required ServerAdministratorResource

#### Output
* output ServerAdministratorResource

$3

List all the replicas for a given server.


`js
azure_postgresql.Replicas_ListByServer({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output ServerListResult

$3

Returns a list of server Administrators.


`js
azure_postgresql.ServerAdministrators_ListByServer({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output ServerAdministratorResourceListResult

$3

List all the configurations in a given server.


`js
azure_postgresql.Configurations_ListByServer({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output ConfigurationListResult

$3

Gets information about a configuration of server.


`js
azure_postgresql.Configurations_Get({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"configurationName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.
* configurationName required string: The name of the server configuration.

#### Output
* output Configuration

$3

Updates a configuration of a server.


`js
azure_postgresql.Configurations_CreateOrUpdate({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"configurationName": "",
"parameters": null
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.
* configurationName required string: The name of the server configuration.
* parameters required Configuration

#### Output
* output Configuration

$3

List all the databases in a given server.


`js
azure_postgresql.Databases_ListByServer({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output DatabaseListResult

$3

Deletes a database.


`js
azure_postgresql.Databases_Delete({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"databaseName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.
* databaseName required string: The name of the database.

#### Output
Output schema unknown

$3

Gets information about a database.


`js
azure_postgresql.Databases_Get({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"databaseName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.
* databaseName required string: The name of the database.

#### Output
* output Database

$3

Creates a new database or updates an existing database.


`js
azure_postgresql.Databases_CreateOrUpdate({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"databaseName": "",
"parameters": null
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.
* databaseName required string: The name of the database.
* parameters required Database

#### Output
* output Database

$3

List all the firewall rules in a given server.


`js
azure_postgresql.FirewallRules_ListByServer({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output FirewallRuleListResult

$3

Deletes a server firewall rule.


`js
azure_postgresql.FirewallRules_Delete({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"firewallRuleName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.
* firewallRuleName required string: The name of the server firewall rule.

#### Output
Output schema unknown

$3

Gets information about a server firewall rule.


`js
azure_postgresql.FirewallRules_Get({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"firewallRuleName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.
* firewallRuleName required string: The name of the server firewall rule.

#### Output
* output FirewallRule

$3

Creates a new firewall rule or updates an existing firewall rule.


`js
azure_postgresql.FirewallRules_CreateOrUpdate({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": "",
"firewallRuleName": "",
"parameters": null
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.
* firewallRuleName required string: The name of the server firewall rule.
* parameters required FirewallRule

#### Output
* output FirewallRule

$3

List all the log files in a given server.


`js
azure_postgresql.LogFiles_ListByServer({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
* output LogFileListResult

$3

Restarts a server.


`js
azure_postgresql.Servers_Restart({
"api-version": "",
"subscriptionId": "",
"resourceGroupName": "",
"serverName": ""
}, context)
`

#### Input
* input object
* api-version required string: The API version to use for the request.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* 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.

#### Output
Output schema unknown

$3

Get a server's security alert policy.


`js
azure_postgresql.ServerSecurityAlertPolicies_Get({
"resourceGroupName": "",
"serverName": "",
"securityAlertPolicyName": "",
"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.
* securityAlertPolicyName required string (values: Default): The name of the security alert policy.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* api-version required string: The API version to use for the request.

#### Output
* output ServerSecurityAlertPolicy

$3

Creates or updates a threat detection policy.


`js
azure_postgresql.ServerSecurityAlertPolicies_CreateOrUpdate({
"resourceGroupName": "",
"serverName": "",
"securityAlertPolicyName": "",
"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.
* securityAlertPolicyName required string (values: Default): The name of the threat detection policy.
* parameters required ServerSecurityAlertPolicy
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* api-version required string: The API version to use for the request.

#### Output
* output ServerSecurityAlertPolicy

$3

Gets a list of virtual network rules in a server.


`js
azure_postgresql.VirtualNetworkRules_ListByServer({
"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.

#### Output
* output VirtualNetworkRuleListResult

$3

Deletes the virtual network rule with the given name.


`js
azure_postgresql.VirtualNetworkRules_Delete({
"resourceGroupName": "",
"serverName": "",
"virtualNetworkRuleName": "",
"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.
* virtualNetworkRuleName required string: The name of the virtual network rule.
* subscriptionId required string: The subscription ID that identifies an Azure subscription.
* api-version required string: The API version to use for the request.

#### Output
Output schema unknown

$3

Gets a virtual network rule.


`js
azure_postgresql.VirtualNetworkRules_Get({
"resourceGroupName": "",
"serverName": "",
"subscriptionId": "",
"api-version": "",
"virtualNetworkRuleName": ""
}, 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.
* virtualNetworkRuleName required string: The name of the virtual network rule.

#### Output
* output VirtualNetworkRule

$3

Creates or updates an existing virtual network rule.


`js
azure_postgresql.VirtualNetworkRules_CreateOrUpdate({
"resourceGroupName": "",
"serverName": "",
"subscriptionId": "",
"api-version": "",
"virtualNetworkRuleName": "",
"parameters": {}
}, 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.
* virtualNetworkRuleName required string: The name of the virtual network rule.
* parameters required VirtualNetworkRule

#### Output
* output VirtualNetworkRule

Definitions

$3


* CloudError object: An error response from the Batch service.
* error CloudErrorBody

$3

* CloudErrorBody object: An error response from the Batch service.
* code string: An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
* details array: A list of additional details about the error.
* items CloudErrorBody
* message string: A message describing the error, intended to be suitable for display in a user interface.
* target string: The target of the particular error. For example, the name of the property in error.

$3

* Configuration object: Represents a Configuration.
* properties ConfigurationProperties
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* ConfigurationListResult object: A list of server configurations.
* value array: The list of server configurations.
* items Configuration

$3

* ConfigurationProperties object: The properties of a configuration.
* allowedValues string: Allowed values of the configuration.
* dataType string: Data type of the configuration.
* defaultValue string: Default value of the configuration.
* description string: Description of the configuration.
* source string: Source of the configuration.
* value string: Value of the configuration.

$3

* Database object: Represents a Database.
* properties DatabaseProperties
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* DatabaseListResult object: A List of databases.
* value array: The list of databases housed in a server
* items Database

$3

* DatabaseProperties object: The properties of a database.
* charset string: The charset of the database.
* collation string: The collation of the database.

$3

* FirewallRule object: Represents a server firewall rule.
* properties required FirewallRuleProperties
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* FirewallRuleListResult object: A list of firewall rules.
* value array: The list of firewall rules in a server.
* items FirewallRule

$3

* FirewallRuleProperties object: The properties of a server firewall rule.
* endIpAddress required string: The end IP address of the server firewall rule. Must be IPv4 format.
* startIpAddress required string: The start IP address of the server firewall rule. Must be IPv4 format.

$3

* LogFile object: Represents a log file.
* name string: The name of the log file.
* properties LogFileProperties
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* LogFileListResult object: A list of log files.
* value array: The list of log files.
* items LogFile

$3

* LogFileProperties object: The properties of a log file.
* createdTime string: Creation timestamp of the log file.
* lastModifiedTime string: Last modified timestamp of the log file.
* sizeInKB integer: Size of the log file.
* type string: Type of the log file.
* url string: The url to download the log file from.

$3

* NameAvailability object: Represents a resource name availability.
* message string: Error Message.
* nameAvailable boolean: Indicates whether the resource name is available.
* reason string: Reason for name being unavailable.

$3

* NameAvailabilityRequest object: Request from client to check resource name availability.
* name required string: Resource name to verify.
* type string: Resource type used for verification.

$3

* Operation object: REST API operation definition.
* display OperationDisplay
* name string: The name of the operation being performed on this particular object.
* origin string (values: NotSpecified, user, system): The intended executor of the operation.
* properties object: Additional descriptions for the operation.

$3

* OperationDisplay object: Display metadata associated with the operation.
* description string: Operation description.
* operation string: Localized friendly name for the operation.
* provider string: Operation resource provider name.
* resource string: Resource on which the operation is performed.

$3

* OperationListResult object: A list of resource provider operations.
* value array: The list of resource provider operations.
* items Operation

$3

* PerformanceTierListResult object: A list of performance tiers.
* value array: The list of performance tiers
* items PerformanceTierProperties

$3

* PerformanceTierProperties object: Performance tier properties
* id string: ID of the performance tier.
* serviceLevelObjectives array: Service level objectives associated with the performance tier
* items PerformanceTierServiceLevelObjectives

$3

* PerformanceTierServiceLevelObjectives object: Service level objectives for performance tier.
* edition string: Edition of the performance tier.
* hardwareGeneration string: Hardware generation associated with the service level objective
* id string: ID for the service level objective.
* maxBackupRetentionDays integer: Maximum Backup retention in days for the performance tier edition
* maxStorageMB integer: Max storage allowed for a server.
* minBackupRetentionDays integer: Minimum Backup retention in days for the performance tier edition
* minStorageMB integer: Max storage allowed for a server.
* vCore integer: vCore associated with the service level objective

$3

* ProxyResource object: Resource properties.
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* ResourceIdentity 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.

$3

* SecurityAlertPolicyProperties object: Properties of a security alert policy.
* disabledAlerts array: Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly
* items string
* emailAccountAdmins boolean: Specifies that the alert is sent to the account administrators.
* emailAddresses array: Specifies an array of e-mail addresses to which the alert is sent.
* items string
* retentionDays integer: Specifies the number of days to keep in the Threat Detection audit logs.
* state required string (values: Enabled, Disabled): Specifies the state of the policy, whether it is enabled or disabled.
* storageAccountAccessKey string: Specifies the identifier key of the Threat Detection audit storage account.
* storageEndpoint string: Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

$3

* Server object: Represents a server.
* identity ResourceIdentity
* properties ServerProperties
* sku Sku
* location required string: The location the resource resides in.
* tags object: Application-specific metadata in the form of key-value pairs.
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* ServerAdministratorProperties object: The properties of an server Administrator.
* administratorType required string (values: ActiveDirectory): The type of administrator.
* login required string: The server administrator login value.
* sid required string: The server administrator Sid (Secure ID).
* tenantId required string: The server Active Directory Administrator tenant id.

$3

* ServerAdministratorResource object: Represents a and external administrator to be created.
* properties ServerAdministratorProperties
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* ServerAdministratorResourceListResult object: The response to a list Active Directory Administrators request.
* value array: The list of server Active Directory Administrators for the server.
* items ServerAdministratorResource

$3

* ServerForCreate object: Represents a server to be created.
* location required string: The location the resource resides in.
* properties required ServerPropertiesForCreate
* sku Sku
* tags object: Application-specific metadata in the form of key-value pairs.

$3

* ServerListResult object: A list of servers.
* value array: The list of servers
* items Server

$3

* ServerProperties object: The properties of a server.
* administratorLogin string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
* earliestRestoreDate string: Earliest restore point creation time (ISO8601 format)
* fullyQualifiedDomainName string: The fully qualified domain name of a server.
* masterServerId string: The master server id of a replica server.
* replicaCapacity integer: The maximum number of replicas that a master server can have.
* replicationRole string: The replication role of the server.
* sslEnforcement SslEnforcement
* storageProfile StorageProfile
* userVisibleState string (values: Ready, Dropping, Disabled): A state of a server that is visible to user.
* version ServerVersion

$3

* ServerPropertiesForCreate object: The properties used to create a new server.
* createMode required string (values: Default, PointInTimeRestore, GeoRestore, Replica): The mode to create a new server.
* sslEnforcement SslEnforcement
* storageProfile StorageProfile
* version ServerVersion

$3

* ServerPropertiesForDefaultCreate object: The properties used to create a new server.
* administratorLogin required string: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation).
* administratorLoginPassword required string: The password of the administrator login.
* createMode required string (values: Default, PointInTimeRestore, GeoRestore, Replica): The mode to create a new server.
* sslEnforcement SslEnforcement
* storageProfile StorageProfile
* version ServerVersion

$3

* ServerPropertiesForGeoRestore object: The properties used to create a new server by restoring to a different region from a geo replicated backup.
* sourceServerId required string: The source server id to restore from.
* createMode required string (values: Default, PointInTimeRestore, GeoRestore, Replica): The mode to create a new server.
* sslEnforcement SslEnforcement
* storageProfile StorageProfile
* version ServerVersion

$3

* ServerPropertiesForReplica object: The properties to create a new replica.
* sourceServerId required string: The master server id to create replica from.
* createMode required string (values: Default, PointInTimeRestore, GeoRestore, Replica): The mode to create a new server.
* sslEnforcement SslEnforcement
* storageProfile StorageProfile
* version ServerVersion

$3

* ServerPropertiesForRestore object: The properties used to create a new server by restoring from a backup.
* restorePointInTime required string: Restore point creation time (ISO8601 format), specifying the time to restore from.
* sourceServerId required string: The source server id to restore from.
* createMode required string (values: Default, PointInTimeRestore, GeoRestore, Replica): The mode to create a new server.
* sslEnforcement SslEnforcement
* storageProfile StorageProfile
* version ServerVersion

$3

* ServerSecurityAlertPolicy object: A server security alert policy.
* properties SecurityAlertPolicyProperties
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* ServerUpdateParameters object: Parameters allowed to update for a server.
* properties object: The properties that can be updated for a server.
* administratorLoginPassword string: The password of the administrator login.
* replicationRole string: The replication role of the server.
* sslEnforcement SslEnforcement
* storageProfile StorageProfile
* version ServerVersion
* sku Sku
* tags object: Application-specific metadata in the form of key-value pairs.

$3

* ServerVersion string (values: 9.5, 9.6, 10, 10.0, 10.2, 11): The version of a server.

$3

* Sku object: Billing information related properties of a server.
* capacity integer: The scale up/out capacity, representing server's compute units.
* family string: The family of hardware.
* name string: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8.
* size string: The size code, to be interpreted by resource as appropriate.
* tier string (values: Basic, GeneralPurpose, MemoryOptimized): The tier of the particular SKU, e.g. Basic.

$3

* SslEnforcement string (values: Enabled, Disabled): Enable ssl enforcement or not when connect to server.

$3

* StorageProfile object: Storage Profile properties of a server
* backupRetentionDays integer: Backup retention days for the server.
* geoRedundantBackup string (values: Enabled, Disabled): Enable Geo-redundant or not for server backup.
* storageAutogrow string (values: Enabled, Disabled): Enable Storage Auto Grow.
* storageMB integer: Max storage allowed for a server.

$3

* TrackedResource object: Resource properties including location and tags for track resources.
* location required string: The location the resource resides in.
* tags object: Application-specific metadata in the form of key-value pairs.
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* VirtualNetworkRule object: A virtual network rule.
* properties VirtualNetworkRuleProperties
* id string: Resource ID
* name string: Resource name.
* type string: Resource type.

$3

* VirtualNetworkRuleListResult object: A list of virtual network rules.
* nextLink string: Link to retrieve next page of results.
* value array: Array of results.
* items VirtualNetworkRule

$3

* VirtualNetworkRuleProperties object: Properties of a virtual network rule.
* ignoreMissingVnetServiceEndpoint boolean: Create firewall rule before the virtual network has vnet service endpoint enabled.
* state string (values: Initializing, InProgress, Ready, Deleting, Unknown): Virtual Network Rule State
* virtualNetworkSubnetId required string`: The ARM resource id of the virtual network subnet.