{ "swagger": "2.0", "info": { "title": "NetworkManagementClient", "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", "version": "2015-06-15" }, "host": "management.azure.com", "schemes": [ "https" ], "consumes": [ "application/json", "text/json" ], "produces": [ "application/json", "text/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.Network/virtualNetworkGateways/{virtualNetworkGatewayName}": { "put": { "tags": [ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_CreateOrUpdate", "description": "Creates or updates a virtual network gateway in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network gateway." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualNetworkGateway" }, "description": "Parameters supplied to create or update virtual network gateway operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", "schema": { "$ref": "#/definitions/VirtualNetworkGateway" } }, "201": { "description": "Create successful. The operation returns the resulting VirtualNetworkGateway resource.", "schema": { "$ref": "#/definitions/VirtualNetworkGateway" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_Get", "description": "Gets the specified virtual network gateway by resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network gateway." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a VirtualNetworkGateway resource.", "schema": { "$ref": "#/definitions/VirtualNetworkGateway" } } } }, "delete": { "tags": [ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_Delete", "description": "Deletes the specified virtual network gateway.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network gateway." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Delete successful." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Delete successful." } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways": { "get": { "tags": [ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_List", "description": "Gets all virtual network gateways by resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of VirtualNetworkGateway resources.", "schema": { "$ref": "#/definitions/VirtualNetworkGatewayListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset": { "post": { "tags": [ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_Reset", "description": "Resets the primary of the virtual network gateway in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network gateway." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualNetworkGateway" }, "description": "Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "Accepted and the operation will complete asynchronously." }, "200": { "description": "Request successful. The operation reset the primary of the virtual network gateway.", "schema": { "$ref": "#/definitions/VirtualNetworkGateway" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage": { "post": { "tags": [ "VirtualNetworkGateways" ], "operationId": "VirtualNetworkGateways_Generatevpnclientpackage", "description": "Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network gateway." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VpnClientParameters" }, "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "202": { "description": "VPN client package URL.", "schema": { "type": "string" } } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}": { "put": { "tags": [ "VirtualNetworkGatewayConnections" ], "operationId": "VirtualNetworkGatewayConnections_CreateOrUpdate", "description": "Creates or updates a virtual network gateway connection in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayConnectionName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network gateway connection." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/VirtualNetworkGatewayConnection" }, "description": "Parameters supplied to the create or update virtual network gateway connection operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", "schema": { "$ref": "#/definitions/VirtualNetworkGatewayConnection" } }, "201": { "description": "Create successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", "schema": { "$ref": "#/definitions/VirtualNetworkGatewayConnection" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "VirtualNetworkGatewayConnections" ], "operationId": "VirtualNetworkGatewayConnections_Get", "description": "Gets the specified virtual network gateway connection by resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayConnectionName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network gateway connection." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting VirtualNetworkPeering resource.", "schema": { "$ref": "#/definitions/VirtualNetworkGatewayConnection" } } } }, "delete": { "tags": [ "VirtualNetworkGatewayConnections" ], "operationId": "VirtualNetworkGatewayConnections_Delete", "description": "Deletes the specified virtual network Gateway connection.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayConnectionName", "in": "path", "required": true, "type": "string", "description": "The name of the virtual network gateway connection." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Delete successful." }, "202": { "description": "Accepted and the operation will complete asynchronously." }, "204": { "description": "Delete successful." } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections": { "get": { "tags": [ "VirtualNetworkGatewayConnections" ], "operationId": "VirtualNetworkGatewayConnections_List", "description": "The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation resets the virtual network gateway connection shared key.", "schema": { "$ref": "#/definitions/VirtualNetworkGatewayConnectionListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset": { "post": { "tags": [ "VirtualNetworkGatewayConnections" ], "operationId": "VirtualNetworkGatewayConnections_ResetSharedKey", "description": "The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayConnectionName", "in": "path", "required": true, "type": "string", "description": "The virtual network gateway connection reset shared key Name." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConnectionResetSharedKey" }, "description": "Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation sets the virtual network gateway connection shared key.", "schema": { "$ref": "#/definitions/ConnectionResetSharedKey" } }, "202": { "description": "" } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey": { "put": { "tags": [ "VirtualNetworkGatewayConnections" ], "operationId": "VirtualNetworkGatewayConnections_SetSharedKey", "description": "The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayConnectionName", "in": "path", "required": true, "type": "string", "description": "The virtual network gateway connection name." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ConnectionSharedKey" }, "description": "Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "", "schema": { "$ref": "#/definitions/ConnectionSharedKey" } }, "200": { "description": "", "schema": { "$ref": "#/definitions/ConnectionSharedKey" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "VirtualNetworkGatewayConnections" ], "operationId": "VirtualNetworkGatewayConnections_GetSharedKey", "description": "The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "virtualNetworkGatewayConnectionName", "in": "path", "required": true, "type": "string", "description": "The virtual network gateway connection shared key name." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "", "schema": { "$ref": "#/definitions/ConnectionSharedKeyResult" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}": { "put": { "tags": [ "LocalNetworkGateways" ], "operationId": "LocalNetworkGateways_CreateOrUpdate", "description": "Creates or updates a local network gateway in the specified resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "localNetworkGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the local network gateway." }, { "name": "parameters", "in": "body", "required": true, "schema": { "$ref": "#/definitions/LocalNetworkGateway" }, "description": "Parameters supplied to the create or update local network gateway operation." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "201": { "description": "Create successful. The operation returns the resulting LocalNetworkGateway resource.", "schema": { "$ref": "#/definitions/LocalNetworkGateway" } }, "200": { "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", "schema": { "$ref": "#/definitions/LocalNetworkGateway" } } }, "x-ms-long-running-operation": true }, "get": { "tags": [ "LocalNetworkGateways" ], "operationId": "LocalNetworkGateways_Get", "description": "Gets the specified local network gateway in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "localNetworkGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the local network gateway." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns the resulting LocalNetworkGateway resource.", "schema": { "$ref": "#/definitions/LocalNetworkGateway" } } } }, "delete": { "tags": [ "LocalNetworkGateways" ], "operationId": "LocalNetworkGateways_Delete", "description": "Deletes the specified local network gateway.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "name": "localNetworkGatewayName", "in": "path", "required": true, "type": "string", "description": "The name of the local network gateway." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "204": { "description": "Delete successful." }, "200": { "description": "Delete successful." }, "202": { "description": "Accepted and the operation will complete asynchronously." } }, "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "location" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways": { "get": { "tags": [ "LocalNetworkGateways" ], "operationId": "LocalNetworkGateways_List", "description": "Gets all the local network gateways in a resource group.", "parameters": [ { "name": "resourceGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the resource group." }, { "$ref": "#/parameters/ApiVersionParameter" }, { "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Request successful. The operation returns a list of LocalNetworkGateway resources.", "schema": { "$ref": "#/definitions/LocalNetworkGatewayListResult" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } } }, "definitions": { "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { "properties": { "privateIPAddress": { "type": "string", "description": "Gets or sets the privateIPAddress of the IP Configuration" }, "privateIPAllocationMethod": { "type": "string", "description": "The private IP allocation method. Possible values are: 'Static' and 'Dynamic'.", "enum": [ "Static", "Dynamic" ], "x-ms-enum": { "name": "IPAllocationMethod", "modelAsString": true } }, "subnet": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference of the subnet resource." }, "publicIPAddress": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference of the public IP resource." }, "provisioningState": { "type": "string", "description": "The provisioning state of the public IP resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." } }, "description": "Properties of VirtualNetworkGatewayIPConfiguration" }, "VirtualNetworkGatewayIPConfiguration": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat" }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "IP configuration for virtual network gateway" }, "VirtualNetworkGatewayPropertiesFormat": { "properties": { "ipConfigurations": { "type": "array", "items": { "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" }, "description": "IP configurations for virtual network gateway." }, "gatewayType": { "type": "string", "description": "The type of this virtual network gateway. Possible values are: 'Vpn' and 'ExpressRoute'.", "enum": [ "Vpn", "ExpressRoute" ], "x-ms-enum": { "name": "VirtualNetworkGatewayType", "modelAsString": true } }, "vpnType": { "type": "string", "description": "The type of this virtual network gateway. Possible values are: 'PolicyBased' and 'RouteBased'.", "enum": [ "PolicyBased", "RouteBased" ], "x-ms-enum": { "name": "VpnType", "modelAsString": true } }, "enableBgp": { "type": "boolean", "description": "Whether BGP is enabled for this virtual network gateway or not." }, "gatewayDefaultSite": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference of the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." }, "sku": { "$ref": "#/definitions/VirtualNetworkGatewaySku", "description": "The reference of the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." }, "vpnClientConfiguration": { "$ref": "#/definitions/VpnClientConfiguration", "description": "The reference of the VpnClientConfiguration resource which represents the P2S VpnClient configurations." }, "bgpSettings": { "$ref": "#/definitions/BgpSettings", "description": "Virtual network gateway's BGP speaker settings." }, "resourceGuid": { "type": "string", "description": "The resource GUID property of the VirtualNetworkGateway resource." }, "provisioningState": { "type": "string", "description": "The provisioning state of the VirtualNetworkGateway resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." } }, "description": "VirtualNetworkGateway properties" }, "VpnClientRootCertificatePropertiesFormat": { "properties": { "publicCertData": { "type": "string", "description": "Gets or sets the certificate public data" }, "provisioningState": { "type": "string", "description": "The provisioning state of the VPN client root certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." } }, "description": "Properties of SSL certificates of application gateway" }, "VpnClientRootCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat" }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "VPN client root certificate of virtual network gateway" }, "VpnClientRevokedCertificatePropertiesFormat": { "properties": { "thumbprint": { "type": "string", "description": "The revoked VPN client certificate thumbprint." }, "provisioningState": { "type": "string", "description": "The provisioning state of the VPN client revoked certificate resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." } }, "description": "Properties of the revoked VPN client certificate of virtual network gateway." }, "VpnClientRevokedCertificate": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat" }, "name": { "type": "string", "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." }, "etag": { "type": "string", "description": "A unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/SubResource" } ], "description": "VPN client revoked certificate of virtual network gateway." }, "VpnClientConfiguration": { "properties": { "vpnClientAddressPool": { "$ref": "./virtualNetwork.json#/definitions/AddressSpace", "description": "Gets or sets the reference of the Address space resource which represents Address space for P2S VpnClient." }, "vpnClientRootCertificates": { "type": "array", "items": { "$ref": "#/definitions/VpnClientRootCertificate" }, "description": "VpnClientRootCertificate for Virtual network gateway." }, "vpnClientRevokedCertificates": { "type": "array", "items": { "$ref": "#/definitions/VpnClientRevokedCertificate" }, "description": "VpnClientRevokedCertificate for Virtual network gateway." } }, "description": "VpnClientConfiguration for P2S client" }, "VirtualNetworkGatewaySku": { "properties": { "name": { "type": "string", "description": "Gateway sku name -Basic/HighPerformance/Standard", "enum": [ "Basic", "HighPerformance", "Standard" ], "x-ms-enum": { "name": "VirtualNetworkGatewaySkuName", "modelAsString": true } }, "tier": { "type": "string", "description": "Gateway sku tier -Basic/HighPerformance/Standard", "enum": [ "Basic", "HighPerformance", "Standard" ], "x-ms-enum": { "name": "VirtualNetworkGatewaySkuTier", "modelAsString": true } }, "capacity": { "type": "integer", "format": "int32", "description": "The capacity" } }, "description": "VirtualNetworkGatewaySku details" }, "BgpSettings": { "properties": { "asn": { "type": "integer", "format": "int64", "description": "Gets or sets this BGP speaker's ASN" }, "bgpPeeringAddress": { "type": "string", "description": "Gets or sets the BGP peering address and BGP identifier of this BGP speaker" }, "peerWeight": { "type": "integer", "format": "int32", "description": "Gets or sets the weight added to routes learned from this BGP speaker" } } }, "VirtualNetworkGateway": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat" }, "etag": { "type": "string", "description": "Gets a unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "A common class for general resource information" }, "VpnClientParameters": { "properties": { "ProcessorArchitecture": { "type": "string", "description": "VPN client Processor Architecture. Possible values are: 'AMD64' and 'X86'.", "enum": [ "Amd64", "X86" ], "x-ms-enum": { "name": "ProcessorArchitecture", "modelAsString": true } } }, "description": "VpnClientParameters" }, "VirtualNetworkGatewayListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualNetworkGateway" }, "description": "Gets a list of VirtualNetworkGateway resources that exists in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for the ListVirtualNetworkGateways API service call." }, "VirtualNetworkGatewayConnectionPropertiesFormat": { "properties": { "authorizationKey": { "type": "string", "description": "The authorizationKey." }, "virtualNetworkGateway1": { "$ref": "#/definitions/VirtualNetworkGateway" }, "virtualNetworkGateway2": { "$ref": "#/definitions/VirtualNetworkGateway" }, "localNetworkGateway2": { "$ref": "#/definitions/LocalNetworkGateway" }, "connectionType": { "type": "string", "description": "Gateway connection type. Possible values are: 'IPsec','Vnet2Vnet','ExpressRoute', and 'VPNClient.", "enum": [ "IPsec", "Vnet2Vnet", "ExpressRoute", "VPNClient" ], "x-ms-enum": { "name": "VirtualNetworkGatewayConnectionType", "modelAsString": true } }, "routingWeight": { "type": "integer", "format": "int32", "description": "The routing weight." }, "sharedKey": { "type": "string", "description": "The IPSec shared key." }, "connectionStatus": { "type": "string", "description": "Virtual network Gateway connection status. Possible values are 'Unknown', 'Connecting', 'Connected' and 'NotConnected'.", "enum": [ "Unknown", "Connecting", "Connected", "NotConnected" ], "x-ms-enum": { "name": "VirtualNetworkGatewayConnectionStatus", "modelAsString": true } }, "egressBytesTransferred": { "type": "integer", "format": "int64", "description": "The egress bytes transferred in this connection." }, "ingressBytesTransferred": { "type": "integer", "format": "int64", "description": "The ingress bytes transferred in this connection." }, "peer": { "$ref": "./network.json#/definitions/SubResource", "description": "The reference to peerings resource." }, "enableBgp": { "type": "boolean", "description": "EnableBgp flag" }, "resourceGuid": { "type": "string", "description": "The resource GUID property of the VirtualNetworkGatewayConnection resource." }, "provisioningState": { "type": "string", "description": "The provisioning state of the VirtualNetworkGatewayConnection resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." } }, "description": "VirtualNetworkGatewayConnection properties" }, "VirtualNetworkGatewayConnection": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat" }, "etag": { "type": "string", "description": "Gets a unique read-only string that changes whenever the resource is updated." } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "A common class for general resource information" }, "ConnectionSharedKeyResult": { "properties": { "value": { "type": "string", "description": "The virtual network connection shared key value" } }, "description": "Response for CheckConnectionSharedKey API service call" }, "VirtualNetworkGatewayConnectionListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/VirtualNetworkGatewayConnection" }, "description": "Gets a list of VirtualNetworkGatewayConnection resources that exists in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for the ListVirtualNetworkGatewayConnections API service call" }, "ConnectionResetSharedKey": { "properties": { "keyLength": { "type": "integer", "format": "int64", "description": "The virtual network connection reset shared key length" } } }, "ConnectionSharedKey": { "properties": { "value": { "type": "string", "description": "The virtual network connection shared key value" } }, "description": "Response for GetConnectionSharedKey API service call" }, "LocalNetworkGatewayPropertiesFormat": { "properties": { "localNetworkAddressSpace": { "$ref": "./virtualNetwork.json#/definitions/AddressSpace", "description": "Local network site address space." }, "gatewayIpAddress": { "type": "string", "description": "IP address of local network gateway." }, "bgpSettings": { "$ref": "#/definitions/BgpSettings", "description": "Local network gateway's BGP speaker settings." }, "resourceGuid": { "type": "string", "description": "The resource GUID property of the LocalNetworkGateway resource." }, "provisioningState": { "type": "string", "description": "Gets or sets Provisioning state of the LocalNetworkGateway resource Updating/Deleting/Failed" } }, "description": "LocalNetworkGateway properties" }, "LocalNetworkGateway": { "properties": { "properties": { "x-ms-client-flatten": true, "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat" }, "etag": { "type": "string", "description": "Gets a unique read-only string that changes whenever the resource is updated" } }, "allOf": [ { "$ref": "./network.json#/definitions/Resource" } ], "description": "A common class for general resource information" }, "LocalNetworkGatewayListResult": { "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/LocalNetworkGateway" }, "description": "A list of local network gateways that exists in a resource group." }, "nextLink": { "type": "string", "description": "The URL to get the next set of results." } }, "description": "Response for ListLocalNetworkGateways API service call." } }, "parameters": { "SubscriptionIdParameter": { "name": "subscriptionId", "in": "path", "required": true, "type": "string", "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "Client API version." } } }