Skip to content

Commit

Permalink
Merge pull request #3154 from srinivaas-ganesan/user/srganesa/HCISwag…
Browse files Browse the repository at this point in the history
…gerV6

Add arc related defintions for AzureStackHCI
  • Loading branch information
ruowan authored Mar 10, 2021
2 parents 8b93516 + 9bab214 commit 413d0bd
Show file tree
Hide file tree
Showing 63 changed files with 6,629 additions and 29 deletions.
4 changes: 4 additions & 0 deletions custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1567,3 +1567,7 @@ loadtests
helmchart
vcenters
Mwarev
networkinterfaces
storagecontainers
virtualharddisks
omitempty
Original file line number Diff line number Diff line change
@@ -0,0 +1,355 @@
{
"swagger": "2.0",
"info": {
"version": "2021-01-01-preview",
"title": "AzureStackHCI",
"description": "Azure Stack HCI management service"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/": {
"get": {
"operationId": "ArcSettingsResource_ListByHCICluster",
"description": "Get ArcSettings resource of HCI Cluster",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ArcSettingsList"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List ArcSettings details by HCI Cluster": {
"$ref": "./examples/ListArcSettingsByCluster.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureStackHCI/clusters/{clusterName}/arcSettings/{arcSettingsName}": {
"get": {
"operationId": "ArcSettingsResource_Get",
"description": "Get ArcSettings resource details of HCI Cluster",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterNameParameter"
},
{
"$ref": "#/parameters/ArcSettingsNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ArcSettings"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get ArcSettings details": {
"$ref": "./examples/GetArcSettings.json"
}
}
},
"put": {
"operationId": "ArcSettingsResource_Create",
"description": "Create ArcSettings for HCI cluster.",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterNameParameter"
},
{
"$ref": "#/parameters/ArcSettingsNameParameter"
},
{
"name": "arcSettings",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/ArcSettings"
},
"description": "Parameters supplied to the Create ArcSettings resource for this HCI cluster."
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ArcSettings"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Create ArcSettings details": {
"$ref": "./examples/PutArcSettings.json"
}
}
},
"delete": {
"operationId": "ArcSettingsResource_Delete",
"description": "Delete ArcSettings resource details of HCI Cluster",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/ClusterNameParameter"
},
{
"$ref": "#/parameters/ArcSettingsNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK"
},
"204": {
"description": "OK"
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse"
}
}
},
"x-ms-long-running-operation": true,
"x-ms-long-running-operation-options": {
"final-state-via": "azure-async-operation"
},
"x-ms-examples": {
"Delete ArcSettings details": {
"$ref": "./examples/DeleteArcSettings.json"
}
}
}
}
},
"definitions": {
"ArcSettingsList": {
"description": "List of ArcSettings proxy resource for the HCI cluster",
"type": "object",
"properties": {
"value": {
"description": "List of ArcSettings proxy resource.",
"type": "array",
"items": {
"$ref": "#/definitions/ArcSettings"
}
},
"nextLink": {
"description": "Link to the next set of results.",
"type": "string",
"readOnly": true
}
}
},
"ArcSettings": {
"description": "ArcSettings details.",
"type": "object",
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource"
}
],
"properties": {
"systemData": {
"description": "System data of ArcSettings resource",
"$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData",
"x-ms-client-flatten": true
},
"properties": {
"description": "ArcSettings properties.",
"$ref": "#/definitions/ArcSettingsProperties",
"x-ms-client-flatten": true
}
}
},
"ArcSettingsProperties": {
"description": "ArcSettings properties.",
"type": "object",
"properties": {
"provisioningState": {
"description": "Provisioning state of the ArcSettings proxy resource",
"type": "string",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"Accepted",
"Provisioning"
],
"x-ms-enum": {
"name": "provisioningState",
"modelAsString": true
},
"readOnly": true
},
"arcInstanceResourceGroup": {
"type": "string",
"readOnly": true,
"description": "The resource group that hosts the Arc agents, ie Hybrid compute Machine resources"
},
"aggregateState": {
"description": "Aggregate state of Arc agent across the nodes in this HCI cluster",
"type": "string",
"enum": [
"Connected",
"Partially Connected",
"Disconnected",
"Installing",
"Error"
],
"x-ms-enum": {
"name": "aggregateState",
"modelAsString": true
},
"readOnly": true
},
"perNodeDetails": {
"type": "array",
"items": {
"$ref": "#/definitions/PerNodeState"
},
"description": "State of Arc agent in each of the nodes"
}
}
},
"PerNodeState": {
"description": "Status of Arc agent for a particular node in HCI Cluster",
"type": "object",
"properties": {
"name": {
"type": "string",
"readOnly": true,
"description": "Name of the Node in HCI Cluster"
},
"arcInstance": {
"type": "string",
"readOnly": true,
"description": "Fully qualified resource ID for the Arc agent of this node"
},
"state": {
"description": "State of Arc agent in this node",
"type": "string",
"enum": [
"Connected",
"Disconnected",
"Installing",
"Error"
],
"x-ms-enum": {
"name": "perNodeArcState",
"modelAsString": true
},
"readOnly": true
}
}
}
},
"parameters": {
"ClusterNameParameter": {
"name": "clusterName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the cluster.",
"x-ms-parameter-location": "method"
},
"ArcSettingsNameParameter": {
"name": "arcSettingsName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the proxy resource holding details of HCI ArcSettings information.",
"x-ms-parameter-location": "method"
}
}
}
Loading

0 comments on commit 413d0bd

Please sign in to comment.