NetworkAdminManagementClient
Network admin operation endpoints and objects
COMMUNITYBEARER0 INSTALLS
OpenAPI Specificationv3.0
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "adminmanagement.local.azurestack.external",
"info": {
"description": "Network admin operation endpoints and objects.",
"title": "NetworkAdminManagementClient",
"version": "2015-06-15",
"x-apisguru-categories": [
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/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/network/Microsoft.Network.Admin/preview/2015-06-15/Network.json",
"version": "2.0"
}
],
"x-providerName": "azure.com",
"x-serviceName": "azsadmin-Network",
"x-tags": [
"Azure",
"Microsoft"
]
},
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"securityDefinitions": {
"azure_auth": {
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"description": "Azure Active Directory OAuth2 flow.",
"flow": "implicit",
"scopes": {
"user_impersonation": "impersonate your user account"
},
"type": "oauth2"
}
},
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"parameters": {
"ApiVersionParameter": {
"default": "2015-06-15",
"description": "Client API Version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
},
"FilterParameter": {
"description": "OData filter parameter.",
"in": "query",
"name": "$filter",
"type": "string",
"x-ms-parameter-location": "method"
},
"InlineCountParameter": {
"description": "OData inline count parameter.",
"in": "query",
"name": "$inlineCount",
"type": "string",
"x-ms-parameter-location": "method"
},
"LocationParameter": {
"description": "Location of the resource.",
"in": "path",
"name": "location",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"OrderByParameter": {
"description": "OData orderBy parameter.",
"in": "query",
"name": "$orderBy",
"type": "string",
"x-ms-parameter-location": "method"
},
"ResourceNameParameter": {
"description": "Name of the resource.",
"in": "path",
"name": "resourceName",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"SkipParameter": {
"description": "OData skip parameter.",
"in": "query",
"name": "$skip",
"type": "string",
"x-ms-parameter-location": "method"
},
"SubscriptionIdParameter": {
"description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
"TopParameter": {
"description": "OData top parameter.",
"in": "query",
"name": "$top",
"type": "string",
"x-ms-parameter-location": "method"
}
},
"paths": {
"/providers/Microsoft.Network.Admin/locations": {
"get": {
"description": "Returns the list of supported locations",
"operationId": "OnPremLocations_List",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/LocationsList"
}
}
},
"tags": [
"Network"
],
"x-ms-examples": {
"Returns the list of supported locations.": {
"parameters": {
"api-version": "2015-06-15",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
},
"responses": {
"200": {
"body": {
"nextLink": "",
"value": []
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Network.Admin/locations/{location}/operationResults": {
"get": {
"description": "Returns the list of operation results for a location",
"operationId": "LocationsOperationResults_List",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/LocationParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OperationResultList"
}
}
},
"tags": [
"Network"
],
"x-ms-examples": {
"Returns the list of operation results for a location": {
"parameters": {
"api-version": "2015-06-15",
"location": "westus",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
},
"responses": {
"200": {
"body": {
"nextLink": "",
"value": []
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Network.Admin/locations/{location}/operations": {
"get": {
"description": "Returns the list of support REST operations.",
"operationId": "LocationsOperations_List",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"$ref": "#/parameters/LocationParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OperationList"
}
}
},
"tags": [
"Network"
],
"x-ms-examples": {
"Returns the list of support REST operations.": {
"parameters": {
"api-version": "2015-06-15",
"location": "westus",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
},
"responses": {
"200": {
"body": {
"nextLink": "",
"value": []
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Network.Admin/operations": {
"get": {
"description": "Returns the list of support REST operations.",
"operationId": "Operations_List",
"parameters": [
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OperationList"
}
}
},
"tags": [
"Network"
],
"x-ms-examples": {
"Returns the list of support REST operations.": {
"parameters": {
"api-version": "2015-06-15",
"subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23"
},
"responses": {
"200": {
"body": {
"nextLink": "",
"value": []
}
}
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Network.Admin/adminOverview": {
"get": {
"description": "Get an overview of the state of the network resource provider.",
"operationId": "ResourceProviderState_Get",
"parameters": [
{
"description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.",
"in": "path",
"name": "subscriptionId",
"required": true,
"type": "string"
},
{
"default": "2015-06-15",
"description": "Client API Version.",
"in": "query",
"name": "api-version",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/AdminOverview"
}
}
},
"tags": [
"Network"
],
"x-ms-examples": {
"Get overview of the state of the network resource provider": {
"parameters": {
"api-version": "2015-06-15",
"subscriptionId": "fc8456aa-4843-4079-a152-f3497c63aa73"
},
"responses": {
"200": {
"body": {
"id": "/subscriptions/fc8456aa-4843-4079-a152-f3497c63aa73/providers/Microsoft.Network.Admin/adminOverview/",
"location": "",
"name": "",
"properties": {
"backendIpUsage": {
"inUseResourceCount": 11,
"totalResourceCount": 411
},
"loadBalancerMuxHealth": {
"errorResourceCount": 0,
"healthUnknownCount": 0,
"healthyResourceCount": 1,
"totalResourceCount": 1,
"warningResourceCount": 0
},
"macAddressUsage": {
"inUseResourceCount": 2,
"totalResourceCount": 3998720
},
"provisioningState": "Succeeded",
"publicIpAddressUsage": {
"inUseResourceCount": 31,
"totalResourceCount": 255
},
"virtualGatewayHealth": {
"errorResourceCount": 0,
"healthUnknownCount": 0,
"healthyResourceCount": 1,
"totalResourceCount": 1,
"warningResourceCount": 0
},
"virtualNetworkHealth": {
"errorResourceCount": 0,
"healthUnknownCount": 0,
"healthyResourceCount": 0,
"totalResourceCount": 0,
"warningResourceCount": 0
}
},
"type": "Microsoft.Network.Admin/adminOverview"
}
}
}
}
}
}
}
},
"definitions": {
"AdminOverview": {
"allOf": [
{
"$ref": "#/definitions/Resource"
}
],
"description": "Admin overview resource object.",
"properties": {
"properties": {
"$ref": "#/definitions/AdminOverviewProperties",
"description": "Admin overview properties.",
"x-ms-client-flatten": true
}
}
},
"AdminOverviewProperties": {
"description": "Admin overview properties.",
"properties": {
"backendIpUsage": {
"$ref": "#/definitions/AdminOverviewResourceUsage",
"description": "Total Backend IP usage as reported by the NC."
},
"loadBalancerMuxHealth": {
"$ref": "#/definitions/AdminOverviewResourceHealth",
"description": "Health for all LB MUXes as reported by the NC."
},
"macAddressUsage": {
"$ref": "#/definitions/AdminOverviewResourceUsage",
"description": "Total MAC address usage as reported by the NC."
},
"provisioningState": {
"description": "The provisioning state.",
"readOnly": true,
"type": "string"
},
"publicIpAddressUsage": {
"$ref": "#/definitions/AdminOverviewResourceUsage",
"description": "Total Public IP usage as reported by the NC."
},
"virtualGatewayHealth": {
"$ref": "#/definitions/AdminOverviewResourceHealth",
"description": "Health for all gateways as reported by the NC."
},
"virtualNetworkHealth": {
"$ref": "#/definitions/AdminOverviewResourceHealth",
"description": "Health for all virtual networks as reported by the NC."
}
}
},
"AdminOverviewResourceHealth": {
"description": "Resource health information.",
"properties": {
"errorResourceCount": {
"description": "Number of resources in the error state.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"healthUnknownCount": {
"description": "Number of resources in an unknown state.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"healthyResourceCount": {
"description": "Number of resources in the success state.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"totalResourceCount": {
"description": "Total number of resources.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"warningResourceCount": {
"description": "Number of resources in the warning state.",
"format": "int64",
"readOnly": true,
"type": "integer"
}
}
},
"AdminOverviewResourceUsage": {
"description": "Resource usage information.",
"properties": {
"inUseResourceCount": {
"description": "Number of resources in use.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"totalResourceCount": {
"description": "Total number of resources.",
"format": "int64",
"readOnly": true,
"type": "integer"
}
}
},
"Display": {
"description": "Contains the localized display information for this particular operation / action.",
"properties": {
"description": {
"description": "The localized, friendly description for the operation. The description will be displayed to the user. It should be thorough and concise for used in both tooltips and detailed views.",
"readOnly": true,
"type": "string"
},
"operation": {
"description": "The localized, friendly name for the operation. Use the name as it will displayed to the user.",
"readOnly": true,
"type": "string"
},
"provider": {
"description": "The localized friendly form of the resource provider name – it is expected to also include the publisher/company responsible. It should use Title Casing and begin with \"Microsoft\" for 1st party services. e.g. \"Microsoft Monitoring Insights\" or \"Microsoft Compute.\"",
"readOnly": true,
"type": "string"
},
"resource": {
"description": "The localized, friendly version of the resource type related to this action or operation; the resource type should match the public documentation for the resource provider.",
"readOnly": true,
"type": "string"
}
}
},
"Location": {
"description": "Describes the supported Location",
"properties": {
"name": {
"description": "The name of the location the operation is being held.",
"readOnly": true,
"type": "string"
}
}
},
"LocationsList": {
"description": "List of Locations",
"properties": {
"nextLink": {
"description": "URI to the next page of locations.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Array of locations",
"items": {
"$ref": "#/definitions/Location"
},
"readOnly": true,
"type": "array"
}
}
},
"Operation": {
"description": "Describes the supported REST operation.",
"properties": {
"display": {
"$ref": "#/definitions/Display",
"description": "Contains the localized display information for this particular operation / action.",
"readOnly": true
},
"name": {
"description": "The name of the operation being performed on this particular object. This name should match the name that appears in RBAC or the event service.",
"readOnly": true,
"type": "string"
}
}
},
"OperationList": {
"description": "List of Operations",
"properties": {
"nextLink": {
"description": "URI to the next page of operations.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Array of operations",
"items": {
"$ref": "#/definitions/Operation"
},
"readOnly": true,
"type": "array"
}
}
},
"OperationResult": {
"description": "Describes results of a given operation",
"properties": {
"name": {
"description": "The name of the operation being performed on this particular object.",
"readOnly": true,
"type": "string"
}
}
},
"OperationResultList": {
"description": "List of Operation Results",
"properties": {
"nextLink": {
"description": "URI to the next page of operations.",
"readOnly": true,
"type": "string"
},
"value": {
"description": "Array of operation results",
"items": {
"$ref": "#/definitions/OperationResult"
},
"readOnly": true,
"type": "array"
}
}
},
"ProvisionedResource": {
"description": "Objects which have a provisioning state.",
"properties": {
"provisioningState": {
"description": "The provisioning state.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Resource": {
"description": "Base Resource Object",
"properties": {
"id": {
"description": "URI of the resource.",
"readOnly": true,
"type": "string"
},
"location": {
"description": "Region location of resource.",
"readOnly": true,
"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
},
"TenantResource": {
"description": "These resources are utilized by a single tenant.",
"properties": {
"subscriptionId": {
"description": "The subscription ID.",
"readOnly": true,
"type": "string"
},
"tenantResourceUri": {
"description": "The tenant resource URI.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
}
}