1. Packages
  2. Azure Native
  3. API Docs
  4. avs
  5. WorkloadNetworkDhcp
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.76.0 published on Friday, Dec 6, 2024 by Pulumi

azure-native.avs.WorkloadNetworkDhcp

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.76.0 published on Friday, Dec 6, 2024 by Pulumi

    NSX DHCP Azure REST API version: 2022-05-01. Prior API version in Azure Native 1.x: 2020-07-17-preview.

    Other available API versions: 2021-01-01-preview, 2023-03-01, 2023-09-01.

    Example Usage

    WorkloadNetworks_CreateDhcp

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AzureNative = Pulumi.AzureNative;
    
    return await Deployment.RunAsync(() => 
    {
        var workloadNetworkDhcp = new AzureNative.AVS.WorkloadNetworkDhcp("workloadNetworkDhcp", new()
        {
            DhcpId = "dhcp1",
            PrivateCloudName = "cloud1",
            Properties = new AzureNative.AVS.Inputs.WorkloadNetworkDhcpServerArgs
            {
                DhcpType = "SERVER",
                DisplayName = "dhcpConfigurations1",
                LeaseTime = 86400,
                Revision = 1,
                ServerAddress = "40.1.5.1/24",
            },
            ResourceGroupName = "group1",
        });
    
    });
    
    package main
    
    import (
    	avs "github.com/pulumi/pulumi-azure-native-sdk/avs/v2"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := avs.NewWorkloadNetworkDhcp(ctx, "workloadNetworkDhcp", &avs.WorkloadNetworkDhcpArgs{
    			DhcpId:           pulumi.String("dhcp1"),
    			PrivateCloudName: pulumi.String("cloud1"),
    			Properties: &avs.WorkloadNetworkDhcpServerArgs{
    				DhcpType:      pulumi.String("SERVER"),
    				DisplayName:   pulumi.String("dhcpConfigurations1"),
    				LeaseTime:     pulumi.Float64(86400),
    				Revision:      pulumi.Float64(1),
    				ServerAddress: pulumi.String("40.1.5.1/24"),
    			},
    			ResourceGroupName: pulumi.String("group1"),
    		})
    		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.avs.WorkloadNetworkDhcp;
    import com.pulumi.azurenative.avs.WorkloadNetworkDhcpArgs;
    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 workloadNetworkDhcp = new WorkloadNetworkDhcp("workloadNetworkDhcp", WorkloadNetworkDhcpArgs.builder()
                .dhcpId("dhcp1")
                .privateCloudName("cloud1")
                .properties(WorkloadNetworkDhcpRelayArgs.builder()
                    .dhcpType("SERVER")
                    .displayName("dhcpConfigurations1")
                    .leaseTime(86400)
                    .revision(1)
                    .serverAddress("40.1.5.1/24")
                    .build())
                .resourceGroupName("group1")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_azure_native as azure_native
    
    workload_network_dhcp = azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcp",
        dhcp_id="dhcp1",
        private_cloud_name="cloud1",
        properties={
            "dhcp_type": "SERVER",
            "display_name": "dhcpConfigurations1",
            "lease_time": 86400,
            "revision": 1,
            "server_address": "40.1.5.1/24",
        },
        resource_group_name="group1")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure_native from "@pulumi/azure-native";
    
    const workloadNetworkDhcp = new azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcp", {
        dhcpId: "dhcp1",
        privateCloudName: "cloud1",
        properties: {
            dhcpType: "SERVER",
            displayName: "dhcpConfigurations1",
            leaseTime: 86400,
            revision: 1,
            serverAddress: "40.1.5.1/24",
        },
        resourceGroupName: "group1",
    });
    
    resources:
      workloadNetworkDhcp:
        type: azure-native:avs:WorkloadNetworkDhcp
        properties:
          dhcpId: dhcp1
          privateCloudName: cloud1
          properties:
            dhcpType: SERVER
            displayName: dhcpConfigurations1
            leaseTime: 86400
            revision: 1
            serverAddress: 40.1.5.1/24
          resourceGroupName: group1
    

    Create WorkloadNetworkDhcp Resource

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

    Constructor syntax

    new WorkloadNetworkDhcp(name: string, args: WorkloadNetworkDhcpArgs, opts?: CustomResourceOptions);
    @overload
    def WorkloadNetworkDhcp(resource_name: str,
                            args: WorkloadNetworkDhcpArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def WorkloadNetworkDhcp(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            private_cloud_name: Optional[str] = None,
                            resource_group_name: Optional[str] = None,
                            dhcp_id: Optional[str] = None,
                            properties: Optional[Union[WorkloadNetworkDhcpRelayArgs, WorkloadNetworkDhcpServerArgs]] = None)
    func NewWorkloadNetworkDhcp(ctx *Context, name string, args WorkloadNetworkDhcpArgs, opts ...ResourceOption) (*WorkloadNetworkDhcp, error)
    public WorkloadNetworkDhcp(string name, WorkloadNetworkDhcpArgs args, CustomResourceOptions? opts = null)
    public WorkloadNetworkDhcp(String name, WorkloadNetworkDhcpArgs args)
    public WorkloadNetworkDhcp(String name, WorkloadNetworkDhcpArgs args, CustomResourceOptions options)
    
    type: azure-native:avs:WorkloadNetworkDhcp
    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 WorkloadNetworkDhcpArgs
    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 WorkloadNetworkDhcpArgs
    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 WorkloadNetworkDhcpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkloadNetworkDhcpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkloadNetworkDhcpArgs
    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 workloadNetworkDhcpResource = new AzureNative.AVS.WorkloadNetworkDhcp("workloadNetworkDhcpResource", new()
    {
        PrivateCloudName = "string",
        ResourceGroupName = "string",
        DhcpId = "string",
        Properties = new AzureNative.AVS.Inputs.WorkloadNetworkDhcpRelayArgs
        {
            DhcpType = "RELAY",
            DisplayName = "string",
            Revision = 0,
            ServerAddresses = new[]
            {
                "string",
            },
        },
    });
    
    example, err := avs.NewWorkloadNetworkDhcp(ctx, "workloadNetworkDhcpResource", &avs.WorkloadNetworkDhcpArgs{
    	PrivateCloudName:  pulumi.String("string"),
    	ResourceGroupName: pulumi.String("string"),
    	DhcpId:            pulumi.String("string"),
    	Properties: &avs.WorkloadNetworkDhcpRelayArgs{
    		DhcpType:    pulumi.String("RELAY"),
    		DisplayName: pulumi.String("string"),
    		Revision:    pulumi.Float64(0),
    		ServerAddresses: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    	},
    })
    
    var workloadNetworkDhcpResource = new WorkloadNetworkDhcp("workloadNetworkDhcpResource", WorkloadNetworkDhcpArgs.builder()
        .privateCloudName("string")
        .resourceGroupName("string")
        .dhcpId("string")
        .properties(WorkloadNetworkDhcpRelayArgs.builder()
            .dhcpType("RELAY")
            .displayName("string")
            .revision(0)
            .serverAddresses("string")
            .build())
        .build());
    
    workload_network_dhcp_resource = azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcpResource",
        private_cloud_name="string",
        resource_group_name="string",
        dhcp_id="string",
        properties={
            "dhcp_type": "RELAY",
            "display_name": "string",
            "revision": 0,
            "server_addresses": ["string"],
        })
    
    const workloadNetworkDhcpResource = new azure_native.avs.WorkloadNetworkDhcp("workloadNetworkDhcpResource", {
        privateCloudName: "string",
        resourceGroupName: "string",
        dhcpId: "string",
        properties: {
            dhcpType: "RELAY",
            displayName: "string",
            revision: 0,
            serverAddresses: ["string"],
        },
    });
    
    type: azure-native:avs:WorkloadNetworkDhcp
    properties:
        dhcpId: string
        privateCloudName: string
        properties:
            dhcpType: RELAY
            displayName: string
            revision: 0
            serverAddresses:
                - string
        resourceGroupName: string
    

    WorkloadNetworkDhcp Resource Properties

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

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkloadNetworkDhcp resource accepts the following input properties:

    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DhcpId string
    NSX DHCP identifier. Generally the same as the DHCP display name
    Properties Pulumi.AzureNative.AVS.Inputs.WorkloadNetworkDhcpRelay | Pulumi.AzureNative.AVS.Inputs.WorkloadNetworkDhcpServer
    DHCP properties.
    PrivateCloudName string
    Name of the private cloud
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DhcpId string
    NSX DHCP identifier. Generally the same as the DHCP display name
    Properties WorkloadNetworkDhcpRelayArgs | WorkloadNetworkDhcpServerArgs
    DHCP properties.
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    dhcpId String
    NSX DHCP identifier. Generally the same as the DHCP display name
    properties WorkloadNetworkDhcpRelay | WorkloadNetworkDhcpServer
    DHCP properties.
    privateCloudName string
    Name of the private cloud
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    dhcpId string
    NSX DHCP identifier. Generally the same as the DHCP display name
    properties WorkloadNetworkDhcpRelay | WorkloadNetworkDhcpServer
    DHCP properties.
    private_cloud_name str
    Name of the private cloud
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    dhcp_id str
    NSX DHCP identifier. Generally the same as the DHCP display name
    properties WorkloadNetworkDhcpRelayArgs | WorkloadNetworkDhcpServerArgs
    DHCP properties.
    privateCloudName String
    Name of the private cloud
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    dhcpId String
    NSX DHCP identifier. Generally the same as the DHCP display name
    properties Property Map | Property Map
    DHCP properties.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    Type string
    Resource type.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Resource name.
    Type string
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    type String
    Resource type.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Resource name.
    type string
    Resource type.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Resource name.
    type str
    Resource type.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Resource name.
    type String
    Resource type.

    Supporting Types

    WorkloadNetworkDhcpRelay, WorkloadNetworkDhcpRelayArgs

    DisplayName string
    Display name of the DHCP entity.
    Revision double
    NSX revision number.
    ServerAddresses List<string>
    DHCP Relay Addresses. Max 3.
    DisplayName string
    Display name of the DHCP entity.
    Revision float64
    NSX revision number.
    ServerAddresses []string
    DHCP Relay Addresses. Max 3.
    displayName String
    Display name of the DHCP entity.
    revision Double
    NSX revision number.
    serverAddresses List<String>
    DHCP Relay Addresses. Max 3.
    displayName string
    Display name of the DHCP entity.
    revision number
    NSX revision number.
    serverAddresses string[]
    DHCP Relay Addresses. Max 3.
    display_name str
    Display name of the DHCP entity.
    revision float
    NSX revision number.
    server_addresses Sequence[str]
    DHCP Relay Addresses. Max 3.
    displayName String
    Display name of the DHCP entity.
    revision Number
    NSX revision number.
    serverAddresses List<String>
    DHCP Relay Addresses. Max 3.

    WorkloadNetworkDhcpRelayResponse, WorkloadNetworkDhcpRelayResponseArgs

    ProvisioningState string
    The provisioning state
    Segments List<string>
    NSX Segments consuming DHCP.
    DisplayName string
    Display name of the DHCP entity.
    Revision double
    NSX revision number.
    ServerAddresses List<string>
    DHCP Relay Addresses. Max 3.
    ProvisioningState string
    The provisioning state
    Segments []string
    NSX Segments consuming DHCP.
    DisplayName string
    Display name of the DHCP entity.
    Revision float64
    NSX revision number.
    ServerAddresses []string
    DHCP Relay Addresses. Max 3.
    provisioningState String
    The provisioning state
    segments List<String>
    NSX Segments consuming DHCP.
    displayName String
    Display name of the DHCP entity.
    revision Double
    NSX revision number.
    serverAddresses List<String>
    DHCP Relay Addresses. Max 3.
    provisioningState string
    The provisioning state
    segments string[]
    NSX Segments consuming DHCP.
    displayName string
    Display name of the DHCP entity.
    revision number
    NSX revision number.
    serverAddresses string[]
    DHCP Relay Addresses. Max 3.
    provisioning_state str
    The provisioning state
    segments Sequence[str]
    NSX Segments consuming DHCP.
    display_name str
    Display name of the DHCP entity.
    revision float
    NSX revision number.
    server_addresses Sequence[str]
    DHCP Relay Addresses. Max 3.
    provisioningState String
    The provisioning state
    segments List<String>
    NSX Segments consuming DHCP.
    displayName String
    Display name of the DHCP entity.
    revision Number
    NSX revision number.
    serverAddresses List<String>
    DHCP Relay Addresses. Max 3.

    WorkloadNetworkDhcpServer, WorkloadNetworkDhcpServerArgs

    DisplayName string
    Display name of the DHCP entity.
    LeaseTime double
    DHCP Server Lease Time.
    Revision double
    NSX revision number.
    ServerAddress string
    DHCP Server Address.
    DisplayName string
    Display name of the DHCP entity.
    LeaseTime float64
    DHCP Server Lease Time.
    Revision float64
    NSX revision number.
    ServerAddress string
    DHCP Server Address.
    displayName String
    Display name of the DHCP entity.
    leaseTime Double
    DHCP Server Lease Time.
    revision Double
    NSX revision number.
    serverAddress String
    DHCP Server Address.
    displayName string
    Display name of the DHCP entity.
    leaseTime number
    DHCP Server Lease Time.
    revision number
    NSX revision number.
    serverAddress string
    DHCP Server Address.
    display_name str
    Display name of the DHCP entity.
    lease_time float
    DHCP Server Lease Time.
    revision float
    NSX revision number.
    server_address str
    DHCP Server Address.
    displayName String
    Display name of the DHCP entity.
    leaseTime Number
    DHCP Server Lease Time.
    revision Number
    NSX revision number.
    serverAddress String
    DHCP Server Address.

    WorkloadNetworkDhcpServerResponse, WorkloadNetworkDhcpServerResponseArgs

    ProvisioningState string
    The provisioning state
    Segments List<string>
    NSX Segments consuming DHCP.
    DisplayName string
    Display name of the DHCP entity.
    LeaseTime double
    DHCP Server Lease Time.
    Revision double
    NSX revision number.
    ServerAddress string
    DHCP Server Address.
    ProvisioningState string
    The provisioning state
    Segments []string
    NSX Segments consuming DHCP.
    DisplayName string
    Display name of the DHCP entity.
    LeaseTime float64
    DHCP Server Lease Time.
    Revision float64
    NSX revision number.
    ServerAddress string
    DHCP Server Address.
    provisioningState String
    The provisioning state
    segments List<String>
    NSX Segments consuming DHCP.
    displayName String
    Display name of the DHCP entity.
    leaseTime Double
    DHCP Server Lease Time.
    revision Double
    NSX revision number.
    serverAddress String
    DHCP Server Address.
    provisioningState string
    The provisioning state
    segments string[]
    NSX Segments consuming DHCP.
    displayName string
    Display name of the DHCP entity.
    leaseTime number
    DHCP Server Lease Time.
    revision number
    NSX revision number.
    serverAddress string
    DHCP Server Address.
    provisioning_state str
    The provisioning state
    segments Sequence[str]
    NSX Segments consuming DHCP.
    display_name str
    Display name of the DHCP entity.
    lease_time float
    DHCP Server Lease Time.
    revision float
    NSX revision number.
    server_address str
    DHCP Server Address.
    provisioningState String
    The provisioning state
    segments List<String>
    NSX Segments consuming DHCP.
    displayName String
    Display name of the DHCP entity.
    leaseTime Number
    DHCP Server Lease Time.
    revision Number
    NSX revision number.
    serverAddress String
    DHCP Server Address.

    Import

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

    $ pulumi import azure-native:avs:WorkloadNetworkDhcp dhcp1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/workloadNetworks/default/dhcpConfigurations/{dhcpId} 
    

    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.76.0 published on Friday, Dec 6, 2024 by Pulumi