API-referens

Genererad från modulens kod när dess image byggdes — redigera inte. Sökvägarna är relativa till https://api.example.com.

Docs

GET /docs/db-sqlserver/manifest.json

• Autentisering: krävs
• Operationsnamn: DocsManifest_db-sqlserver

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token

GET /docs/db-sqlserver/{path}

• Autentisering: krävs
• Operationsnamn: DocsFile_db-sqlserver

Parametrar

Namn	Plats	Typ	Obligatorisk
path	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token

SQL Server Compute Plans

GET /boundaries/{boundaryId}/resources/sqlservercomputeplans

List all available sqlservercomputeplans

• Autentisering: krävs
• Operationsnamn: ListSQLServerComputePlans

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK	PagedListResponse<SqlServerResourcePlanDto>
401	Inte inloggad, eller ogiltig token
500	Internt fel	ProblemDetails

GET /boundaries/{boundaryId}/resources/sqlservercomputeplans/{resourceId}

Get a specific sqlservercomputeplan by ID

• Autentisering: krävs
• Operationsnamn: GetSQLServerComputePlan

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceId	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK	SqlServerResourcePlanDto
401	Inte inloggad, eller ogiltig token
404	Hittades inte
500	Internt fel	ProblemDetails

SQL Server Databases

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/connectionstring

Get the internal connection string for a SQL Server instance

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/readSecrets — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/readSecrets på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/connectionstring/external

Get the external (LoadBalancer) connection string for a SQL Server instance

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/readSecrets — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/readSecrets på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/external-ip

Get the externally reachable address of a SQL Server instance's ingress

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/health

Check if a SQL Server instance is healthy

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/license

Set or rotate the product key for a paid-edition SQL Server instance

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/manageLicense — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja

Begärans innehåll: SetLicenseRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/manageLicense på det utvärderade omfånget

SQL Server Editor

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/history

List recent editor activity for an instance (most recent first).

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja
limit	frågesträng	integer	Nej

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/query

Classify, authorize, and (optionally) execute a T-SQL batch against a SQL Server instance.

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja

Begärans innehåll: EditorQueryRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/schemas

List schemas, tables, views, columns, and primary keys.

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/schemaRead — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/schemaRead på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows

List rows in a table (PK-ordered, OFFSET/FETCH paging).

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/dataRead — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja
schema	sökväg	string	Ja
table	sökväg	string	Ja
limit	frågesträng	integer	Nej
offset	frågesträng	integer	Nej

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/dataRead på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows

Insert a row via structured payload.

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/dataWrite — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja
schema	sökväg	string	Ja
table	sökväg	string	Ja

Begärans innehåll: RowMutationRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/dataWrite på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows/{pkValue}

Delete a row by single-column primary key.

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/dataWrite — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja
schema	sökväg	string	Ja
table	sökväg	string	Ja
pkValue	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/dataWrite på det utvärderade omfånget

PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows/{pkValue}

Update a row by single-column primary key.

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/dataWrite — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja
schema	sökväg	string	Ja
table	sökväg	string	Ja
pkValue	sökväg	string	Ja

Begärans innehåll: RowMutationRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/dataWrite på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows:bulk

Update multiple rows in one transaction.

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/dataWrite — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja
schema	sökväg	string	Ja
table	sökväg	string	Ja

Begärans innehåll: BulkUpdateRowsRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/dataWrite på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows:bulk-delete

Delete multiple rows in one transaction by single-column primary key.

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/dataWrite — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja
schema	sökväg	string	Ja
table	sökväg	string	Ja

Begärans innehåll: BulkDeleteRowsRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/dataWrite på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{name}/editor/tables/{schema}/{table}/rows:bulk-insert

Insert multiple rows in one transaction.

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/dataWrite — utvärderas på resursen i sökvägen; en dataåtgärd

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
name	sökväg	string	Ja
schema	sökväg	string	Ja
table	sökväg	string	Ja

Begärans innehåll: BulkInsertRowsRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/dataWrite på det utvärderade omfånget

SqlServer

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters

List all sqlserverclusters in a resource group

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen
• Operationsnamn: ListSqlServers

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/config

Get list configuration for sqlserverclusters

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetSqlServersConfig

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	string	Ja
resourceGroupName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}

Delete a sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/delete — utvärderas på resursen i sökvägen
• Operationsnamn: DeleteSqlServer

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/delete på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}

Get a specific sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetSqlServer

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

PATCH /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}

Partially update an existing sqlserver using JSON Merge Patch

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/write — utvärderas på resursen i sökvägen
• Operationsnamn: PatchSqlServer

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: any

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/write på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}

Create a new sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/write — utvärderas på resursen i sökvägen
• Operationsnamn: CreateSqlServer

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: SqlServerInstanceDto

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/write på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}

Update an existing sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/write — utvärderas på resursen i sökvägen
• Operationsnamn: UpdateSqlServer

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: SqlServerInstanceDto

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/write på det utvärderade omfånget

PUT /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/actions/{action}

Execute a lifecycle action (start, stop, restart) on a sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/write — utvärderas på resursen i sökvägen
• Operationsnamn: ExecuteSqlServerAction

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja
action	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/write på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/scale

Get current scale of a sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetSqlServerScale

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/scale

Scale a sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/scale — utvärderas på resursen i sökvägen
• Operationsnamn: ScaleSqlServer

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: ScaleRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/scale på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots

List snapshots of a sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen
• Operationsnamn: ListSqlServerSnapshots

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots

