Allowed Connections - Get

Gets the list of all possible traffic between resources for the subscription and location, based on connection type.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/allowedConnections/{connectionType}?api-version=2020-01-01

URI Parameters

Name In Required Type Description
ascLocation
path True

string

The location where ASC stores the data of the subscription. can be retrieved from Get locations

connectionType
path True

connectionType

The type of allowed connections (Internal, External)

resourceGroupName
path True

string

The name of the resource group within the user's subscription. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True

string

Azure subscription ID

Regex pattern: ^[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}$

api-version
query True

string

API version for the operation

Responses

Name Type Description
200 OK

AllowedConnectionsResource

OK

Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get allowed connections

Sample request

GET https://management.azure.com/subscriptions/3eeab341-f466-499c-a8be-85427e154bad/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal?api-version=2020-01-01

Sample response

{
  "type": "Microsoft.Security/locations/allowedConnections",
  "properties": {
    "calculatedDateTime": "2018-08-06T14:55:32.3518545Z",
    "connectableResources": [
      {
        "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1",
        "inboundConnectedResources": [
          {
            "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2",
            "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]",
            "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]"
          }
        ],
        "outboundConnectedResources": [
          {
            "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2",
            "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]",
            "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]"
          }
        ]
      },
      {
        "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine2",
        "inboundConnectedResources": [
          {
            "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1",
            "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]",
            "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]"
          }
        ],
        "outboundConnectedResources": [
          {
            "connectedResourceId": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine1",
            "tcpPorts": "[0-21,23-3388,3390-5984,5987-65535]",
            "udpPorts": "[0-21,23-3388,3390-5984,5987-65535]"
          }
        ]
      },
      {
        "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/virtaulMachine3",
        "inboundConnectedResources": [],
        "outboundConnectedResources": []
      }
    ]
  },
  "id": "/subscriptions/3eeab341-f466-499c-a8be-85427e154baf/resourceGroups/myResourceGroup/providers/Microsoft.Security/locations/centralus/allowedConnections/Internal",
  "name": "Internal",
  "location": "centralus"
}

Definitions

Name Description
AllowedConnectionsResource

The resource whose properties describes the allowed traffic between Azure resources

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

CloudErrorBody

The error detail.

ConnectableResource

Describes the allowed inbound and outbound traffic of an Azure resource

ConnectedResource

Describes properties of a connected resource

connectionType

The type of allowed connections (Internal, External)

ErrorAdditionalInfo

The resource management error additional info.

AllowedConnectionsResource

The resource whose properties describes the allowed traffic between Azure resources

Name Type Description
id

string

Resource Id

location

string

Location where the resource is stored

name

string

Resource name

properties.calculatedDateTime

string

The UTC time on which the allowed connections resource was calculated

properties.connectableResources

ConnectableResource[]

List of connectable resources

type

string

Resource type

CloudError

Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).

Name Type Description
error.additionalInfo

ErrorAdditionalInfo[]

The error additional info.

error.code

string

The error code.

error.details

CloudErrorBody[]

The error details.

error.message

string

The error message.

error.target

string

The error target.

CloudErrorBody

The error detail.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.

code

string

The error code.

details

CloudErrorBody[]

The error details.

message

string

The error message.

target

string

The error target.

ConnectableResource

Describes the allowed inbound and outbound traffic of an Azure resource

Name Type Description
id

string

The Azure resource id

inboundConnectedResources

ConnectedResource[]

The list of Azure resources that the resource has inbound allowed connection from

outboundConnectedResources

ConnectedResource[]

The list of Azure resources that the resource has outbound allowed connection to

ConnectedResource

Describes properties of a connected resource

Name Type Description
connectedResourceId

string

The Azure resource id of the connected resource

tcpPorts

string

The allowed tcp ports

udpPorts

string

The allowed udp ports

connectionType

The type of allowed connections (Internal, External)

Name Type Description
External

string

Internal

string

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.

type

string

The additional info type.