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

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

{"openapi":"3.0.0","info":{"description":"Infrastructure role instance 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/InfraRoleInstance.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"azsadmin-InfraRoleInstance","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/infraRoleInstances":{"get":{"description":"Returns a list of all infrastructure role instances at a location.","operationId":"InfraRoleInstances_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":{"Returns a list of all infrastructure role instances at a location.":{"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":{"Returns a list of all infrastructure role instances at a location.":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Returns a list of all infrastructure role instances at a location.":{"value":"local"}}},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Returns a list of all infrastructure role instances at a location.":{"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/InfraRoleInstanceList"},"examples":{"Returns a list of all infrastructure role instances at a location.":{"$ref":"#/components/examples/Returns_a_list_of_all_infrastructure_role_instances_at_a_location."}}}}},"404":{"description":"NOT FOUND"}},"tags":["InfraRoleInstances"],"x-ms-odata":"#/components/schemas/InfraRoleInstance","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/infraRoleInstances/{infraRoleInstance}":{"get":{"description":"Return the requested infrastructure role instance.","operationId":"InfraRoleInstances_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 infrastructure role instance.":{"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 infrastructure role instance.":{"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 infrastructure role instance.":{"value":"local"}}},{"$ref":"#/components/parameters/InfraRoleInstanceParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Return the requested infrastructure role instance.":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InfraRoleInstance"},"examples":{"Return the requested infrastructure role instance.":{"$ref":"#/components/examples/Return_the_requested_infrastructure_role_instance."}}}}},"404":{"description":"NOT FOUND"}},"tags":["InfraRoleInstances"]}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/infraRoleInstances/{infraRoleInstance}/PowerOff":{"post":{"description":"Power off an infrastructure role instance.","operationId":"InfraRoleInstances_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 an infrastructure role instance":{"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 an infrastructure role instance":{"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 an infrastructure role instance":{"value":"local"}}},{"$ref":"#/components/parameters/InfraRoleInstanceParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Power off an infrastructure role instance":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["InfraRoleInstances"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/infraRoleInstances/{infraRoleInstance}/PowerOn":{"post":{"description":"Power on an infrastructure role instance.","operationId":"InfraRoleInstances_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 an infrastructure role instance":{"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 an infrastructure role instance":{"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 an infrastructure role instance":{"value":"local"}}},{"$ref":"#/components/parameters/InfraRoleInstanceParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Power on an infrastructure role instance":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["InfraRoleInstances"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/infraRoleInstances/{infraRoleInstance}/Reboot":{"post":{"description":"Reboot an infrastructure role instance.","operationId":"InfraRoleInstances_Reboot","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":{"Reboot an infrastructure role instance":{"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":{"Reboot an infrastructure role instance":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Reboot an infrastructure role instance":{"value":"local"}}},{"$ref":"#/components/parameters/InfraRoleInstanceParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Reboot an infrastructure role instance":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["InfraRoleInstances"],"x-ms-long-running-operation":true}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/infraRoleInstances/{infraRoleInstance}/Shutdown":{"post":{"description":"Shut down an infrastructure role instance.","operationId":"InfraRoleInstances_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 an infrastructure role instance":{"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 an infrastructure role instance":{"value":"System.local"}}},{"description":"Location of the resource.","in":"path","name":"location","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Shutdown an infrastructure role instance":{"value":"local"}}},{"$ref":"#/components/parameters/InfraRoleInstanceParameter"},{"description":"Client API Version.","in":"query","name":"api-version","required":true,"schema":{"type":"string","default":"2016-05-01"},"examples":{"Shutdown an infrastructure role instance":{"value":"2016-05-01"}}}],"responses":{"200":{"description":"OK"},"202":{"description":"ACCEPTED"}},"tags":["InfraRoleInstances"],"x-ms-long-running-operation":true}}},"servers":[{"url":"https://adminmanagement.local.azurestack.external"}],"components":{"examples":{"Returns_a_list_of_all_infrastructure_role_instances_at_a_location.":{"value":{"value":[{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-ACS01","location":"local","name":"local/AzS-ACS01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":2,"memoryGb":8},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-ADFS01","location":"local","name":"local/AzS-ADFS01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":2,"memoryGb":2},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-BGPNAT01","location":"local","name":"local/AzS-BGPNAT01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":2,"memoryGb":2},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-CA01","location":"local","name":"local/AzS-CA01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":2,"memoryGb":1},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-Gwy01","location":"local","name":"local/AzS-Gwy01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":4,"memoryGb":2},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-NC01","location":"local","name":"local/AzS-NC01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":2,"memoryGb":4},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-SLB01","location":"local","name":"local/AzS-SLB01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":4,"memoryGb":2},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-Sql01","location":"local","name":"local/AzS-Sql01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":2,"memoryGb":4},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-WAS01","location":"local","name":"local/AzS-WAS01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":2,"memoryGb":4},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-WASP01","location":"local","name":"local/AzS-WASP01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":2,"memoryGb":8},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"},{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-Xrp01","location":"local","name":"local/AzS-Xrp01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":4,"memoryGb":8},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"}]}},"Return_the_requested_infrastructure_role_instance.":{"value":{"id":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/System.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/infraRoleInstances/AzS-BGPNAT01","location":"local","name":"local/AzS-BGPNAT01","properties":{"scaleUnit":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnits/S-Cluster","scaleUnitNode":"/subscriptions/23a94a7f-64b3-42d8-807c-733284339015/resourceGroups/system.local/providers/Microsoft.Fabric.Admin/fabricLocations/local/scaleUnitNodes/HC1u15a2437","size":{"cores":2,"memoryGb":2},"state":"Running"},"tags":{},"type":"Microsoft.Fabric.Admin/fabricLocations/infraRoleInstances"}}},"parameters":{"InfraRoleInstanceParameter":{"description":"Name of an infrastructure role instance.","in":"path","name":"infraRoleInstance","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Return the requested infrastructure role instance.":{"value":"AzS-NC01"},"Power off an infrastructure role instance":{"value":"AzS-NC01"},"Power on an infrastructure role instance":{"value":"AzS-NC01"},"Reboot an infrastructure role instance":{"value":"AzS-NC01"},"Shutdown an infrastructure role instance":{"value":"AzS-NC01"}}}},"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":{"InfraRoleInstance":{"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 virtual machine resource is used to represent an infrastructure virtual machine in the Azure Stack environment. The fabric resource provider only surfaces infrastructure virtual machines. These machines are never created directly by the admin, but rather as a side effect of expanding admin services.","properties":{"properties":{"$ref":"#/components/schemas/InfraRoleInstanceModel"}},"type":"object"},"InfraRoleInstanceList":{"description":"Pageable list of infrastructure role instances.","properties":{"nextLink":{"description":"URI to the next page.","type":"string"},"value":{"description":"List of infrastructure role instances.","items":{"$ref":"#/components/schemas/InfraRoleInstance"},"type":"array"}},"type":"object"},"InfraRoleInstanceModel":{"description":"All properties of an infrastructure role instance.","properties":{"scaleUnit":{"description":"The cluster that the virtual machine's host is part of.","type":"string"},"scaleUnitNode":{"description":"URI to the scale unit node.","type":"string"},"size":{"$ref":"#/components/schemas/InfraRoleInstanceSize"},"state":{"description":"The current state of the virtual machine.","enum":["Stopped","Starting","Running","Stopping"],"type":"string","x-ms-enum":{"modelAsString":true,"name":"InfraRoleInstanceState"}}},"type":"object"},"InfraRoleInstanceSize":{"description":"The capacity information for a virtual machine.","properties":{"cores":{"description":"The number of cores assigned to the virtual machine.","format":"int32","type":"integer"},"memoryGb":{"description":"The amount of memory, in GB, currently assigned to the virtual machine.","format":"float","type":"number"}},"type":"object"}}}}