Create a snapshot of a sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/createSnapshot — utvärderas på resursen i sökvägen
• Operationsnamn: CreateSqlServerSnapshot

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Begärans innehåll: CreateSnapshotRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/createSnapshot på det utvärderade omfånget

GET /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots/pitr-window

The point-in-time recovery window of a sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetSqlServerPitrWindow

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

DELETE /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots/{snapshotId}

Delete a snapshot of a sqlserver

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/deleteSnapshot — utvärderas på resursen i sökvägen
• Operationsnamn: DeleteSqlServerSnapshot

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja
snapshotId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/deleteSnapshot på det utvärderade omfånget

POST /boundaries/{boundaryId}/resourcegroups/{resourceGroupName}/resources/sqlserverclusters/{resourceName}/snapshots/{snapshotId}/restore

Restore a sqlserver from a snapshot

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/restoreSnapshot — utvärderas på resursen i sökvägen
• Operationsnamn: RestoreSqlServerFromSnapshot

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja
resourceGroupName	sökväg	string	Ja
resourceName	sökväg	string	Ja
snapshotId	sökväg	uuid	Ja

Begärans innehåll: RestoreSnapshotRequest

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/restoreSnapshot på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/sqlserverclusters

List all sqlserverclusters across all resource groups

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen
• Operationsnamn: ListAllSqlServers

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	uuid	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

GET /boundaries/{boundaryId}/resources/sqlserverclusters/config

Get list configuration for all sqlserverclusters

• Autentisering: krävs
• IAM-åtgärd: sqlservercluster/read — utvärderas på resursen i sökvägen
• Operationsnamn: GetAllSqlServersConfig

Parametrar

Namn	Plats	Typ	Obligatorisk
boundaryId	sökväg	string	Ja

Svar

Status	Betydelse	Innehåll
200	OK
401	Inte inloggad, eller ogiltig token
403	Anroparen har inte sqlservercluster/read på det utvärderade omfånget

Övriga slutpunkter

GET /readyz

• Autentisering: ingen — anonyma anrop accepteras
• Operationsnamn: StackshipReadiness

Svar

Status	Betydelse	Innehåll

Scheman

BulkDeleteRowsRequest

Egenskap	Typ	Kan vara null
pkValues	string []	Nej

BulkInsertRowsRequest

Egenskap	Typ	Kan vara null
rows	map (any) []	Nej

BulkRowUpdate

Egenskap	Typ	Kan vara null
pkValue	string	Nej
values	map (any)	Nej

BulkUpdateRowsRequest

Egenskap	Typ	Kan vara null
updates	BulkRowUpdate []	Nej

CreateSnapshotRequest

Egenskap	Typ	Kan vara null
description	string	Ja
ttlHours	integer	Ja

EditorQueryRequest

Egenskap	Typ	Kan vara null
defaultSchema	string	Nej
maxRows	integer	Ja
mode	ExecutionMode	Nej
priorCorrelationId	uuid	Ja
readOnly	boolean	Nej
sql	string	Nej
statementTimeoutMs	integer	Ja

ExecutionMode

Ett av: Review, DryRun, Commit.

PagedListResponse<SqlServerResourcePlanDto>

Egenskap	Typ	Kan vara null
items	SqlServerResourcePlanDto []	Nej
pagination	PaginationMeta	Nej

PaginationMeta

Egenskap	Typ	Kan vara null
hasNextPage	boolean	Nej
hasPreviousPage	boolean	Nej
page	integer	Nej
pageSize	integer	Nej
totalItems	integer	Nej
totalPages	integer	Nej

RestoreSnapshotRequest

Egenskap	Typ	Kan vara null
targetTime	date-time	Ja

RowMutationRequest

Egenskap	Typ	Kan vara null
values	map (any)	Nej

ScaleRequest

Egenskap	Typ	Kan vara null
targetScale	integer	Nej

SqlServerInstanceDto

Egenskap	Typ	Kan vara null
allowedCidrs	string	Ja
backupConfigured	boolean	Nej
backupRetentionPolicy	string	Ja
backupSchedule	string	Ja
boundary	string	Nej
boundaryId	uuid	Nej
clusterId	uuid	Nej
clusterName	string	Nej
collation	string	Ja
collection	string	Nej
computePlan	string	Ja
cpuLimit	string	Ja
cpuRequest	string	Ja
createdAt	date-time	Nej
databaseName	string	Ja
edition	string	Nej
enableLoadBalancer	boolean	Nej
id	uuid	Nej
image	string	Ja
instances	integer	Ja
licenseConfigured	boolean	Nej
licenseKey	string	Ja
memoryLimit	string	Ja
memoryRequest	string	Ja
monitoringEnabled	boolean	Nej
name	string	Nej
networkPolicy	string	Ja
phase	string	Ja
primaryEndpoint	string	Ja
publicEndpoint	string	Ja
readyReplicas	integer	Ja
region	string	Nej
resourceGroup	string	Nej
resourcePlanId	string	Ja
sqlVersion	string	Ja
status	string	Nej
storageClass	string	Ja
storageSize	string	Ja
tags	map (string)	Nej

SqlServerResourcePlanDto

Egenskap	Typ	Kan vara null
cpuLimit	string	Nej
cpuRequest	string	Nej
description	string	Nej
id	string	Nej
isProductionReady	boolean	Nej
memoryLimit	string	Nej
memoryRequest	string	Nej
name	string	Nej
replicas	integer	Nej
storageClass	string	Nej
storageSize	string	Nej
verdict	string	Nej
verdictReason	string	Ja