Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Azure Stack Fabric Specification Rewrite #2830

Merged
merged 2 commits into from
Apr 12, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,25 @@
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/edgeGateways/{edgeGateway}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/edgeGateways/{edgeGateway}": {
"get": {
"x-ms-examples": {
"Get an edge gateway": {
"$ref": "./examples/EdgeGateway/EdgeGatewayGetOperation_example.json"
"Returns the requested edge gateway.": {
"$ref": "./examples/EdgeGateway/Get.json"
}
},
"tags": [
"EdgeGateways"
],
"description": "Get an edge gateway by name.",
"description": "Returns the requested edge gateway.",
"operationId": "EdgeGateways_Get",
"parameters": [
{
"$ref": "Fabric.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "Fabric.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "Fabric.json#/parameters/LocationParameter"
},
Expand All @@ -48,26 +51,32 @@
"schema": {
"$ref": "#/definitions/EdgeGateway"
}
},
"404": {
"description": "NOT FOUND"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/edgeGateways": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/edgeGateways": {
"get": {
"x-ms-examples": {
"List all edge gateways": {
"$ref": "./examples/EdgeGateway/EdgeGatewayListOperation_example.json"
"Returns the list of all edge gateways at a certain location.": {
"$ref": "./examples/EdgeGateway/List.json"
}
},
"tags": [
"EdgeGateways"
],
"description": "Get a list of all edge gateways at a certain location.",
"description": "Returns the list of all edge gateways at a certain location.",
"operationId": "EdgeGateways_List",
"parameters": [
{
"$ref": "Fabric.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "Fabric.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "Fabric.json#/parameters/LocationParameter"
},
Expand All @@ -84,6 +93,9 @@
"schema": {
"$ref": "#/definitions/EdgeGatewayList"
}
},
"404": {
"description": "NOT FOUND"
}
},
"x-ms-pageable": {
Expand All @@ -99,7 +111,7 @@
"type": "object",
"properties": {
"properties": {
"description": "Model which holds information related to edge gateways.",
"description": "Object which holds information related to edge gateways.",
"$ref": "#/definitions/EdgeGatewayModel",
"x-ms-client-flatten": true
}
Expand All @@ -111,7 +123,7 @@
]
},
"EdgeGatewayModel": {
"description": "Model which holds information related to edge gateways.",
"description": "Object which holds information related to edge gateways.",
"type": "object",
"properties": {
"state": {
Expand Down Expand Up @@ -140,7 +152,7 @@
"type": "object",
"properties": {
"value": {
"description": "Array of edge gateways.",
"description": "List of edge gateways.",
"type": "array",
"items": {
"$ref": "#/definitions/EdgeGateway"
Expand All @@ -156,7 +168,7 @@
"parameters": {
"EdgeGatewayParameter": {
"name": "edgeGateway",
"description": "name of the edge gateway.",
"description": "Name of the edge gateway.",
"in": "path",
"required": true,
"type": "string",
Expand All @@ -168,7 +180,7 @@
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"description": "Authorization uses an Azure Active Directory OAuth2 flow.",
"scopes": {
"user_impersonation": "impersonate your user account"
}
Expand All @@ -181,4 +193,4 @@
]
}
]
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,22 +16,25 @@
"application/json"
],
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/edgeGatewayPools/{edgeGatewayPool}": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/edgeGatewayPools/{edgeGatewayPool}": {
"get": {
"x-ms-examples": {
"Get an edge gateway pool": {
"$ref": "./examples/EdgeGatewayPool/EdgeGatewayPoolGetOperation_example.json"
"Returns the requested edge gateway pool object.": {
"$ref": "./examples/EdgeGatewayPool/Get.json"
}
},
"description": "Get an EdgeGatewayPool.",
"tags": [
"EdgeGatewayPools"
],
"description": "Returns the requested edge gateway pool object.",
"operationId": "EdgeGatewayPools_Get",
"parameters": [
{
"$ref": "Fabric.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "Fabric.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "Fabric.json#/parameters/LocationParameter"
},
Expand All @@ -48,26 +51,32 @@
"schema": {
"$ref": "#/definitions/EdgeGatewayPool"
}
},
"404": {
"description": "NOT FOUND"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/System.{location}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/edgeGatewayPools": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Fabric.Admin/fabricLocations/{location}/edgeGatewayPools": {
"get": {
"x-ms-examples": {
"Get a list of all edge gateway pools": {
"$ref": "./examples/EdgeGatewayPool/EdgeGatewayPoolListOperation_example.json"
"Returns a list of all edge gateway pool objects at a location.": {
"$ref": "./examples/EdgeGatewayPool/List.json"
}
},
"tags": [
"EdgeGatewayPools"
],
"description": "Get a list of all edge gateway pools at a location.",
"description": "Returns a list of all edge gateway pool objects at a location.",
"operationId": "EdgeGatewayPools_List",
"parameters": [
{
"$ref": "Fabric.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "Fabric.json#/parameters/ResourceGroupParameter"
},
{
"$ref": "Fabric.json#/parameters/LocationParameter"
},
Expand All @@ -84,6 +93,9 @@
"schema": {
"$ref": "#/definitions/EdgeGatewayPoolList"
}
},
"404" : {
"description": "NOT FOUND"
}
},
"x-ms-pageable": {
Expand All @@ -95,11 +107,11 @@
},
"definitions": {
"EdgeGatewayPool": {
"description": "This resource represents an edge gateway pool, which contains an array of gateways.",
"description": "This object represents an edge gateway pool, which contains a list of gateways.",
"type": "object",
"properties": {
"properties": {
"description": "All the properties of an edge gateway pool.",
"description": "The properties of an edge gateway pool.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/EdgeGatewayPoolModel"
}
Expand All @@ -111,11 +123,11 @@
]
},
"EdgeGatewayPoolModel": {
"description": "A model holding all properties of an edge gateway pool.",
"description": "An object that contains the properties of an edge gateway pool.",
"type": "object",
"properties": {
"gatewayType": {
"description": "The gateway type (S2sIPsec, S2sGre, etc).",
"description": "The gateway type, for example, S2sIPsec, S2sGre, and so on.",
"type": "string"
},
"numberOfGateways": {
Expand All @@ -142,7 +154,7 @@
"type": "string"
},
"edgeGateways": {
"description": "List of the edge gateways in this pool.",
"description": "List of the edge gateways in the pool.",
"type": "array",
"items": {
"type": "string"
Expand All @@ -151,11 +163,11 @@
}
},
"EdgeGatewayPoolList": {
"description": "A pageable list of edge gateway pools.",
"description": "A pageable list of edge gateway pools objects.",
"type": "object",
"properties": {
"value": {
"description": "The array of edge gateway pools in this page.",
"description": "List of edge gateway pool objects.",
"type": "array",
"items": {
"$ref": "#/definitions/EdgeGatewayPool"
Expand Down Expand Up @@ -183,7 +195,7 @@
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"description": "Authorization uses an Azure Active Directory OAuth2 flow.",
"scopes": {
"user_impersonation": "impersonate your user account"
}
Expand All @@ -196,4 +208,4 @@
]
}
]
}
}
Loading