@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.13 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* NSX Segment
*
* Uses Azure REST API version 2023-09-01. In version 2.x of the Azure Native provider, it used API version 2022-05-01.
*
* Other available API versions: 2022-05-01, 2023-03-01, 2024-09-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native avs [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class WorkloadNetworkSegment extends pulumi.CustomResource {
/**
* Get an existing WorkloadNetworkSegment resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): WorkloadNetworkSegment;
/**
* Returns true if the given object is an instance of WorkloadNetworkSegment. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is WorkloadNetworkSegment;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Gateway which to connect segment to.
*/
readonly connectedGateway: pulumi.Output<string | undefined>;
/**
* Display name of the segment.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Port Vif which segment is associated with.
*/
readonly portVif: pulumi.Output<outputs.avs.WorkloadNetworkSegmentPortVifResponse[]>;
/**
* The provisioning state
*/
readonly provisioningState: pulumi.Output<string>;
/**
* NSX revision number.
*/
readonly revision: pulumi.Output<number | undefined>;
/**
* Segment status.
*/
readonly status: pulumi.Output<string>;
/**
* Subnet which to connect segment to.
*/
readonly subnet: pulumi.Output<outputs.avs.WorkloadNetworkSegmentSubnetResponse | undefined>;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: pulumi.Output<outputs.avs.SystemDataResponse>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* Create a WorkloadNetworkSegment resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: WorkloadNetworkSegmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a WorkloadNetworkSegment resource.
*/
export interface WorkloadNetworkSegmentArgs {
/**
* Gateway which to connect segment to.
*/
connectedGateway?: pulumi.Input<string>;
/**
* Display name of the segment.
*/
displayName?: pulumi.Input<string>;
/**
* Name of the private cloud
*/
privateCloudName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* NSX revision number.
*/
revision?: pulumi.Input<number>;
/**
* The ID of the NSX Segment
*/
segmentId?: pulumi.Input<string>;
/**
* Subnet which to connect segment to.
*/
subnet?: pulumi.Input<inputs.avs.WorkloadNetworkSegmentSubnetArgs>;
}