swagger: '2.0'
info:
version: 2020-08-01-preview
title: Microsoft Azure AccessControlClient AccessConnector Networks API
schemes:
- https
tags:
- name: Networks
paths:
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks/{networkName}
: put:
operationId: microsoftAzureNetworkCreate
x-ms-examples:
Network_Create:
$ref: ./examples/NetworkCreateOrUpdate.json
summary: Microsoft Azure Creates Or Updates A Network Resource
description: Creates a network resource with the specified name and description. If a network with the same name already exists, then its description is updated to the one indicated in this request.
Use network resources to create private network and configure public connectivity for services within your application.
parameters:
- $ref: '#/parameters/subscriptionIdRequiredPathParam'
- $ref: '#/parameters/api-versionRequiredQueryParam'
- $ref: '#/parameters/ResourceGroupNameRequiredPathParam'
- $ref: '#/parameters/NetworkNameRequiredPathParam'
- $ref: '#/parameters/NetworkResourceDescriptionRequiredBodyParam'
tags:
- Networks
responses:
'200':
description: Ok
schema:
$ref: '#/definitions/NetworkResourceDescription'
'201':
description: Created
schema:
$ref: '#/definitions/NetworkResourceDescription'
default:
description: Error
schema:
$ref: '#/definitions/ErrorModel'
get:
operationId: microsoftAzureNetworkGet
x-ms-examples:
NetworkGet:
$ref: ./examples/NetworkGet.json
summary: Microsoft Azure Gets The Network Resource
description: Gets the information about the network resource with a given name. This information includes the network description and other runtime information.
parameters:
- $ref: '#/parameters/subscriptionIdRequiredPathParam'
- $ref: '#/parameters/api-versionRequiredQueryParam'
- $ref: '#/parameters/ResourceGroupNameRequiredPathParam'
- $ref: '#/parameters/NetworkNameRequiredPathParam'
tags:
- Networks
responses:
'200':
description: OK
schema:
$ref: '#/definitions/NetworkResourceDescription'
default:
description: Error
schema:
$ref: '#/definitions/ErrorModel'
delete:
operationId: microsoftAzureNetworkDelete
x-ms-examples:
NetworkDelete:
$ref: ./examples/NetworkDelete.json
summary: Microsoft Azure Deletes The Network Resource
description: Deletes the network resource identified by the name.
parameters:
- $ref: '#/parameters/subscriptionIdRequiredPathParam'
- $ref: '#/parameters/api-versionRequiredQueryParam'
- $ref: '#/parameters/ResourceGroupNameRequiredPathParam'
- $ref: '#/parameters/NetworkNameRequiredPathParam'
tags:
- Networks
responses:
'200':
description: OK
'204':
description: No Content - the specified network was not found.
default:
description: Error
schema:
$ref: '#/definitions/ErrorModel'
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabricMesh/networks:
get:
operationId: microsoftAzureNetworkListbyresourcegroup
x-ms-examples:
NetworksList:
$ref: ./examples/NetworksByResourceGroup.json
summary: Microsoft Azure Gets All The Network Resources In A Given Resource Group
description: Gets the information about all network resources in a given resource group. The information includes the network description and other runtime properties.
parameters:
- $ref: '#/parameters/subscriptionIdRequiredPathParam'
- $ref: '#/parameters/api-versionRequiredQueryParam'
- $ref: '#/parameters/ResourceGroupNameRequiredPathParam'
tags:
- Networks
responses:
'200':
description: OK
schema:
$ref: '#/definitions/NetworkResourceDescriptionList'
default:
description: Error
schema:
$ref: '#/definitions/ErrorModel'
x-ms-pageable:
nextLinkName: nextLink
/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabricMesh/networks:
get:
operationId: microsoftAzureNetworkListbysubscription
x-ms-examples:
NetworksList:
$ref: ./examples/NetworksBySubscriptionId.json
summary: Microsoft Azure Gets All The Network Resources In A Given Subscription
description: Gets the information about all network resources in a given subscription. The information includes the network description and other runtime properties.
parameters:
- $ref: '#/parameters/subscriptionIdRequiredPathParam'
- $ref: '#/parameters/api-versionRequiredQueryParam'
tags:
- Networks
responses:
'200':
description: OK
schema:
$ref: '#/definitions/NetworkResourceDescriptionList'
default:
description: Error
schema:
$ref: '#/definitions/ErrorModel'
x-ms-pageable:
nextLinkName: nextLink
definitions:
Layer4IngressConfig:
description: Describes the layer4 configuration for public connectivity for this network.
type: object
properties:
name:
type: string
description: Layer4 ingress config name.
publicPort:
type: integer
description: Specifies the public port at which the service endpoint below needs to be exposed.
applicationName:
type: string
description: The application name which contains the service to be exposed.
serviceName:
type: string
description: The service whose endpoint needs to be exposed at the public port.
endpointName:
type: string
description: The service endpoint that needs to be exposed.
Resource:
description: The resource model definition for Azure Resource Manager resource.
properties:
id:
readOnly: true
type: string
description: Fully qualified identifier for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
x-ms-mutability:
- read
name:
readOnly: true
type: string
description: The name of the resource
x-ms-mutability:
- read
type:
readOnly: true
type: string
description: The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts.
x-ms-mutability:
- read
location:
type: string
x-ms-mutability:
- read
- create
description: The geo-location where the resource lives
x-ms-azure-resource: true
ProvisionedResourceProperties:
description: Describes common properties of a provisioned resource.
properties:
provisioningState:
type: string
description: State of the resource.
readOnly: true
IngressConfig:
description: Describes public connectivity configuration for the network.
type: object
properties:
qosLevel:
type: string
description: The QoS tier for ingress.
enum:
- Bronze
x-ms-enum:
name: IngressQoSLevel
modelAsString: true
layer4:
description: Configuration for layer4 public connectivity for this network.
type: array
items:
$ref: '#/definitions/Layer4IngressConfig'
publicIPAddress:
type: string
readOnly: true
description: The public IP address for reaching this network.
NetworkResourceDescription:
description: This type describes a network resource.
allOf:
- $ref: '#/definitions/TrackedResource'
properties:
properties:
x-ms-client-flatten: true
$ref: '#/definitions/NetworkResourceProperties'
description: Describes properties of a network resource.
required:
- properties
ErrorModel:
properties:
error:
$ref: '#/definitions/ErrorErrorModel'
description: Error model information
description: The error details.
required:
- error
ErrorDetailsModel:
description: Error model details information
properties:
code:
type: string
message:
type: string
description: Error message.
required:
- code
- message
ErrorErrorModel:
description: Error model information
properties:
code:
type: string
message:
type: string
description: Error message.
innerError:
type: string
details:
type: array
description: List of error message details.
items:
$ref: '#/definitions/ErrorDetailsModel'
required:
- code
NetworkResourceProperties:
description: Describes properties of a network resource.
allOf:
- $ref: '#/definitions/ProvisionedResourceProperties'
- $ref: '#/definitions/NetworkProperties'
TrackedResource:
description: The resource model definition for Azure Resource Manager tracked top-level resource.
allOf:
- $ref: '#/definitions/Resource'
properties:
tags:
type: object
additionalProperties:
type: string
x-ms-mutability:
- read
- create
- update
description: Resource tags.
location:
type: string
x-ms-mutability:
- read
- create
description: The geo-location where the resource lives
required:
- location
NetworkResourceDescriptionList:
description: A pageable list of network resources.
type: object
properties:
value:
type: array
items:
$ref: '#/definitions/NetworkResourceDescription'
description: One page of the list.
nextLink:
type: string
description: URI to fetch the next page of the list.
NetworkProperties:
description: Describes a network.
type: object
properties:
description:
description: User readable description of the network.
type: string
addressPrefix:
description: the address prefix for this network.
type: string
ingressConfig:
$ref: '#/definitions/IngressConfig'
description: Configuration for public connectivity for this network.
required:
- addressPrefix
parameters:
ResourceGroupNameRequiredPathParam:
name: resourceGroupName
in: path
description: Azure resource group name
required: true
type: string
x-ms-parameter-location: method
NetworkResourceDescriptionRequiredBodyParam:
name: networkResourceDescription
in: body
description: Description for creating a network resource.
required: true
x-ms-parameter-location: method
schema:
$ref: '#/definitions/NetworkResourceDescription'
subscriptionIdRequiredPathParam:
name: subscriptionId
in: path
description: The customer subscription identifier
required: true
type: string
api-versionRequiredQueryParam:
name: api-version
in: query
type: string
enum:
- 2018-07-01-preview
default: 2018-07-01-preview
description: The version of the API. This parameter is required and its value must be `2018-07-01-preview`.
required: true
x-ms-enum:
name: 2018-07-01-preview
modelAsString: true
values:
- value: 2018-07-01-preview
description: The `2018-07-01-preview` version of the API.
NetworkNameRequiredPathParam:
name: networkName
in: path
x-ms-parameter-location: method
x-ms-skip-url-encoding: true
type: string
required: true
description: The identity of the network.
x-ms-parameterized-host:
hostTemplate: '{endpoint}'
useSchemePrefix: false
parameters:
- $ref: '#/parameters/Endpoint'