@datafire/azure_azsadmin_edgegateway v4.0.0

@datafire/azure_azsadmin_edgegateway

Client library for FabricAdminClient

Installation and Usage

npm install --save @datafire/azure_azsadmin_edgegateway

let azure_azsadmin_edgegateway = require('@datafire/azure_azsadmin_edgegateway').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Edge gateway operation endpoints and objects.

Actions

EdgeGateways_List

Returns the list of all edge gateways at a certain location.

azure_azsadmin_edgegateway.EdgeGateways_List({
  "subscriptionId": "",
  "resourceGroupName": "",
  "location": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • resourceGroupName required string: Name of the resource group.
  • location required string: Location of the resource.
  • api-version required string: Client API Version.
  • $filter string: OData filter parameter.

Output

• output EdgeGatewayList

EdgeGateways_Get

Returns the requested edge gateway.

azure_azsadmin_edgegateway.EdgeGateways_Get({
  "subscriptionId": "",
  "resourceGroupName": "",
  "location": "",
  "edgeGateway": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • resourceGroupName required string: Name of the resource group.
  • location required string: Location of the resource.
  • edgeGateway required string: Name of the edge gateway.
  • api-version required string: Client API Version.

Output

• output EdgeGateway

Definitions

EdgeGateway

• EdgeGateway object: This resource represents a gateway, which provides the configuration needed to provide gateway services to virtual networks.
  • properties EdgeGatewayModel
  • id string: URI of the resource.
  • location string: The region where the resource is located.
  • name string: Name of the resource.
  • tags object: List of key-value pairs.
  • type string: Type of resource.

EdgeGatewayList

• EdgeGatewayList object: Pageable list of edge gateways.
  • nextLink string: URI to the next page.
  • value array: List of edge gateways.
    • items EdgeGateway

EdgeGatewayModel

• EdgeGatewayModel object: Object which holds information related to edge gateways.
  • availableCapacity integer: The available network capacity.
  • numberOfConnections integer: The current number of connections.
  • state string: The current state of the edge gateway.
  • totalCapacity integer: The total network capacity.