Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azuredevops Provider
  3. API Docs
  4. getServiceEndpointAzureRM
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

azuredevops.getServiceEndpointAzureRM

Explore with Pulumi AI

azuredevops logo
Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
pulumi/pulumi-azuredevops

    Use this data source to access information about an existing AzureRM service Endpoint.

    Example Usage

    By Service Endpoint ID

    import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const sample = azuredevops.getProject({
    name: "Sample Project",
});
const serviceendpoint = sample.then(sample => azuredevops.getServiceEndpointAzureRM({
    projectId: sample.id,
    serviceEndpointId: "00000000-0000-0000-0000-000000000000",
}));
export const serviceEndpointName = serviceendpoint.then(serviceendpoint => serviceendpoint.serviceEndpointName);

    import pulumi
import pulumi_azuredevops as azuredevops

sample = azuredevops.get_project(name="Sample Project")
serviceendpoint = azuredevops.get_service_endpoint_azure_rm(project_id=sample.id,
    service_endpoint_id="00000000-0000-0000-0000-000000000000")
pulumi.export("serviceEndpointName", serviceendpoint.service_endpoint_name)

    package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sample, err := azuredevops.LookupProject(ctx, &azuredevops.LookupProjectArgs{
			Name: pulumi.StringRef("Sample Project"),
		}, nil)
		if err != nil {
			return err
		}
		serviceendpoint, err := azuredevops.LookupServiceEndpointAzureRM(ctx, &azuredevops.LookupServiceEndpointAzureRMArgs{
			ProjectId:         sample.Id,
			ServiceEndpointId: pulumi.StringRef("00000000-0000-0000-0000-000000000000"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("serviceEndpointName", serviceendpoint.ServiceEndpointName)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var sample = AzureDevOps.GetProject.Invoke(new()
    {
        Name = "Sample Project",
    });

    var serviceendpoint = AzureDevOps.GetServiceEndpointAzureRM.Invoke(new()
    {
        ProjectId = sample.Apply(getProjectResult => getProjectResult.Id),
        ServiceEndpointId = "00000000-0000-0000-0000-000000000000",
    });

    return new Dictionary<string, object?>
    {
        ["serviceEndpointName"] = serviceendpoint.Apply(getServiceEndpointAzureRMResult => getServiceEndpointAzureRMResult.ServiceEndpointName),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.AzuredevopsFunctions;
import com.pulumi.azuredevops.inputs.GetProjectArgs;
import com.pulumi.azuredevops.inputs.GetServiceEndpointAzureRMArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var sample = AzuredevopsFunctions.getProject(GetProjectArgs.builder()
            .name("Sample Project")
            .build());

        final var serviceendpoint = AzuredevopsFunctions.getServiceEndpointAzureRM(GetServiceEndpointAzureRMArgs.builder()
            .projectId(sample.applyValue(getProjectResult -> getProjectResult.id()))
            .serviceEndpointId("00000000-0000-0000-0000-000000000000")
            .build());

        ctx.export("serviceEndpointName", serviceendpoint.applyValue(getServiceEndpointAzureRMResult -> getServiceEndpointAzureRMResult.serviceEndpointName()));
    }
}

    variables:
  sample:
    fn::invoke:
      Function: azuredevops:getProject
      Arguments:
        name: Sample Project
  serviceendpoint:
    fn::invoke:
      Function: azuredevops:getServiceEndpointAzureRM
      Arguments:
        projectId: ${sample.id}
        serviceEndpointId: 00000000-0000-0000-0000-000000000000
outputs:
  serviceEndpointName: ${serviceendpoint.serviceEndpointName}

    By Service Endpoint Name

    import * as pulumi from "@pulumi/pulumi";
import * as azuredevops from "@pulumi/azuredevops";

const sample = azuredevops.getProject({
    name: "Sample Project",
});
const serviceendpoint = sample.then(sample => azuredevops.getServiceEndpointAzureRM({
    projectId: sample.id,
    serviceEndpointName: "Example-Service-Endpoint",
}));
export const serviceEndpointId = serviceendpoint.then(serviceendpoint => serviceendpoint.id);

    import pulumi
import pulumi_azuredevops as azuredevops

sample = azuredevops.get_project(name="Sample Project")
serviceendpoint = azuredevops.get_service_endpoint_azure_rm(project_id=sample.id,
    service_endpoint_name="Example-Service-Endpoint")
pulumi.export("serviceEndpointId", serviceendpoint.id)

    package main

import (
	"github.com/pulumi/pulumi-azuredevops/sdk/v3/go/azuredevops"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		sample, err := azuredevops.LookupProject(ctx, &azuredevops.LookupProjectArgs{
			Name: pulumi.StringRef("Sample Project"),
		}, nil)
		if err != nil {
			return err
		}
		serviceendpoint, err := azuredevops.LookupServiceEndpointAzureRM(ctx, &azuredevops.LookupServiceEndpointAzureRMArgs{
			ProjectId:           sample.Id,
			ServiceEndpointName: pulumi.StringRef("Example-Service-Endpoint"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("serviceEndpointId", serviceendpoint.Id)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureDevOps = Pulumi.AzureDevOps;

return await Deployment.RunAsync(() => 
{
    var sample = AzureDevOps.GetProject.Invoke(new()
    {
        Name = "Sample Project",
    });

    var serviceendpoint = AzureDevOps.GetServiceEndpointAzureRM.Invoke(new()
    {
        ProjectId = sample.Apply(getProjectResult => getProjectResult.Id),
        ServiceEndpointName = "Example-Service-Endpoint",
    });

    return new Dictionary<string, object?>
    {
        ["serviceEndpointId"] = serviceendpoint.Apply(getServiceEndpointAzureRMResult => getServiceEndpointAzureRMResult.Id),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azuredevops.AzuredevopsFunctions;
import com.pulumi.azuredevops.inputs.GetProjectArgs;
import com.pulumi.azuredevops.inputs.GetServiceEndpointAzureRMArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var sample = AzuredevopsFunctions.getProject(GetProjectArgs.builder()
            .name("Sample Project")
            .build());

        final var serviceendpoint = AzuredevopsFunctions.getServiceEndpointAzureRM(GetServiceEndpointAzureRMArgs.builder()
            .projectId(sample.applyValue(getProjectResult -> getProjectResult.id()))
            .serviceEndpointName("Example-Service-Endpoint")
            .build());

        ctx.export("serviceEndpointId", serviceendpoint.applyValue(getServiceEndpointAzureRMResult -> getServiceEndpointAzureRMResult.id()));
    }
}

    variables:
  sample:
    fn::invoke:
      Function: azuredevops:getProject
      Arguments:
        name: Sample Project
  serviceendpoint:
    fn::invoke:
      Function: azuredevops:getServiceEndpointAzureRM
      Arguments:
        projectId: ${sample.id}
        serviceEndpointName: Example-Service-Endpoint
outputs:
  serviceEndpointId: ${serviceendpoint.id}

    Using getServiceEndpointAzureRM

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getServiceEndpointAzureRM(args: GetServiceEndpointAzureRMArgs, opts?: InvokeOptions): Promise<GetServiceEndpointAzureRMResult>
function getServiceEndpointAzureRMOutput(args: GetServiceEndpointAzureRMOutputArgs, opts?: InvokeOptions): Output<GetServiceEndpointAzureRMResult>
    def get_service_endpoint_azure_rm(project_id: Optional[str] = None,
                                  service_endpoint_id: Optional[str] = None,
                                  service_endpoint_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetServiceEndpointAzureRMResult
def get_service_endpoint_azure_rm_output(project_id: Optional[pulumi.Input[str]] = None,
                                  service_endpoint_id: Optional[pulumi.Input[str]] = None,
                                  service_endpoint_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetServiceEndpointAzureRMResult]
    func LookupServiceEndpointAzureRM(ctx *Context, args *LookupServiceEndpointAzureRMArgs, opts ...InvokeOption) (*LookupServiceEndpointAzureRMResult, error)
func LookupServiceEndpointAzureRMOutput(ctx *Context, args *LookupServiceEndpointAzureRMOutputArgs, opts ...InvokeOption) LookupServiceEndpointAzureRMResultOutput

    > Note: This function is named LookupServiceEndpointAzureRM in the Go SDK.

    public static class GetServiceEndpointAzureRM 
{
    public static Task<GetServiceEndpointAzureRMResult> InvokeAsync(GetServiceEndpointAzureRMArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceEndpointAzureRMResult> Invoke(GetServiceEndpointAzureRMInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetServiceEndpointAzureRMResult> getServiceEndpointAzureRM(GetServiceEndpointAzureRMArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azuredevops:index/getServiceEndpointAzureRM:getServiceEndpointAzureRM
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ProjectId string
    The ID of the project.
    ServiceEndpointId string
    the ID of the Service Endpoint.
    ServiceEndpointName string

    the Name of the Service Endpoint.

    NOTE: One of either service_endpoint_id or service_endpoint_name must be specified. NOTE: When supplying service_endpoint_name, take care to ensure that this is a unique name.

    ProjectId string
    The ID of the project.
    ServiceEndpointId string
    the ID of the Service Endpoint.
    ServiceEndpointName string

    the Name of the Service Endpoint.

    NOTE: One of either service_endpoint_id or service_endpoint_name must be specified. NOTE: When supplying service_endpoint_name, take care to ensure that this is a unique name.

    projectId String
    The ID of the project.
    serviceEndpointId String
    the ID of the Service Endpoint.
    serviceEndpointName String

    the Name of the Service Endpoint.

    NOTE: One of either service_endpoint_id or service_endpoint_name must be specified. NOTE: When supplying service_endpoint_name, take care to ensure that this is a unique name.

    projectId string
    The ID of the project.
    serviceEndpointId string
    the ID of the Service Endpoint.
    serviceEndpointName string

    the Name of the Service Endpoint.

    NOTE: One of either service_endpoint_id or service_endpoint_name must be specified. NOTE: When supplying service_endpoint_name, take care to ensure that this is a unique name.

    project_id str
    The ID of the project.
    service_endpoint_id str
    the ID of the Service Endpoint.
    service_endpoint_name str

    the Name of the Service Endpoint.

    NOTE: One of either service_endpoint_id or service_endpoint_name must be specified. NOTE: When supplying service_endpoint_name, take care to ensure that this is a unique name.

    projectId String
    The ID of the project.
    serviceEndpointId String
    the ID of the Service Endpoint.
    serviceEndpointName String

    the Name of the Service Endpoint.

    NOTE: One of either service_endpoint_id or service_endpoint_name must be specified. NOTE: When supplying service_endpoint_name, take care to ensure that this is a unique name.

    getServiceEndpointAzureRM Result

    The following output properties are available:

    Authorization Dictionary<string, string>
    Specifies the Authorization Scheme Map.
    AzurermManagementGroupId string
    Specified the Management Group ID of the Service Endpoint is target, if available.
    AzurermManagementGroupName string
    Specified the Management Group Name of the Service Endpoint target, if available.
    AzurermSpnTenantid string
    Specifies the Tenant ID of the Azure targets.
    AzurermSubscriptionId string
    Specifies the Subscription ID of the Service Endpoint target, if available.
    AzurermSubscriptionName string
    Specifies the Subscription Name of the Service Endpoint target, if available.
    Description string
    Specifies the description of the Service Endpoint.
    Environment string
    The Cloud Environment. Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment, and AzureGermanCloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    ResourceGroup string
    Specifies the Resource Group of the Service Endpoint target, if available.
    ServiceEndpointAuthenticationScheme string
    Specifies the authentication scheme of azurerm endpoint, either WorkloadIdentityFederation, ManagedServiceIdentity or ServicePrincipal.
    ServiceEndpointId string
    ServiceEndpointName string
    ServicePrincipalId string
    The Application(Client) ID of the Service Principal.
    WorkloadIdentityFederationIssuer string
    The issuer if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like https://vstoken.dev.azure.com/f66a4bc2-08ad-4ec0-a25e-e769d6b3b294, where the GUID is the Organization ID of your Azure DevOps Organisation.
    WorkloadIdentityFederationSubject string
    The subject if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like sc://my-organisation/my-project/my-service-connection-name.
    Authorization map[string]string
    Specifies the Authorization Scheme Map.
    AzurermManagementGroupId string
    Specified the Management Group ID of the Service Endpoint is target, if available.
    AzurermManagementGroupName string
    Specified the Management Group Name of the Service Endpoint target, if available.
    AzurermSpnTenantid string
    Specifies the Tenant ID of the Azure targets.
    AzurermSubscriptionId string
    Specifies the Subscription ID of the Service Endpoint target, if available.
    AzurermSubscriptionName string
    Specifies the Subscription Name of the Service Endpoint target, if available.
    Description string
    Specifies the description of the Service Endpoint.
    Environment string
    The Cloud Environment. Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment, and AzureGermanCloud.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    ResourceGroup string
    Specifies the Resource Group of the Service Endpoint target, if available.
    ServiceEndpointAuthenticationScheme string
    Specifies the authentication scheme of azurerm endpoint, either WorkloadIdentityFederation, ManagedServiceIdentity or ServicePrincipal.
    ServiceEndpointId string
    ServiceEndpointName string
    ServicePrincipalId string
    The Application(Client) ID of the Service Principal.
    WorkloadIdentityFederationIssuer string
    The issuer if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like https://vstoken.dev.azure.com/f66a4bc2-08ad-4ec0-a25e-e769d6b3b294, where the GUID is the Organization ID of your Azure DevOps Organisation.
    WorkloadIdentityFederationSubject string
    The subject if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like sc://my-organisation/my-project/my-service-connection-name.
    authorization Map<String,String>
    Specifies the Authorization Scheme Map.
    azurermManagementGroupId String
    Specified the Management Group ID of the Service Endpoint is target, if available.
    azurermManagementGroupName String
    Specified the Management Group Name of the Service Endpoint target, if available.
    azurermSpnTenantid String
    Specifies the Tenant ID of the Azure targets.
    azurermSubscriptionId String
    Specifies the Subscription ID of the Service Endpoint target, if available.
    azurermSubscriptionName String
    Specifies the Subscription Name of the Service Endpoint target, if available.
    description String
    Specifies the description of the Service Endpoint.
    environment String
    The Cloud Environment. Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment, and AzureGermanCloud.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    resourceGroup String
    Specifies the Resource Group of the Service Endpoint target, if available.
    serviceEndpointAuthenticationScheme String
    Specifies the authentication scheme of azurerm endpoint, either WorkloadIdentityFederation, ManagedServiceIdentity or ServicePrincipal.
    serviceEndpointId String
    serviceEndpointName String
    servicePrincipalId String
    The Application(Client) ID of the Service Principal.
    workloadIdentityFederationIssuer String
    The issuer if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like https://vstoken.dev.azure.com/f66a4bc2-08ad-4ec0-a25e-e769d6b3b294, where the GUID is the Organization ID of your Azure DevOps Organisation.
    workloadIdentityFederationSubject String
    The subject if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like sc://my-organisation/my-project/my-service-connection-name.
    authorization {[key: string]: string}
    Specifies the Authorization Scheme Map.
    azurermManagementGroupId string
    Specified the Management Group ID of the Service Endpoint is target, if available.
    azurermManagementGroupName string
    Specified the Management Group Name of the Service Endpoint target, if available.
    azurermSpnTenantid string
    Specifies the Tenant ID of the Azure targets.
    azurermSubscriptionId string
    Specifies the Subscription ID of the Service Endpoint target, if available.
    azurermSubscriptionName string
    Specifies the Subscription Name of the Service Endpoint target, if available.
    description string
    Specifies the description of the Service Endpoint.
    environment string
    The Cloud Environment. Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment, and AzureGermanCloud.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    resourceGroup string
    Specifies the Resource Group of the Service Endpoint target, if available.
    serviceEndpointAuthenticationScheme string
    Specifies the authentication scheme of azurerm endpoint, either WorkloadIdentityFederation, ManagedServiceIdentity or ServicePrincipal.
    serviceEndpointId string
    serviceEndpointName string
    servicePrincipalId string
    The Application(Client) ID of the Service Principal.
    workloadIdentityFederationIssuer string
    The issuer if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like https://vstoken.dev.azure.com/f66a4bc2-08ad-4ec0-a25e-e769d6b3b294, where the GUID is the Organization ID of your Azure DevOps Organisation.
    workloadIdentityFederationSubject string
    The subject if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like sc://my-organisation/my-project/my-service-connection-name.
    authorization Mapping[str, str]
    Specifies the Authorization Scheme Map.
    azurerm_management_group_id str
    Specified the Management Group ID of the Service Endpoint is target, if available.
    azurerm_management_group_name str
    Specified the Management Group Name of the Service Endpoint target, if available.
    azurerm_spn_tenantid str
    Specifies the Tenant ID of the Azure targets.
    azurerm_subscription_id str
    Specifies the Subscription ID of the Service Endpoint target, if available.
    azurerm_subscription_name str
    Specifies the Subscription Name of the Service Endpoint target, if available.
    description str
    Specifies the description of the Service Endpoint.
    environment str
    The Cloud Environment. Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment, and AzureGermanCloud.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    resource_group str
    Specifies the Resource Group of the Service Endpoint target, if available.
    service_endpoint_authentication_scheme str
    Specifies the authentication scheme of azurerm endpoint, either WorkloadIdentityFederation, ManagedServiceIdentity or ServicePrincipal.
    service_endpoint_id str
    service_endpoint_name str
    service_principal_id str
    The Application(Client) ID of the Service Principal.
    workload_identity_federation_issuer str
    The issuer if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like https://vstoken.dev.azure.com/f66a4bc2-08ad-4ec0-a25e-e769d6b3b294, where the GUID is the Organization ID of your Azure DevOps Organisation.
    workload_identity_federation_subject str
    The subject if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like sc://my-organisation/my-project/my-service-connection-name.
    authorization Map<String>
    Specifies the Authorization Scheme Map.
    azurermManagementGroupId String
    Specified the Management Group ID of the Service Endpoint is target, if available.
    azurermManagementGroupName String
    Specified the Management Group Name of the Service Endpoint target, if available.
    azurermSpnTenantid String
    Specifies the Tenant ID of the Azure targets.
    azurermSubscriptionId String
    Specifies the Subscription ID of the Service Endpoint target, if available.
    azurermSubscriptionName String
    Specifies the Subscription Name of the Service Endpoint target, if available.
    description String
    Specifies the description of the Service Endpoint.
    environment String
    The Cloud Environment. Possible values are AzureCloud, AzureChinaCloud, AzureUSGovernment, and AzureGermanCloud.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    resourceGroup String
    Specifies the Resource Group of the Service Endpoint target, if available.
    serviceEndpointAuthenticationScheme String
    Specifies the authentication scheme of azurerm endpoint, either WorkloadIdentityFederation, ManagedServiceIdentity or ServicePrincipal.
    serviceEndpointId String
    serviceEndpointName String
    servicePrincipalId String
    The Application(Client) ID of the Service Principal.
    workloadIdentityFederationIssuer String
    The issuer if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like https://vstoken.dev.azure.com/f66a4bc2-08ad-4ec0-a25e-e769d6b3b294, where the GUID is the Organization ID of your Azure DevOps Organisation.
    workloadIdentityFederationSubject String
    The subject if service_endpoint_authentication_scheme is set to WorkloadIdentityFederation. This looks like sc://my-organisation/my-project/my-service-connection-name.

    Package Details

    Repository
    Azure DevOps pulumi/pulumi-azuredevops
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azuredevops Terraform Provider.
    azuredevops logo
    Azure DevOps v3.4.0 published on Wednesday, Oct 30, 2024 by Pulumi
    pulumi/pulumi-azuredevops