swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Servers API schemes: - https tags: - name: Servers paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers : get: description: Lists servers of a cluster. tags: - Servers operationId: microsoftAzureServersListbycluster x-ms-examples: List servers of the cluster: $ref: ./examples/ServerListByCluster.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/ClusterServerListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Servers ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/serverGroupsv2/{clusterName}/servers/{serverName} : get: description: Gets information about a server in cluster. tags: - Servers operationId: microsoftAzureServersGet x-ms-examples: Get the server of cluster: $ref: ./examples/ServerGet.json parameters: - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ClusterNameParameter' - $ref: '#/parameters/ServerNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/ClusterServer' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Clustername Servers Servername /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/usages: get: tags: - Servers operationId: microsoftAzureServerusagesListbyserver description: Returns server usages. x-ms-examples: List servers usages: $ref: ./examples/ServerUsageMetricsList.json parameters: - $ref: ../../../common/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../common/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../common/v1/types.json#/parameters/ResourceGroupParameter - $ref: '#/parameters/ServerNameParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/ServerUsageListResult' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Sql Servers Servername Usages ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName} : get: description: Gets details about the specified Analysis Services server. x-ms-examples: Get details of a server: $ref: ./examples/getServer.json tags: - Servers operationId: microsoftAzureServersGetdetails parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: serverName in: path required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. The operation was successful. schema: $ref: '#/definitions/AnalysisServicesServer' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername put: description: Provisions the specified Analysis Services server based on the configuration specified in the request. x-ms-examples: Create a server.: $ref: ./examples/createServer.json tags: - Servers operationId: microsoftAzureServersCreate parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: serverName in: path required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: The name of the Analysis Services server. It must be a minimum of 3 characters, and a maximum of 63. - name: serverParameters in: body required: true schema: $ref: '#/definitions/AnalysisServicesServer' description: Contains the information used to provision the Analysis Services server. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. The operation completed successfully. schema: $ref: '#/definitions/AnalysisServicesServer' '201': description: InProgress. The operation is still completing. schema: $ref: '#/definitions/AnalysisServicesServer' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername delete: description: Deletes the specified Analysis Services server. x-ms-examples: Delete a server.: $ref: ./examples/deleteServer.json tags: - Servers operationId: microsoftAzureServersDelete parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: serverName in: path required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. '202': description: Accepted. '204': description: No Content. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername patch: description: Updates the current state of the specified Analysis Services server. x-ms-examples: Update a server.: $ref: ./examples/updateServer.json tags: - Servers operationId: microsoftAzureServersUpdate parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: serverName in: path required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. - name: serverUpdateParameters in: body required: true schema: $ref: '#/definitions/AnalysisServicesServerUpdateParameters' description: Request object that contains the updated information for the server. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK schema: $ref: '#/definitions/AnalysisServicesServer' '202': description: Accepted schema: $ref: '#/definitions/AnalysisServicesServer' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/suspend : post: description: Suspends operation of the specified Analysis Services server instance. x-ms-examples: Suspend a server.: $ref: ./examples/suspendServer.json tags: - Servers operationId: microsoftAzureServersSuspend parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: serverName in: path required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. '202': description: Accepted. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Suspend ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/resume : post: description: Resumes operation of the specified Analysis Services server instance. x-ms-examples: Resume a server.: $ref: ./examples/resumeServer.json tags: - Servers operationId: microsoftAzureServersResume parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: serverName in: path required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Resume /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers: get: description: Gets all the Analysis Services servers for the given resource group. x-ms-examples: List existing servers in the resource group.: $ref: ./examples/listServersInResourceGroup.json tags: - Servers operationId: microsoftAzureServersListbyresourcegroup parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK schema: $ref: '#/definitions/AnalysisServicesServers' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/servers: get: description: Lists all the Analysis Services servers for the given subscription. x-ms-examples: List existing servers under the subscription.: $ref: ./examples/listServers.json tags: - Servers operationId: microsoftAzureServersList parameters: - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK schema: $ref: '#/definitions/AnalysisServicesServers' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Analysisservices Servers ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/skus : get: description: Lists eligible SKUs for an Analysis Services resource. x-ms-examples: List eligible SKUs for an existing server: $ref: ./examples/listSkusForExisting.json tags: - Servers operationId: microsoftAzureServersListskusforexisting parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: serverName in: path required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK schema: $ref: '#/definitions/SkuEnumerationForExistingResourceResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Skus ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/listGatewayStatus : post: description: Return the gateway status of the specified Analysis Services server instance. x-ms-examples: Get details of a server: $ref: ./examples/listGatewayStatus.json tags: - Servers operationId: microsoftAzureServersListgatewaystatus parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: serverName in: path required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: The name of the Analysis Services server. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. schema: $ref: '#/definitions/GatewayListStatusLive' default: description: Default response as an error schema: $ref: '#/definitions/GatewayListStatusError' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Listgatewaystatus ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AnalysisServices/servers/{serverName}/dissociateGateway : post: description: Dissociates a Unified Gateway associated with the server. x-ms-examples: Get details of a server: $ref: ./examples/dissociateGateway.json tags: - Servers operationId: microsoftAzureServersDissociategateway parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - name: serverName in: path required: true type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: The name of the Analysis Services server. It must be at least 3 characters in length, and no more than 63. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Analysisservices Servers Servername Dissociategateway /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/checkNameAvailability: post: x-ms-examples: Get details of a server: $ref: ./examples/checkNameAvailability.json tags: - Servers operationId: microsoftAzureServersChecknameavailability description: Check the name availability in the target location. parameters: - name: location in: path required: true type: string description: The region name which the operation will lookup into. - name: serverParameters in: body required: true schema: $ref: '#/definitions/CheckServerNameAvailabilityParameters' description: Contains the information used to provision the Analysis Services server. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/CheckServerNameAvailabilityResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Analysisservices Locations Location Checknameavailability /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/operationresults/{operationId}: get: x-ms-examples: Get details of a server: $ref: ./examples/operationResults.json tags: - Servers operationId: microsoftAzureServersListoperationresults description: List the result of the specified operation. parameters: - name: location in: path required: true type: string description: The region name which the operation will lookup into. - name: operationId in: path required: true type: string description: The target operation Id. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. The operation completed. '202': description: Accepted. The operation is ongoing. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Analysisservices Locations Location Operationresults Operationid /subscriptions/{subscriptionId}/providers/Microsoft.AnalysisServices/locations/{location}/operationstatuses/{operationId}: get: x-ms-examples: Get details of a server: $ref: ./examples/operationStatuses.json tags: - Servers operationId: microsoftAzureServersListoperationstatuses description: List the status of operation. parameters: - name: location in: path required: true type: string description: The region name which the operation will lookup into. - name: operationId in: path required: true type: string description: The target operation Id. - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK. The operation completed. schema: $ref: '#/definitions/OperationStatus' '202': description: Accepted. The operation is ongoing. schema: $ref: '#/definitions/OperationStatus' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Analysisservices Locations Location Operationstatuses Operationid ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/servers : get: description: Lists servers of a server group. tags: - Servers operationId: microsoftAzureServersListbyservergroup x-ms-examples: List servers of the server group: $ref: ./examples/ServerListByServerGroup.json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ServerGroupNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerGroupServerListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Servergroupname Servers ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBForPostgreSql/serverGroupsv2/{serverGroupName}/servers/{serverName} : get: description: Gets information about a server in server group. tags: - Servers operationId: microsoftAzureServersGet x-ms-examples: Get the server of server group: $ref: ./examples/ServerGet.json parameters: - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter - $ref: '#/parameters/ServerGroupNameParameter' - $ref: '#/parameters/ServerNameParameter_3' responses: '200': description: OK schema: $ref: '#/definitions/ServerGroupServer' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbforpostgresql Servergroupsv2 Servergroupname Servers Servername /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}: put: tags: - Servers operationId: microsoftAzureServersCreate x-ms-examples: Create a new server: $ref: ./examples/ServerCreate.json Create a database as a point in time restore: $ref: ./examples/ServerCreatePointInTimeRestore.json 'Create a server as a geo restore ': $ref: ./examples/ServerCreateGeoRestoreMode.json Create a replica server: $ref: ./examples/ServerCreateReplicaMode.json description: Creates a new server or updates an existing server. The update action will overwrite the existing server. parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ServerNameParameter_4' - name: parameters in: body required: true schema: $ref: '#/definitions/ServerForCreate' description: The required parameters for creating or updating a server. responses: '200': description: OK schema: $ref: '#/definitions/Server' '201': description: Created schema: $ref: '#/definitions/Server' '202': description: Accepted x-ms-long-running-operation: true summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername patch: tags: - Servers operationId: microsoftAzureServersUpdate x-ms-examples: ServerUpdate: $ref: ./examples/ServerUpdate.json description: Updates an existing server. The request body can contain one to many of the properties present in the normal server definition. parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ServerNameParameter_4' - name: parameters in: body required: true schema: $ref: '#/definitions/ServerUpdateParameters' description: The required parameters for updating a server. responses: '200': description: OK schema: $ref: '#/definitions/Server' '202': description: Accepted x-ms-long-running-operation: true summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername delete: tags: - Servers operationId: microsoftAzureServersDelete x-ms-examples: ServerDelete: $ref: ./examples/ServerDelete.json description: Deletes a server. parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ServerNameParameter_4' responses: '200': description: OK '202': description: Accepted '204': description: NoContent x-ms-long-running-operation: true summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername get: tags: - Servers operationId: microsoftAzureServersGet x-ms-examples: ServerGet: $ref: ./examples/ServerGet.json description: Gets information about a server. parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' - $ref: '#/parameters/ServerNameParameter_4' responses: '200': description: OK schema: $ref: '#/definitions/Server' summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers Servername /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers: get: tags: - Servers operationId: microsoftAzureServersListbyresourcegroup x-ms-examples: ServerListByResourceGroup: $ref: ./examples/ServerListByResourceGroup.json description: List all the servers in a given resource group. parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' - $ref: '#/parameters/ResourceGroupParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerListResult' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Dbformariadb Servers /subscriptions/{subscriptionId}/providers/Microsoft.DBforMariaDB/servers: get: tags: - Servers operationId: microsoftAzureServersList x-ms-examples: ServerList: $ref: ./examples/ServerList.json description: List all the servers in a given subscription. parameters: - $ref: '#/parameters/ApiVersionParameter_2' - $ref: '#/parameters/SubscriptionIdParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/ServerListResult' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Dbformariadb Servers definitions: CitusVersion: type: string description: The Citus version. enum: - '8.3' - '9.0' - '9.1' - '9.2' - '9.3' - '9.4' - '9.5' x-ms-enum: name: CitusVersion modelAsString: true CheckServerNameAvailabilityParameters: description: Details of server name request body. type: object properties: name: type: string pattern: ^[a-z][a-z0-9]*$ minLength: 3 maxLength: 63 description: Name for checking availability. type: type: string default: Microsoft.AnalysisServices/servers description: The resource type of azure analysis services. FullyQualifiedDomainName: type: string description: The fully qualified domain name of a server. readOnly: true IPv4FirewallSettings: description: An array of firewall rules. type: object properties: firewallRules: type: array items: $ref: '#/definitions/IPv4FirewallRule' description: The content of firewall rule. description: An array of firewall rules. enablePowerBIService: type: boolean description: The indicator of enabling PBI service. ErrorDetail: description: The error detail. properties: code: readOnly: true type: string description: The error code. message: readOnly: true type: string description: The error message. target: readOnly: true type: string description: The error target. details: readOnly: true type: array items: $ref: '#/definitions/ErrorDetail' description: The error details. additionalInfo: readOnly: true type: array items: $ref: '#/definitions/ErrorAdditionalInfo' description: The error additional info. ServerHaState: type: string description: A state of a server role group/server that is visible to user for HA feature. enum: - NotEnabled - CreatingStandby - ReplicatingData - FailingOver - Healthy - RemovingStandby - NotSync x-ms-enum: name: ServerHaState modelAsString: true readOnly: true ServerProperties: type: object description: The properties of a server. properties: serverEdition: type: string description: The edition of a server. storageQuotaInMb: type: integer format: int32 description: The storage of a server in MB. vCores: type: integer format: int32 description: The vCores count of a server. enableHa: type: boolean description: If high availability (HA) is enabled or not for the server. enablePublicIpAccess: type: boolean description: If public access is enabled on server. readOnly: true isReadOnly: type: boolean description: If server database is set to read-only by system maintenance depending on high disk space usage. readOnly: true administratorLogin: type: string description: The administrator's login name of the servers in the cluster. readOnly: true ServerPropertiesForCreate: discriminator: createMode required: - createMode properties: version: $ref: '#/definitions/ServerVersion' description: Server version. sslEnforcement: $ref: '#/definitions/SslEnforcement' description: Enable ssl enforcement or not when connect to server. minimalTlsVersion: $ref: '#/definitions/MinimalTlsVersion' description: Enforce a minimal Tls version for the server. storageProfile: $ref: '#/definitions/StorageProfile' description: Storage profile of a server. createMode: type: string description: The mode to create a new server. enum: - Default - PointInTimeRestore - GeoRestore - Replica x-ms-enum: name: CreateMode modelAsString: true description: The properties used to create a new server. Sku: properties: name: type: string description: The name of the sku, typically, tier + family + cores, e.g. B_Gen4_1, GP_Gen5_8. tier: type: string description: The tier of the particular SKU, e.g. Basic. enum: - Basic - GeneralPurpose - MemoryOptimized x-ms-enum: name: SkuTier modelAsString: true capacity: type: integer format: int32 minimum: 0 description: The scale up/out capacity, representing server's compute units. size: type: string description: The size code, to be interpreted by resource as appropriate. family: type: string description: The family of hardware. required: - name description: Billing information related properties of a server. ServerForCreate: properties: sku: $ref: '#/definitions/Sku' description: The SKU (pricing tier) of the server. properties: $ref: '#/definitions/ServerPropertiesForCreate' x-ms-client-flatten: false description: Properties of the server. location: type: string description: The location the resource resides in. tags: type: object additionalProperties: type: string description: Application-specific metadata in the form of key-value pairs. required: - properties - location description: Represents a server to be created. CloudErrorBody: x-ms-external: true description: An error response from the Batch service. properties: code: type: string description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. message: type: string description: A message describing the error, intended to be suitable for display in a user interface. target: type: string description: The target of the particular error. For example, the name of the property in error. details: type: array description: A list of additional details about the error. items: $ref: '#/definitions/CloudErrorBody' x-ms-identifiers: - code ServerGroupServerListResult: description: A list of servers in a server group. properties: value: type: array description: The list of servers in a server group. items: $ref: '#/definitions/ServerGroupServer' ErrorAdditionalInfo: properties: type: readOnly: true type: string description: The additional info type. info: readOnly: true type: object description: The additional info. description: The resource management error additional info. ServerVersion: type: string description: The version of a server. enum: - '10.2' - '10.3' x-ms-enum: name: ServerVersion modelAsString: true ResourceSku: description: Represents the SKU name and Azure pricing tier for Analysis Services resource. type: object properties: name: type: string description: Name of the SKU level. tier: type: string enum: - Development - Basic - Standard x-ms-enum: name: SkuTier modelAsString: true description: The name of the Azure pricing tier to which the SKU applies. capacity: type: integer format: int32 minimum: 1 maximum: 8 default: 1 description: The number of instances in the read only query pool. required: - name ClusterServer: description: Represents a server in a cluster. type: object allOf: - $ref: ../../../../../common-types/resource-management/v4/types.json#/definitions/ProxyResource properties: properties: $ref: '#/definitions/ClusterServerProperties' description: The properties of a server in a cluster. x-ms-client-flatten: true OperationStatus: description: The status of operation. type: object properties: id: type: string description: The operation Id. name: type: string description: The operation name. startTime: type: string description: The start time of the operation. endTime: type: string description: The end time of the operation. status: type: string description: The status of the operation. error: type: object description: The error detail of the operation if any. $ref: '#/definitions/ErrorResponse' ServerProperties_2: description: The properties of a server. properties: serverEdition: type: string description: 'The edition of a server (default: GeneralPurpose).' enum: - GeneralPurpose - MemoryOptimized x-ms-enum: name: ServerEdition modelAsString: true storageQuotaInMb: type: integer format: int64 description: 'The storage of a server in MB (max: 2097152 = 2TiB).' vCores: type: integer format: int64 description: 'The vCores count of a server (max: 64).' enableHa: type: boolean description: If high availability is enabled or not for the server. enablePublicIp: type: boolean description: If public IP is requested or not for a server. readOnly: true ServerUsageListResult: properties: value: type: array items: $ref: '#/definitions/ServerUsage' description: The list of server metrics for the server. required: - value description: Represents the response to a list server metrics request. Resource: description: Represents an instance of an Analysis Services resource. type: object properties: id: type: string readOnly: true description: An identifier that represents the Analysis Services resource. name: type: string readOnly: true description: The name of the Analysis Services resource. type: type: string readOnly: true description: The type of the Analysis Services resource. location: type: string description: Location of the Analysis Services resource. x-ms-mutability: - create - read sku: $ref: '#/definitions/ResourceSku' description: The SKU of the Analysis Services resource. tags: type: object additionalProperties: type: string description: Key-value pairs of additional resource provisioning properties. required: - location - sku x-ms-azure-resource: true ResourceIdentity: description: Azure Active Directory identity configuration for a resource. type: object properties: principalId: format: uuid description: The Azure Active Directory principal id. type: string readOnly: true type: description: The identity type. Set this to 'SystemAssigned' in order to automatically create and assign an Azure Active Directory principal for the resource. enum: - SystemAssigned type: string x-ms-enum: name: IdentityType modelAsString: true tenantId: format: uuid description: The Azure Active Directory tenant id. type: string readOnly: true GatewayDetails: description: The gateway details. type: object properties: gatewayResourceId: type: string description: Gateway resource to be associated with the server. gatewayObjectId: type: string readOnly: true description: Gateway object id from in the DMTS cluster for the gateway resource. dmtsClusterUri: type: string readOnly: true description: Uri of the DMTS cluster. SkuDetailsForExistingResource: description: An object that represents SKU details for existing resources. type: object properties: sku: $ref: '#/definitions/ResourceSku' description: The SKU in SKU details for existing resources. ServerGroupServerProperties: description: The properties of a server in server group. allOf: - $ref: '#/definitions/ServerProperties_2' properties: fullyQualifiedDomainName: $ref: '#/definitions/FullyQualifiedDomainName' description: The fully qualified domain name of a server. role: $ref: '#/definitions/ServerRole' description: The role of server in the server group. state: $ref: '#/definitions/ServerState' description: A state of a server that is visible to user. haState: $ref: '#/definitions/ServerHaState' description: A state of a server group that is visible to user for HA feature. administratorLogin: type: string description: The administrator's login name of a servers in server group. postgresqlVersion: $ref: '#/definitions/PostgreSQLVersion' description: The PostgreSQL version of server. citusVersion: $ref: '#/definitions/CitusVersion' description: The Citus version of server. availabilityZone: type: string description: Availability Zone information of the server group. standbyAvailabilityZone: type: string description: Standby Availability Zone information of the server group. PostgreSQLVersion: type: string description: The PostgreSQL version. enum: - '11' - '12' x-ms-enum: name: PostgreSQLVersion modelAsString: true ClusterServerProperties: description: The properties of a server in cluster. type: object allOf: - $ref: '#/definitions/ServerProperties' properties: fullyQualifiedDomainName: type: string description: The fully qualified domain name of a server. readOnly: true role: $ref: '#/definitions/ServerRole' description: The role of server in the cluster. state: type: string description: A state of a cluster/server that is visible to user. readOnly: true haState: type: string description: A state of HA feature for the cluster. readOnly: true availabilityZone: type: string description: Availability Zone information of the server. postgresqlVersion: type: string description: The major PostgreSQL version of server. citusVersion: type: string description: The Citus extension version of server. CheckServerNameAvailabilityResult: description: The checking result of server name availability. type: object properties: nameAvailable: type: boolean description: Indicator of available of the server name. reason: type: string description: The reason of unavailability. message: type: string description: The detailed message of the request unavailability. GatewayListStatusLive: description: Status of gateway is live. type: object properties: status: type: integer format: int32 enum: - 0 x-ms-enum: name: Status modelAsString: false description: 'Live message of list gateway. Status: 0 - Live' StorageProfile: properties: backupRetentionDays: type: integer description: Backup retention days for the server. geoRedundantBackup: type: string description: Enable Geo-redundant or not for server backup. enum: - Enabled - Disabled x-ms-enum: name: GeoRedundantBackup modelAsString: true storageMB: type: integer format: int32 description: Max storage allowed for a server. storageAutogrow: type: string description: Enable Storage Auto Grow. enum: - Enabled - Disabled x-ms-enum: name: StorageAutogrow modelAsString: true description: Storage Profile properties of a server AnalysisServicesServerUpdateParameters: description: Provision request specification type: object properties: sku: $ref: '#/definitions/ResourceSku' description: The SKU of the Analysis Services resource. tags: type: object additionalProperties: type: string description: Key-value pairs of additional provisioning properties. properties: x-ms-client-flatten: true $ref: '#/definitions/AnalysisServicesServerMutableProperties' description: Properties of the provision operation request. ServerProperties_3: properties: administratorLogin: type: string description: The administrator's login name of a server. Can only be specified when the server is being created (and is required for creation). version: $ref: '#/definitions/ServerVersion' description: Server version. sslEnforcement: $ref: '#/definitions/SslEnforcement' description: Enable ssl enforcement or not when connect to server. minimalTlsVersion: $ref: '#/definitions/MinimalTlsVersion' description: Enforce a minimal Tls version for the server. userVisibleState: type: string description: A state of a server that is visible to user. enum: - Ready - Dropping - Disabled x-ms-enum: name: ServerState modelAsString: true fullyQualifiedDomainName: type: string description: The fully qualified domain name of a server. earliestRestoreDate: type: string format: date-time description: Earliest restore point creation time (ISO8601 format) storageProfile: $ref: '#/definitions/StorageProfile' description: Storage profile of a server. replicationRole: type: string description: The replication role of the server. masterServerId: type: string description: The master server id of a replica server. replicaCapacity: type: integer format: int32 minimum: 0 description: The maximum number of replicas that a master server can have. description: The properties of a server. ClusterServerListResult: description: A list of servers in a cluster. type: object properties: value: type: array description: The list of servers in a cluster. items: $ref: '#/definitions/ClusterServer' ServerState: type: string description: A state of a server group/server that is visible to user. enum: - Ready - Dropping - Disabled - Starting - Stopping - Stopped - Updating - Provisioning x-ms-enum: name: ServerState modelAsString: true readOnly: true AnalysisServicesServerMutableProperties: description: An object that represents a set of mutable Analysis Services resource properties. type: object properties: asAdministrators: $ref: '#/definitions/ServerAdministrators' description: A collection of AS server administrators backupBlobContainerUri: type: string description: The SAS container URI to the backup container. gatewayDetails: $ref: '#/definitions/GatewayDetails' description: The gateway details configured for the AS server. ipV4FirewallSettings: $ref: '#/definitions/IPv4FirewallSettings' description: The firewall settings for the AS server. querypoolConnectionMode: type: string description: 'How the read-write server''s participation in the query pool is controlled.
It can have the following values: Specifying readOnly when capacity is 1 results in error.' enum: - All - ReadOnly x-ms-enum: modelAsString: false name: ConnectionMode default: All managedMode: type: integer format: int32 enum: - 0 - 1 x-ms-enum: modelAsString: false name: ManagedMode default: 1 description: The managed mode of the server (0 = not managed, 1 = managed). serverMonitorMode: type: integer format: int32 enum: - 0 - 1 x-ms-enum: modelAsString: false name: ServerMonitorMode default: 1 description: The server monitor mode for AS server Server: properties: identity: $ref: '#/definitions/ResourceIdentity' description: The Azure Active Directory identity of the server. sku: $ref: '#/definitions/Sku' description: The SKU (pricing tier) of the server. properties: $ref: '#/definitions/ServerProperties_3' x-ms-client-flatten: true description: Properties of the server. allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource description: Represents a server. AnalysisServicesServerProperties: description: Properties of Analysis Services resource. type: object properties: state: type: string enum: - Deleting - Succeeded - Failed - Paused - Suspended - Provisioning - Updating - Suspending - Pausing - Resuming - Preparing - Scaling x-ms-enum: name: State modelAsString: true readOnly: true description: The current state of Analysis Services resource. The state is to indicate more states outside of resource provisioning. provisioningState: type: string enum: - Deleting - Succeeded - Failed - Paused - Suspended - Provisioning - Updating - Suspending - Pausing - Resuming - Preparing - Scaling x-ms-enum: name: ProvisioningState modelAsString: true readOnly: true description: The current deployment state of Analysis Services resource. The provisioningState is to indicate states for resource provisioning. serverFullName: type: string readOnly: true description: The full name of the Analysis Services resource. sku: $ref: '#/definitions/ResourceSku' description: The SKU of the Analysis Services resource. allOf: - $ref: '#/definitions/AnalysisServicesServerMutableProperties' ServerUpdateParameters: properties: sku: $ref: '#/definitions/Sku' description: The SKU (pricing tier) of the server. properties: properties: storageProfile: $ref: '#/definitions/StorageProfile' description: Storage profile of a server. administratorLoginPassword: type: string format: password description: The password of the administrator login. version: $ref: '#/definitions/ServerVersion' description: The version of a server. sslEnforcement: $ref: '#/definitions/SslEnforcement' description: Enable ssl enforcement or not when connect to server. minimalTlsVersion: $ref: '#/definitions/MinimalTlsVersion' description: Enforce a minimal Tls version for the server. replicationRole: type: string description: The replication role of the server. x-ms-client-flatten: true description: The properties that can be updated for a server. tags: type: object additionalProperties: type: string description: Application-specific metadata in the form of key-value pairs. description: Parameters allowed to update for a server. ServerGroupServer: description: Represents a server in a server group. allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource properties: systemData: description: The system metadata relating to this resource $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData properties: $ref: '#/definitions/ServerGroupServerProperties' description: The properties of a server in a server group. x-ms-client-flatten: true MinimalTlsVersion: type: string description: Enforce a minimal Tls version for the server. enum: - TLS1_0 - TLS1_1 - TLS1_2 - TLSEnforcementDisabled x-ms-enum: name: MinimalTlsVersionEnum modelAsString: true AnalysisServicesServer: description: Represents an instance of an Analysis Services resource. type: object properties: properties: x-ms-client-flatten: true $ref: '#/definitions/AnalysisServicesServerProperties' description: Properties of the provision operation request. allOf: - $ref: '#/definitions/Resource' ErrorResponse: description: Describes the format of Error response. type: object properties: error: type: object description: The error object properties: code: description: Error code type: string message: description: Error message indicating why the operation failed. type: string details: readOnly: true type: array items: $ref: '#/definitions/ErrorDetail' description: The error details. SkuEnumerationForExistingResourceResult: description: An object that represents enumerating SKUs for existing resources. type: object properties: value: type: array items: $ref: '#/definitions/SkuDetailsForExistingResource' description: The collection of available SKUs for existing resources. ServerListResult: properties: value: type: array items: $ref: '#/definitions/Server' description: The list of servers description: A list of servers. ServerAdministrators: description: An array of administrator user identities. type: object properties: members: type: array items: type: string description: 'The UPN of the user. For example: johnsmith@contoso.com.' description: An array of administrator user identities. IPv4FirewallRule: description: The detail of firewall rule. type: object properties: firewallRuleName: type: string description: The rule name. rangeStart: type: string description: The start range of IPv4. rangeEnd: type: string description: The end range of IPv4. ServerRole: type: string description: The role of a server. enum: - Coordinator - Worker x-ms-enum: name: ServerRole modelAsString: true GatewayListStatusError: description: Status of gateway is error. type: object properties: error: $ref: '#/definitions/GatewayError' description: Error of the list gateway status. ServerUsage: properties: name: readOnly: true type: string description: Name of the server usage metric. resourceName: readOnly: true type: string description: The name of the resource. displayName: readOnly: true type: string description: The metric display name. currentValue: readOnly: true type: number format: double description: The current value of the metric. limit: readOnly: true type: number format: double description: The current limit of the metric. unit: readOnly: true type: string description: The units of the metric. nextResetTime: readOnly: true type: string format: date-time description: The next reset time for the metric (ISO8601 format). description: Represents server metrics. CloudError: x-ms-external: true description: An error response from the Batch service. properties: error: $ref: '#/definitions/CloudErrorBody' description: The error. SslEnforcement: type: string description: Enable ssl enforcement or not when connect to server. enum: - Enabled - Disabled x-ms-enum: name: SslEnforcementEnum modelAsString: false AnalysisServicesServers: description: An array of Analysis Services resources. type: object properties: value: type: array items: $ref: '#/definitions/AnalysisServicesServer' description: An array of Analysis Services resources. required: - value GatewayError: description: Detail of gateway errors. type: object properties: code: type: string description: Error code of list gateway. message: type: string description: Error message of list gateway. parameters: SubscriptionIdParameter_2: name: subscriptionId in: path required: true type: string description: The subscription ID that identifies an Azure subscription. ApiVersionParameter: name: api-version in: query required: true type: string description: The client API version. ServerGroupNameParameter: name: serverGroupName in: path required: true type: string description: The name of the server group. minLength: 1 maxLength: 90 x-ms-parameter-location: method ApiVersionParameter_2: name: api-version in: query required: true type: string description: The API version to use for the request. ServerNameParameter_3: name: serverName in: path required: true type: string description: The name of the server. minLength: 1 maxLength: 90 x-ms-parameter-location: method ServerNameParameter_4: name: serverName in: path required: true type: string description: The name of the server. x-ms-parameter-location: method ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ minLength: 1 maxLength: 90 x-ms-parameter-location: method description: The name of the Azure Resource group of which a given Analysis Services server is part. This name must be at least 1 character in length, and no more than 90. SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: A unique identifier for a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ServerNameParameter_2: name: serverName in: path required: true type: string description: The name of the server. x-ms-parameter-location: method ResourceGroupParameter: name: resourceGroupName in: path required: true type: string 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. x-ms-parameter-location: method ClusterNameParameter: name: clusterName in: path required: true type: string description: The name of the cluster. pattern: ^(?![0-9]+$)(?!-)[a-z0-9-]{3,40}(?