openapi-directory/api/azure.com/azsadmin-ScaleUnitNode.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Scale unit node operation endpoints and objects.","title":"FabricAdminClient","version":"2016-05-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/azsadmin/resource-manager/fabric/Microsoft.Fabric.Admin/preview/2016-05-01/ScaleUnitNode.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"azsadmin-ScaleUnitNode","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnitNodes":{"get":{"description":"Returns a list of all scale unit nodes in a location.","operationId":"ScaleUnitNodes_List","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"List all scale unit node":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List all scale unit node":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"List all scale unit node":{"value":"local"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"List all scale unit node":{"value":"2016-05-01"}}},{"description":"OData filter parameter.","in":"query","name":"$filter","x-ms-parameter-location":"method","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScaleUnitNodeList"},"examples":{"List all scale unit node":{"$ref":"#/components/examples/List_all_scale_unit_node"}}}}},"404":{"description":"NOT FOUND"}},"tags":["ScaleUnitNodes"],"x-ms-odata":"#/components/schemas/ScaleUnitNode","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnitNodes/{scaleUnitNode}":{"get":{"description":"Return the requested scale unit node.","operationId":"ScaleUnitNodes_Get","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Return the requested scale unit node.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Return the requested scale unit node.":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Return the requested scale unit node.":{"value":"local"}}},{"$ref":"#/components/parameters/ScaleUnitNodeParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Return the requested scale unit node.":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScaleUnitNode"},"examples":{"Return the requested scale unit node.":{"$ref":"#/components/examples/Return_the_requested_scale_unit_node."}}}}},"404":{"description":"NOT FOUND"}},"tags":["ScaleUnitNodes"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnitNodes/{scaleUnitNode}/PowerOff":{"post":{"description":"Power off a scale unit node.","operationId":"ScaleUnitNodes_PowerOff","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Power off a scale unit node.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Power off a scale unit node.":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Power off a scale unit node.":{"value":"local"}}},{"$ref":"#/components/parameters/ScaleUnitNodeParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Power off a scale unit node.":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["ScaleUnitNodes"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnitNodes/{scaleUnitNode}/PowerOn":{"post":{"description":"Power on a scale unit node.","operationId":"ScaleUnitNodes_PowerOn","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Power on a scale unit node.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Power on a scale unit node.":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Power on a scale unit node.":{"value":"local"}}},{"$ref":"#/components/parameters/ScaleUnitNodeParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Power on a scale unit node.":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["ScaleUnitNodes"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnitNodes/{scaleUnitNode}/Repair":{"post":{"description":"Repairs a node of the cluster.","operationId":"ScaleUnitNodes_Repair","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Repairs a node of the cluster.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Repairs a node of the cluster.":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Repairs a node of the cluster.":{"value":"local"}}},{"$ref":"#/components/parameters/ScaleUnitNodeParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Repairs a node of the cluster.":{"value":"2016-05-01"}}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BareMetalNodeDescription"}}},"description":"Description of a node.","required":true,"x-ms-parameter-location":"method"},"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["ScaleUnitNodes"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnitNodes/{scaleUnitNode}/Shutdown":{"post":{"description":"Shutdown a scale unit node.","operationId":"ScaleUnitNodes_Shutdown","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Shutdown a scale unit node.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Shutdown a scale unit node.":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Shutdown a scale unit node.":{"value":"local"}}},{"$ref":"#/components/parameters/ScaleUnitNodeParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Shutdown a scale unit node.":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["ScaleUnitNodes"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnitNodes/{scaleUnitNode}/StartMaintenanceMode":{"post":{"description":"Start maintenance mode for a scale unit node.","operationId":"ScaleUnitNodes_StartMaintenanceMode","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Start maintenance mode on a scale unit node.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Start maintenance mode on a scale unit node.":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Start maintenance mode on a scale unit node.":{"value":"local"}}},{"$ref":"#/components/parameters/ScaleUnitNodeParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Start maintenance mode on a scale unit node.":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["ScaleUnitNodes"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/scaleUnitNodes/{scaleUnitNode}/StopMaintenanceMode":{"post":{"description":"Stop maintenance mode for a scale unit node.","operationId":"ScaleUnitNodes_StopMaintenanceMode","parameters":[{"description":"Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Stop maintenance mode on a scale unit node.":{"value":"20ff7fc3-e762-44dd-bd96-b71116dcdc23"}}},{"description":"Name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Stop maintenance mode on a scale unit node.":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Stop maintenance mode on a scale unit node.":{"value":"local"}}},{"$ref":"#/components/parameters/ScaleUnitNodeParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Stop maintenance mode on a scale unit node.":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["ScaleUnitNodes"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://adminmanagement.local.azurestack.external"}],"components":{"examples":{"List_all_scale_unit_node":{"value":{"value":[{"id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/N1S2","location":"local","name":"N1S2","properties":{"canPowerOff":false,"capacity":{"cores":56,"memoryGB":255.875},"powerState":"Running","scaleUnitName":"S-Cluster","scaleUnitNodeStatus":"Running","scaleUnitUri":"/fabricLocations/local/scaleUnits/S-Cluster"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/scaleUnitNodes"}]}},"Return_the_requested_scale_unit_node.":{"value":{"id":"/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/N1S2","location":"local","name":"N1S2","properties":{"canPowerOff":false,"capacity":{"cores":56,"memoryGB":255.875},"powerState":"Running","scaleUnitName":"S-Cluster","scaleUnitNodeStatus":"Running","scaleUnitUri":"/fabricLocations/local/scaleUnits/S-Cluster"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/scaleUnitNodes"}}},"parameters":{"ScaleUnitNodeParameter":{"description":"Name of the scale unit node.","in":"path","name":"scaleUnitNode","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Return the requested scale unit node.":{"value":"N1S2"},"Power off a scale unit node.":{"value":"N1S2"},"Power on a scale unit node.":{"value":"N1S2"},"Repairs a node of the cluster.":{"value":"N1S2"},"Shutdown a scale unit node.":{"value":"N1S2"},"Start maintenance mode on a scale unit node.":{"value":"N1S2"},"Stop maintenance mode on a scale unit node.":{"value":"N1S2"}}}},"securitySchemes":{"azure_auth":{"description":"Authorization uses an Azure Active Directory OAuth2 flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"BareMetalNodeDescription":{"description":"Description of a bare metal node used for ScaleOut operation on a cluster.","properties":{"biosVersion":{"description":"Bios version of the physical machine.","type":"string"},"bmcIpv4Address":{"description":"BMC address of the physical machine.","type":"string","x-ms-client-name":"BMCIPv4Address"},"clusterName":{"description":"Name of the cluster.","type":"string"},"computerName":{"description":"Name of the computer.","type":"string"},"macAddress":{"description":"Name of the MAC address of the bare metal node.","type":"string"},"model":{"description":"Model of the physical machine.","type":"string"},"serialNumber":{"description":"Serial number of the physical machine.","type":"string"},"vendor":{"description":"Vendor of the physical machine.","type":"string"}},"type":"object"},"ScaleUnitNode":{"allOf":[{"description":"Base resource object.","properties":{"id":{"description":"URI of the resource.","readOnly":true,"type":"string"},"location":{"description":"The region where the resource is located.","type":"string"},"name":{"description":"Name of the resource.","readOnly":true,"type":"string"},"tags":{"additionalProperties":{"type":"string"},"description":"List of key-value pairs.","type":"object"},"type":{"description":"Type of resource.","readOnly":true,"type":"string"}},"type":"object","x-ms-azure-resource":true}],"description":"The physical server in a cluster.","properties":{"properties":{"$ref":"#/components/schemas/ScaleUnitNodeModel"}},"type":"object"},"ScaleUnitNodeList":{"description":"A pageable list of scale unit nodes.","properties":{"nextLink":{"description":"The URI to the next page.","type":"string"},"value":{"description":"List of scale unit nodes.","items":{"$ref":"#/components/schemas/ScaleUnitNode"},"type":"array"}},"type":"object"},"ScaleUnitNodeModel":{"description":"Holds all properties related to a scale unit node.","properties":{"biosVersion":{"description":"BIOS version of the physical machine.","type":"string"},"bmcAddress":{"description":"BMC address of the physical machine.","type":"string"},"canPowerOff":{"description":"Value indicating whether the node can be powered off.","type":"boolean"},"capacity":{"description":"The capacity information for a physical machine.","properties":{"cores":{"description":"The number of CPU cores for the physical machine.","format":"int64","type":"integer"},"memoryGB":{"description":"The memory for the physical machine.","format":"float","type":"number"}},"type":"object"},"model":{"description":"Model of the physical machine.","type":"string"},"powerState":{"description":"PowerState of the physical machine.","enum":["Stopped","Starting","Running","Stopping"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"PowerState"}},"scaleUnitName":{"description":"Cluster name of the physical machine.","type":"string"},"scaleUnitNodeStatus":{"description":"Status of the physical machine.","enum":["Running","Maintenance","Stopped"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"ScaleUnitNodeStatus"}},"scaleUnitUri":{"description":"URI of the corresponding cluster.","type":"string"},"serialNumber":{"description":"Serial number of the physical machine.","type":"string"},"vendor":{"description":"Vendor of the physical machine.","type":"string"}},"type":"object"}}}}