azure-native.managednetworkfabric.NeighborGroup
Explore with Pulumi AI
Defines the Neighbor Group.
Uses Azure REST API version 2023-06-15.
Create NeighborGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NeighborGroup(name: string, args: NeighborGroupArgs, opts?: CustomResourceOptions);
@overload
def NeighborGroup(resource_name: str,
args: NeighborGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NeighborGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
destination: Optional[NeighborGroupDestinationArgs] = None,
resource_group_name: Optional[str] = None,
annotation: Optional[str] = None,
location: Optional[str] = None,
neighbor_group_name: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None)
func NewNeighborGroup(ctx *Context, name string, args NeighborGroupArgs, opts ...ResourceOption) (*NeighborGroup, error)
public NeighborGroup(string name, NeighborGroupArgs args, CustomResourceOptions? opts = null)
public NeighborGroup(String name, NeighborGroupArgs args)
public NeighborGroup(String name, NeighborGroupArgs args, CustomResourceOptions options)
type: azure-native:managednetworkfabric:NeighborGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. NeighborGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. NeighborGroupArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. NeighborGroupArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. NeighborGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. NeighborGroupArgs - 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 neighborGroupResource = new AzureNative.ManagedNetworkFabric.NeighborGroup("neighborGroupResource", new()
{
Destination = new AzureNative.ManagedNetworkFabric.Inputs.NeighborGroupDestinationArgs
{
Ipv4Addresses = new[]
{
"string",
},
Ipv6Addresses = new[]
{
"string",
},
},
ResourceGroupName = "string",
Annotation = "string",
Location = "string",
NeighborGroupName = "string",
Tags =
{
{ "string", "string" },
},
});
example, err := managednetworkfabric.NewNeighborGroup(ctx, "neighborGroupResource", &managednetworkfabric.NeighborGroupArgs{
Destination: &managednetworkfabric.NeighborGroupDestinationArgs{
Ipv4Addresses: pulumi.StringArray{
pulumi.String("string"),
},
Ipv6Addresses: pulumi.StringArray{
pulumi.String("string"),
},
},
ResourceGroupName: pulumi.String("string"),
Annotation: pulumi.String("string"),
Location: pulumi.String("string"),
NeighborGroupName: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
var neighborGroupResource = new NeighborGroup("neighborGroupResource", NeighborGroupArgs.builder()
.destination(NeighborGroupDestinationArgs.builder()
.ipv4Addresses("string")
.ipv6Addresses("string")
.build())
.resourceGroupName("string")
.annotation("string")
.location("string")
.neighborGroupName("string")
.tags(Map.of("string", "string"))
.build());
neighbor_group_resource = azure_native.managednetworkfabric.NeighborGroup("neighborGroupResource",
destination={
"ipv4_addresses": ["string"],
"ipv6_addresses": ["string"],
},
resource_group_name="string",
annotation="string",
location="string",
neighbor_group_name="string",
tags={
"string": "string",
})
const neighborGroupResource = new azure_native.managednetworkfabric.NeighborGroup("neighborGroupResource", {
destination: {
ipv4Addresses: ["string"],
ipv6Addresses: ["string"],
},
resourceGroupName: "string",
annotation: "string",
location: "string",
neighborGroupName: "string",
tags: {
string: "string",
},
});
type: azure-native:managednetworkfabric:NeighborGroup
properties:
annotation: string
destination:
ipv4Addresses:
- string
ipv6Addresses:
- string
location: string
neighborGroupName: string
resourceGroupName: string
tags:
string: string
NeighborGroup 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 NeighborGroup resource accepts the following input properties:
- Destination
This property is required. Pulumi.Azure Native. Managed Network Fabric. Inputs. Neighbor Group Destination - An array of destination IPv4 Addresses or IPv6 Addresses.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Annotation string
- Switch configuration description.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Neighbor
Group Name Changes to this property will trigger replacement.
- Name of the Neighbor Group.
- Dictionary<string, string>
- Resource tags.
- Destination
This property is required. NeighborGroup Destination Args - An array of destination IPv4 Addresses or IPv6 Addresses.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- Annotation string
- Switch configuration description.
- Location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- Neighbor
Group Name Changes to this property will trigger replacement.
- Name of the Neighbor Group.
- map[string]string
- Resource tags.
- destination
This property is required. NeighborGroup Destination - An array of destination IPv4 Addresses or IPv6 Addresses.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- annotation String
- Switch configuration description.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- neighbor
Group Name Changes to this property will trigger replacement.
- Name of the Neighbor Group.
- Map<String,String>
- Resource tags.
- destination
This property is required. NeighborGroup Destination - An array of destination IPv4 Addresses or IPv6 Addresses.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- annotation string
- Switch configuration description.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- neighbor
Group Name Changes to this property will trigger replacement.
- Name of the Neighbor Group.
- {[key: string]: string}
- Resource tags.
- destination
This property is required. NeighborGroup Destination Args - An array of destination IPv4 Addresses or IPv6 Addresses.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- annotation str
- Switch configuration description.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- neighbor_
group_ name Changes to this property will trigger replacement.
- Name of the Neighbor Group.
- Mapping[str, str]
- Resource tags.
- destination
This property is required. Property Map - An array of destination IPv4 Addresses or IPv6 Addresses.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group. The name is case insensitive.
- annotation String
- Switch configuration description.
- location
Changes to this property will trigger replacement.
- The geo-location where the resource lives
- neighbor
Group Name Changes to this property will trigger replacement.
- Name of the Neighbor Group.
- Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the NeighborGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Network
Tap List<string>Ids - List of NetworkTap IDs where neighbor group is associated.
- Network
Tap List<string>Rule Ids - List of Network Tap Rule IDs where neighbor group is associated.
- Provisioning
State string - The provisioning state of the resource.
- System
Data Pulumi.Azure Native. Managed Network Fabric. Outputs. System Data Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- Id string
- The provider-assigned unique ID for this managed resource.
- Name string
- The name of the resource
- Network
Tap []stringIds - List of NetworkTap IDs where neighbor group is associated.
- Network
Tap []stringRule Ids - List of Network Tap Rule IDs where neighbor group is associated.
- Provisioning
State string - The provisioning state of the resource.
- System
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- Type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- network
Tap List<String>Ids - List of NetworkTap IDs where neighbor group is associated.
- network
Tap List<String>Rule Ids - List of Network Tap Rule IDs where neighbor group is associated.
- provisioning
State String - The provisioning state of the resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id string
- The provider-assigned unique ID for this managed resource.
- name string
- The name of the resource
- network
Tap string[]Ids - List of NetworkTap IDs where neighbor group is associated.
- network
Tap string[]Rule Ids - List of Network Tap Rule IDs where neighbor group is associated.
- provisioning
State string - The provisioning state of the resource.
- system
Data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id str
- The provider-assigned unique ID for this managed resource.
- name str
- The name of the resource
- network_
tap_ Sequence[str]ids - List of NetworkTap IDs where neighbor group is associated.
- network_
tap_ Sequence[str]rule_ ids - List of Network Tap Rule IDs where neighbor group is associated.
- provisioning_
state str - The provisioning state of the resource.
- system_
data SystemData Response - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- id String
- The provider-assigned unique ID for this managed resource.
- name String
- The name of the resource
- network
Tap List<String>Ids - List of NetworkTap IDs where neighbor group is associated.
- network
Tap List<String>Rule Ids - List of Network Tap Rule IDs where neighbor group is associated.
- provisioning
State String - The provisioning state of the resource.
- system
Data Property Map - Azure Resource Manager metadata containing createdBy and modifiedBy information.
- type String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
Supporting Types
NeighborGroupDestination, NeighborGroupDestinationArgs
- Ipv4Addresses List<string>
- Array of IPv4 Addresses.
- Ipv6Addresses List<string>
- Array of IPv6 Addresses.
- Ipv4Addresses []string
- Array of IPv4 Addresses.
- Ipv6Addresses []string
- Array of IPv6 Addresses.
- ipv4Addresses List<String>
- Array of IPv4 Addresses.
- ipv6Addresses List<String>
- Array of IPv6 Addresses.
- ipv4Addresses string[]
- Array of IPv4 Addresses.
- ipv6Addresses string[]
- Array of IPv6 Addresses.
- ipv4_
addresses Sequence[str] - Array of IPv4 Addresses.
- ipv6_
addresses Sequence[str] - Array of IPv6 Addresses.
- ipv4Addresses List<String>
- Array of IPv4 Addresses.
- ipv6Addresses List<String>
- Array of IPv6 Addresses.
NeighborGroupDestinationResponse, NeighborGroupDestinationResponseArgs
- Ipv4Addresses List<string>
- Array of IPv4 Addresses.
- Ipv6Addresses List<string>
- Array of IPv6 Addresses.
- Ipv4Addresses []string
- Array of IPv4 Addresses.
- Ipv6Addresses []string
- Array of IPv6 Addresses.
- ipv4Addresses List<String>
- Array of IPv4 Addresses.
- ipv6Addresses List<String>
- Array of IPv6 Addresses.
- ipv4Addresses string[]
- Array of IPv4 Addresses.
- ipv6Addresses string[]
- Array of IPv6 Addresses.
- ipv4_
addresses Sequence[str] - Array of IPv4 Addresses.
- ipv6_
addresses Sequence[str] - Array of IPv6 Addresses.
- ipv4Addresses List<String>
- Array of IPv4 Addresses.
- ipv6Addresses List<String>
- Array of IPv6 Addresses.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:managednetworkfabric:NeighborGroup example-neighborGroup /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedNetworkFabric/neighborGroups/{neighborGroupName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0