Integration Runtimes - List Outbound Network Dependencies Endpoints

Service:

Data Factory

API Version:

2018-06-01

Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataFactory/factories/{factoryName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints?api-version=2018-06-01

URI Parameters

Name	In	Required	Type	Description
factoryName	path	True	string	The factory name. Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
integrationRuntimeName	path	True	string	The integration runtime name. Regex pattern: ^[A-Za-z0-9]+(?:-[A-Za-z0-9]+)*$
resourceGroupName	path	True	string	The resource group name. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	The subscription identifier.
api-version	query	True	string	The API version.

Responses

Name	Type	Description
200 OK	IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse	OK.
Other Status Codes	CloudError	An error response received from the Azure Data Factory service.

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

IntegrationRuntimes_OutboundNetworkDependenciesEndpoints

Sample Request

HTTP

GET https://management.azure.com/subscriptions/7ad7c73b-38b8-4df3-84ee-52ff91092f61/resourceGroups/exampleResourceGroup/providers/Microsoft.DataFactory/factories/exampleFactoryName/integrationRuntimes/exampleIntegrationRuntime/outboundNetworkDependenciesEndpoints?api-version=2018-06-01

Java

/**
 * Samples for IntegrationRuntimes ListOutboundNetworkDependenciesEndpoints.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/
     * IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json
     */
    /**
     * Sample code: IntegrationRuntimes_OutboundNetworkDependenciesEndpoints.
     * 
     * @param manager Entry point to DataFactoryManager.
     */
    public static void integrationRuntimesOutboundNetworkDependenciesEndpoints(
        com.azure.resourcemanager.datafactory.DataFactoryManager manager) {
        manager.integrationRuntimes().listOutboundNetworkDependenciesEndpointsWithResponse("exampleResourceGroup",
            "exampleFactoryName", "exampleIntegrationRuntime", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.datafactory import DataFactoryManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datafactory
# USAGE
    python integration_runtimes_list_outbound_network_dependencies_endpoints.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataFactoryManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="7ad7c73b-38b8-4df3-84ee-52ff91092f61",
    )

    response = client.integration_runtimes.list_outbound_network_dependencies_endpoints(
        resource_group_name="exampleResourceGroup",
        factory_name="exampleFactoryName",
        integration_runtime_name="exampleIntegrationRuntime",
    )
    print(response)


# x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdatafactory_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datafactory/armdatafactory/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json
func ExampleIntegrationRuntimesClient_ListOutboundNetworkDependenciesEndpoints() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatafactory.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimesClient().ListOutboundNetworkDependenciesEndpoints(ctx, "exampleResourceGroup", "exampleFactoryName", "exampleIntegrationRuntime", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse = armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse{
	// 	Value: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint{
	// 		{
	// 			Category: to.Ptr("Azure Data Factory (Management)"),
	// 			Endpoints: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("wu.frontend.int.clouddatahub-int.net"),
	// 					EndpointDetails: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 		},
	// 		{
	// 			Category: to.Ptr("Azure Storage (Management)"),
	// 			Endpoints: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("*.blob.core.windows.net"),
	// 					EndpointDetails: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 				},
	// 				{
	// 					DomainName: to.Ptr("*.table.core.windows.net"),
	// 					EndpointDetails: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 		},
	// 		{
	// 			Category: to.Ptr("Event Hub (Logging)"),
	// 			Endpoints: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("*.servicebus.windows.net"),
	// 					EndpointDetails: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 		},
	// 		{
	// 			Category: to.Ptr("Microsoft Logging service (Internal Use)"),
	// 			Endpoints: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("gcs.prod.monitoring.core.windows.net"),
	// 					EndpointDetails: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 				},
	// 				{
	// 					DomainName: to.Ptr("prod.warmpath.msftcloudes.com"),
	// 					EndpointDetails: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 				},
	// 				{
	// 					DomainName: to.Ptr("azurewatsonanalysis-prod.core.windows.net"),
	// 					EndpointDetails: []*armdatafactory.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 	}},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { DataFactoryManagementClient } = require("@azure/arm-datafactory");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
 *
 * @summary Gets the list of outbound network dependencies for a given Azure-SSIS integration runtime.
 * x-ms-original-file: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json
 */
async function integrationRuntimesOutboundNetworkDependenciesEndpoints() {
  const subscriptionId =
    process.env["DATAFACTORY_SUBSCRIPTION_ID"] || "7ad7c73b-38b8-4df3-84ee-52ff91092f61";
  const resourceGroupName = process.env["DATAFACTORY_RESOURCE_GROUP"] || "exampleResourceGroup";
  const factoryName = "exampleFactoryName";
  const integrationRuntimeName = "exampleIntegrationRuntime";
  const credential = new DefaultAzureCredential();
  const client = new DataFactoryManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimes.listOutboundNetworkDependenciesEndpoints(
    resourceGroupName,
    factoryName,
    integrationRuntimeName,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataFactory;
using Azure.ResourceManager.DataFactory.Models;

// Generated from example definition: specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json
// this example is just showing the usage of "IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataFactoryIntegrationRuntimeResource created on azure
// for more information of creating DataFactoryIntegrationRuntimeResource, please refer to the document of DataFactoryIntegrationRuntimeResource
string subscriptionId = "7ad7c73b-38b8-4df3-84ee-52ff91092f61";
string resourceGroupName = "exampleResourceGroup";
string factoryName = "exampleFactoryName";
string integrationRuntimeName = "exampleIntegrationRuntime";
ResourceIdentifier dataFactoryIntegrationRuntimeResourceId = DataFactoryIntegrationRuntimeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, factoryName, integrationRuntimeName);
DataFactoryIntegrationRuntimeResource dataFactoryIntegrationRuntime = client.GetDataFactoryIntegrationRuntimeResource(dataFactoryIntegrationRuntimeResourceId);

// invoke the operation and iterate over the result
await foreach (IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint item in dataFactoryIntegrationRuntime.GetOutboundNetworkDependenciesAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

Date: Tue, 06 Jul 2021 04:28:10 GMT
X-Content-Type-Options: nosniff
x-ms-request-id: fd8e4223-7e9c-4f32-893f-06c14a8081be
x-ms-correlation-request-id: 1dabf122-e061-4703-ae9e-9edeeef40ee6

Response Body

{
  "value": [
    {
      "category": "Azure Data Factory (Management)",
      "endpoints": [
        {
          "domainName": "wu.frontend.int.clouddatahub-int.net",
          "endpointDetails": [
            {
              "port": 443
            }
          ]
        }
      ]
    },
    {
      "category": "Azure Storage (Management)",
      "endpoints": [
        {
          "domainName": "*.blob.core.windows.net",
          "endpointDetails": [
            {
              "port": 443
            }
          ]
        },
        {
          "domainName": "*.table.core.windows.net",
          "endpointDetails": [
            {
              "port": 443
            }
          ]
        }
      ]
    },
    {
      "category": "Event Hub (Logging)",
      "endpoints": [
        {
          "domainName": "*.servicebus.windows.net",
          "endpointDetails": [
            {
              "port": 443
            }
          ]
        }
      ]
    },
    {
      "category": "Microsoft Logging service (Internal Use)",
      "endpoints": [
        {
          "domainName": "gcs.prod.monitoring.core.windows.net",
          "endpointDetails": [
            {
              "port": 443
            }
          ]
        },
        {
          "domainName": "prod.warmpath.msftcloudes.com",
          "endpointDetails": [
            {
              "port": 443
            }
          ]
        },
        {
          "domainName": "azurewatsonanalysis-prod.core.windows.net",
          "endpointDetails": [
            {
              "port": 443
            }
          ]
        }
      ]
    }
  ]
}

Definitions

Name	Description
CloudError	The object that defines the structure of an Azure Data Factory error response.
IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint	Azure-SSIS integration runtime outbound network dependency endpoints for one category.
IntegrationRuntimeOutboundNetworkDependenciesEndpoint	The endpoint for Azure-SSIS integration runtime outbound network dependency.
IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails	The details of Azure-SSIS integration runtime outbound network dependency endpoint.
IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse	Azure-SSIS integration runtime outbound network dependency endpoints.

CloudError

The object that defines the structure of an Azure Data Factory error response.

Name	Type	Description
error.code	string	Error code.
error.details	CloudError[]	Array with additional error details.
error.message	string	Error message.
error.target	string	Property name/path in request associated with error.

IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint

Azure-SSIS integration runtime outbound network dependency endpoints for one category.

Name	Type	Description
category	string	The category of outbound network dependency.
endpoints	IntegrationRuntimeOutboundNetworkDependenciesEndpoint[]	The endpoints for outbound network dependency.

IntegrationRuntimeOutboundNetworkDependenciesEndpoint

The endpoint for Azure-SSIS integration runtime outbound network dependency.

Name	Type	Description
domainName	string	The domain name of endpoint.
endpointDetails	IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails[]	The details of endpoint.

IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails

The details of Azure-SSIS integration runtime outbound network dependency endpoint.

Name	Type	Description
port	integer	The port of endpoint.

IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse

Azure-SSIS integration runtime outbound network dependency endpoints.

Name	Type	Description
value	IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint[]	The list of outbound network dependency endpoints.