ServerManagement
REST API for Azure Server Management Service.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
REST API for Azure Server Management Service.
Endpoints 25
Gateways
- GETGateway_List
/subscriptions/:subscriptionId/providers/Microsoft.ServerManagement/gateways?api-version=stringReturns gateways in a subscription. - GETGateway_ListForResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/gateways?api-version=stringReturns gateways in a resource group. - GETGateway_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/gateways/:gatewayName?api-version=string&$expand=statusGets a gateway. - PUTGateway_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/gateways/:gatewayName?api-version=stringCreates or updates a ManagementService gateway. - DELETEGateway_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/gateways/:gatewayName?api-version=stringDeletes a gateway from a resource group. - POSTGateway_GetProfile
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/gateways/:gatewayName/profile?api-version=stringGets a gateway profile. - POSTGateway_RegenerateProfile
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/gateways/:gatewayName/regenerateprofile?api-version=stringRegenerate a gateway's profile - POSTGateway_Upgrade
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/gateways/:gatewayName/upgradetolatest?api-version=stringUpgrades a gateway.
Nodes
- GETNode_List
/subscriptions/:subscriptionId/providers/Microsoft.ServerManagement/nodes?api-version=stringLists nodes in a subscription. - GETNode_ListForResourceGroup
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes?api-version=stringLists nodes in a resource group. - GETNode_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName?api-version=stringGets a management node. - PUTNode_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName?api-version=stringCreates or updates a management node. - DELETENode_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName?api-version=stringdeletes a management node - PATCHNode_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName?api-version=stringUpdates a management node.
Sessions
- GETSession_Get
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session?api-version=stringGets a session for a node. - PUTSession_Create
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session?api-version=stringCreates a session for a node. - DELETESession_Delete
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session?api-version=stringDeletes a session for a node.
PowerShell
- GETPowerShell_ListSession
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session/features/powerShellConsole/pssessions?api-version=stringGets a list of the active sessions. - GETPowerShell_GetCommandStatus
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session/features/powerShellConsole/pssessions/:pssession?api-version=string&$expand=outputGets the status of a command. - PUTPowerShell_CreateSession
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session/features/powerShellConsole/pssessions/:pssession?api-version=stringCreates a PowerShell session. - PATCHPowerShell_UpdateCommand
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session/features/powerShellConsole/pssessions/:pssession?api-version=stringUpdates a running PowerShell command with more data. - POSTPowerShell_CancelCommand
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session/features/powerShellConsole/pssessions/:pssession/cancel?api-version=stringCancels a PowerShell command. - POSTPowerShell_InvokeCommand
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session/features/powerShellConsole/pssessions/:pssession/invokeCommand?api-version=stringCreates a PowerShell script and invokes it. - POSTPowerShell_TabCompletion
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/nodes/:nodeName/sessions/:session/features/powerShellConsole/pssessions/:pssession/tab?api-version=stringGets tab completion values for a command.
- PATCHGateway_Update
/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.ServerManagement/gateways/:gatewayName?api-version=stringUpdates a gateway belonging to a resource group.
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 25 operations on 15 pathsGET 9POST 6PUT 4PATCH 3DELETE 3
- Main resources
- Gateways 8PowerShell 7Nodes 6Sessions 3
- Response formats
application/jsontext/json- Description format
- Swagger 2.0, API version
2016-07-01-preview - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the ServerManagement in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the ServerManagement collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gateway_List” (GET /subscriptions/:subscriptionId/providers/Microsoft.ServerManagement/gateways?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the ServerManagement?
REST API for Azure Server Management Service. It is listed under Developer tools and has 25 endpoints.
Who publishes the ServerManagement?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
What is the base URL of the ServerManagement?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the ServerManagement?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the ServerManagement have?
25 operations on 15 paths (9 GET, 6 POST, 4 PUT, 3 PATCH, 3 DELETE). The largest groups are Gateways, PowerShell, Nodes, Sessions.
Is forking the ServerManagement free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.