1. Packages
  2. Azure Native
  3. API Docs
  4. sql
  5. JobPrivateEndpoint
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.sql.JobPrivateEndpoint

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    A job agent private endpoint. Azure REST API version: 2023-05-01-preview.

    Other available API versions: 2023-08-01-preview.

    Example Usage

    Create a private endpoint.

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var jobPrivateEndpoint = new AzureNative.Sql.JobPrivateEndpoint("jobPrivateEndpoint", new()
        {
            JobAgentName = "agent1",
            PrivateEndpointName = "endpoint1",
            ResourceGroupName = "group1",
            ServerName = "server1",
            TargetServerAzureResourceId = "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/targetserver1",
        });
    
    });
    
    package main
    
    import (
    	sql "github.com/pulumi/pulumi-azure-native-sdk/sql/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := sql.NewJobPrivateEndpoint(ctx, "jobPrivateEndpoint", &sql.JobPrivateEndpointArgs{
    			JobAgentName:                pulumi.String("agent1"),
    			PrivateEndpointName:         pulumi.String("endpoint1"),
    			ResourceGroupName:           pulumi.String("group1"),
    			ServerName:                  pulumi.String("server1"),
    			TargetServerAzureResourceId: pulumi.String("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/targetserver1"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azurenative.sql.JobPrivateEndpoint;
    import com.pulumi.azurenative.sql.JobPrivateEndpointArgs;
    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) {
            var jobPrivateEndpoint = new JobPrivateEndpoint("jobPrivateEndpoint", JobPrivateEndpointArgs.builder()
                .jobAgentName("agent1")
                .privateEndpointName("endpoint1")
                .resourceGroupName("group1")
                .serverName("server1")
                .targetServerAzureResourceId("/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/targetserver1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    job_private_endpoint = azure_native.sql.JobPrivateEndpoint("jobPrivateEndpoint",
        job_agent_name="agent1",
        private_endpoint_name="endpoint1",
        resource_group_name="group1",
        server_name="server1",
        target_server_azure_resource_id="/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/targetserver1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const jobPrivateEndpoint = new azure_native.sql.JobPrivateEndpoint("jobPrivateEndpoint", {
        jobAgentName: "agent1",
        privateEndpointName: "endpoint1",
        resourceGroupName: "group1",
        serverName: "server1",
        targetServerAzureResourceId: "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/targetserver1",
    });
    
    resources:
      jobPrivateEndpoint:
        type: azure-native:sql:JobPrivateEndpoint
        properties:
          jobAgentName: agent1
          privateEndpointName: endpoint1
          resourceGroupName: group1
          serverName: server1
          targetServerAzureResourceId: /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/group1/providers/Microsoft.Sql/servers/targetserver1
    

    Create JobPrivateEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new JobPrivateEndpoint(name: string, args: JobPrivateEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def JobPrivateEndpoint(resource_name: str,
                           args: JobPrivateEndpointArgs,
                           opts: Optional[ResourceOptions] = None)
    
    @overload
    def JobPrivateEndpoint(resource_name: str,
                           opts: Optional[ResourceOptions] = None,
                           job_agent_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           server_name: Optional[str] = None,
                           target_server_azure_resource_id: Optional[str] = None,
                           private_endpoint_name: Optional[str] = None)
    func NewJobPrivateEndpoint(ctx *Context, name string, args JobPrivateEndpointArgs, opts ...ResourceOption) (*JobPrivateEndpoint, error)
    public JobPrivateEndpoint(string name, JobPrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public JobPrivateEndpoint(String name, JobPrivateEndpointArgs args)
    public JobPrivateEndpoint(String name, JobPrivateEndpointArgs args, CustomResourceOptions options)
    
    type: azure-native:sql:JobPrivateEndpoint
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args JobPrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args JobPrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args JobPrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args JobPrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args JobPrivateEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var jobPrivateEndpointResource = new AzureNative.Sql.JobPrivateEndpoint("jobPrivateEndpointResource", new()
    {
        JobAgentName = "string",
        ResourceGroupName = "string",
        ServerName = "string",
        TargetServerAzureResourceId = "string",
        PrivateEndpointName = "string",
    });
    
    example, err := sql.NewJobPrivateEndpoint(ctx, "jobPrivateEndpointResource", &sql.JobPrivateEndpointArgs{
    	JobAgentName:                pulumi.String("string"),
    	ResourceGroupName:           pulumi.String("string"),
    	ServerName:                  pulumi.String("string"),
    	TargetServerAzureResourceId: pulumi.String("string"),
    	PrivateEndpointName:         pulumi.String("string"),
    })
    
    var jobPrivateEndpointResource = new JobPrivateEndpoint("jobPrivateEndpointResource", JobPrivateEndpointArgs.builder()
        .jobAgentName("string")
        .resourceGroupName("string")
        .serverName("string")
        .targetServerAzureResourceId("string")
        .privateEndpointName("string")
        .build());
    
    job_private_endpoint_resource = azure_native.sql.JobPrivateEndpoint("jobPrivateEndpointResource",
        job_agent_name="string",
        resource_group_name="string",
        server_name="string",
        target_server_azure_resource_id="string",
        private_endpoint_name="string")
    
    const jobPrivateEndpointResource = new azure_native.sql.JobPrivateEndpoint("jobPrivateEndpointResource", {
        jobAgentName: "string",
        resourceGroupName: "string",
        serverName: "string",
        targetServerAzureResourceId: "string",
        privateEndpointName: "string",
    });
    
    type: azure-native:sql:JobPrivateEndpoint
    properties:
        jobAgentName: string
        privateEndpointName: string
        resourceGroupName: string
        serverName: string
        targetServerAzureResourceId: string
    

    JobPrivateEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The JobPrivateEndpoint resource accepts the following input properties:

    JobAgentName string
    The name of the job agent.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    TargetServerAzureResourceId string
    ARM resource id of the server the private endpoint will target.
    PrivateEndpointName string
    The name of the private endpoint.
    JobAgentName string
    The name of the job agent.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ServerName string
    The name of the server.
    TargetServerAzureResourceId string
    ARM resource id of the server the private endpoint will target.
    PrivateEndpointName string
    The name of the private endpoint.
    jobAgentName String
    The name of the job agent.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    targetServerAzureResourceId String
    ARM resource id of the server the private endpoint will target.
    privateEndpointName String
    The name of the private endpoint.
    jobAgentName string
    The name of the job agent.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName string
    The name of the server.
    targetServerAzureResourceId string
    ARM resource id of the server the private endpoint will target.
    privateEndpointName string
    The name of the private endpoint.
    job_agent_name str
    The name of the job agent.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    server_name str
    The name of the server.
    target_server_azure_resource_id str
    ARM resource id of the server the private endpoint will target.
    private_endpoint_name str
    The name of the private endpoint.
    jobAgentName String
    The name of the job agent.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    serverName String
    The name of the server.
    targetServerAzureResourceId String
    ARM resource id of the server the private endpoint will target.
    privateEndpointName String
    The name of the private endpoint.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the JobPrivateEndpoint resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    PrivateEndpointId string
    Private endpoint id of the private endpoint.
    Type string
    Resource type.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    PrivateEndpointId string
    Private endpoint id of the private endpoint.
    Type string
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    privateEndpointId String
    Private endpoint id of the private endpoint.
    type String
    Resource type.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    privateEndpointId string
    Private endpoint id of the private endpoint.
    type string
    Resource type.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    private_endpoint_id str
    Private endpoint id of the private endpoint.
    type str
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    privateEndpointId String
    Private endpoint id of the private endpoint.
    type String
    Resource type.

    Import

    An existing resource can be imported using its type token, name, and identifier, e.g.

    $ pulumi import azure-native:sql:JobPrivateEndpoint endpoint1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/jobAgents/{jobAgentName}/privateEndpoints/{privateEndpointName} 
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi