Integration Runtimes - List Outbound Network Dependencies Endpoints

Service:

Synapse

API Version:

2021-06-01-preview

Gets list of outbound network dependencies for a given Azure-SSIS integration runtime.
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.Synapse/workspaces/{workspaceName}/integrationRuntimes/{integrationRuntimeName}/outboundNetworkDependenciesEndpoints?api-version=2021-06-01-preview

URI Parameters

Name	In	Required	Type	Description
integrationRuntimeName	path	True	string	Integration runtime name
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string	The ID of the target subscription.
workspaceName	path	True	string	The name of the workspace.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse	OK.
Other Status Codes	ErrorResponse	An error response received from the Azure Synapse service.

Examples

Get outbound network dependency endpoints

Sample Request

HTTP

GET https://management.azure.com/subscriptions/ade9c2b6-c160-4305-9bb9-80342f6c1ae2/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspace/integrationRuntimes/exampleIntegrationRuntime/outboundNetworkDependenciesEndpoints?api-version=2021-06-01-preview

Java

/** Samples for IntegrationRuntimes ListOutboundNetworkDependenciesEndpoints. */
public final class Main {
    /*
     * x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json
     */
    /**
     * Sample code: Get outbound network dependency endpoints.
     *
     * @param manager Entry point to SynapseManager.
     */
    public static void getOutboundNetworkDependencyEndpoints(com.azure.resourcemanager.synapse.SynapseManager manager) {
        manager
            .integrationRuntimes()
            .listOutboundNetworkDependenciesEndpointsWithResponse(
                "exampleResourceGroup",
                "exampleWorkspace",
                "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.synapse import SynapseManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-synapse
# 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 = SynapseManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="ade9c2b6-c160-4305-9bb9-80342f6c1ae2",
    )

    response = client.integration_runtimes.list_outbound_network_dependencies_endpoints(
        resource_group_name="exampleResourceGroup",
        workspace_name="exampleWorkspace",
        integration_runtime_name="exampleIntegrationRuntime",
    )
    print(response)


# x-ms-original-file: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/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 armsynapse_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/synapse/armsynapse"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/630ec444f8dd7c09b9cdd5fa99951f8a0d1ad41f/specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/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 := armsynapse.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewIntegrationRuntimesClient().ListOutboundNetworkDependenciesEndpoints(ctx, "exampleResourceGroup", "exampleWorkspace", "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 = armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointsResponse{
	// 	Value: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint{
	// 		{
	// 			Category: to.Ptr("Azure Data Factory (Management)"),
	// 			Endpoints: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("wu.frontend.int.clouddatahub-int.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 		},
	// 		{
	// 			Category: to.Ptr("Azure Storage (Management)"),
	// 			Endpoints: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("*.blob.core.windows.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 				},
	// 				{
	// 					DomainName: to.Ptr("*.table.core.windows.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 		},
	// 		{
	// 			Category: to.Ptr("Event Hub (Logging)"),
	// 			Endpoints: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("*.servicebus.windows.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 			}},
	// 		},
	// 		{
	// 			Category: to.Ptr("Microsoft Logging service (Internal Use)"),
	// 			Endpoints: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpoint{
	// 				{
	// 					DomainName: to.Ptr("gcs.prod.monitoring.core.windows.net"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 				},
	// 				{
	// 					DomainName: to.Ptr("prod.warmpath.msftcloudes.com"),
	// 					EndpointDetails: []*armsynapse.IntegrationRuntimeOutboundNetworkDependenciesEndpointDetails{
	// 						{
	// 							Port: to.Ptr[int32](443),
	// 					}},
	// 				},
	// 				{
	// 					DomainName: to.Ptr("azurewatsonanalysis-prod.core.windows.net"),
	// 					EndpointDetails: []*armsynapse.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 { SynapseManagementClient } = require("@azure/arm-synapse");
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/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/examples/IntegrationRuntimes_ListOutboundNetworkDependenciesEndpoints.json
 */
async function getOutboundNetworkDependencyEndpoints() {
  const subscriptionId =
    process.env["SYNAPSE_SUBSCRIPTION_ID"] || "ade9c2b6-c160-4305-9bb9-80342f6c1ae2";
  const resourceGroupName = process.env["SYNAPSE_RESOURCE_GROUP"] || "exampleResourceGroup";
  const workspaceName = "exampleWorkspace";
  const integrationRuntimeName = "exampleIntegrationRuntime";
  const credential = new DefaultAzureCredential();
  const client = new SynapseManagementClient(credential, subscriptionId);
  const result = await client.integrationRuntimes.listOutboundNetworkDependenciesEndpoints(
    resourceGroupName,
    workspaceName,
    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 Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Synapse;
using Azure.ResourceManager.Synapse.Models;

// Generated from example definition: specification/synapse/resource-manager/Microsoft.Synapse/preview/2021-06-01-preview/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 SynapseIntegrationRuntimeResource created on azure
// for more information of creating SynapseIntegrationRuntimeResource, please refer to the document of SynapseIntegrationRuntimeResource
string subscriptionId = "ade9c2b6-c160-4305-9bb9-80342f6c1ae2";
string resourceGroupName = "exampleResourceGroup";
string workspaceName = "exampleWorkspace";
string integrationRuntimeName = "exampleIntegrationRuntime";
ResourceIdentifier synapseIntegrationRuntimeResourceId = SynapseIntegrationRuntimeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, workspaceName, integrationRuntimeName);
SynapseIntegrationRuntimeResource synapseIntegrationRuntime = client.GetSynapseIntegrationRuntimeResource(synapseIntegrationRuntimeResourceId);

// invoke the operation and iterate over the result
await foreach (SynapseIntegrationRuntimeOutboundNetworkDependenciesCategoryEndpoint item in synapseIntegrationRuntime.GetOutboundNetworkDependenciesEndpointsAsync())
{
    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
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	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.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

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.