1. Packages
  2. Azure Native
  3. API Docs
  4. managednetworkfabric
  5. getNeighborGroup
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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

azure-native.managednetworkfabric.getNeighborGroup

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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi

    Gets the Neighbor Group. Azure REST API version: 2023-06-15.

    Using getNeighborGroup

    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 getNeighborGroup(args: GetNeighborGroupArgs, opts?: InvokeOptions): Promise<GetNeighborGroupResult>
    function getNeighborGroupOutput(args: GetNeighborGroupOutputArgs, opts?: InvokeOptions): Output<GetNeighborGroupResult>
    def get_neighbor_group(neighbor_group_name: Optional[str] = None,
                           resource_group_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetNeighborGroupResult
    def get_neighbor_group_output(neighbor_group_name: Optional[pulumi.Input[str]] = None,
                           resource_group_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetNeighborGroupResult]
    func LookupNeighborGroup(ctx *Context, args *LookupNeighborGroupArgs, opts ...InvokeOption) (*LookupNeighborGroupResult, error)
    func LookupNeighborGroupOutput(ctx *Context, args *LookupNeighborGroupOutputArgs, opts ...InvokeOption) LookupNeighborGroupResultOutput

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

    public static class GetNeighborGroup 
    {
        public static Task<GetNeighborGroupResult> InvokeAsync(GetNeighborGroupArgs args, InvokeOptions? opts = null)
        public static Output<GetNeighborGroupResult> Invoke(GetNeighborGroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNeighborGroupResult> getNeighborGroup(GetNeighborGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:managednetworkfabric:getNeighborGroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    NeighborGroupName string
    Name of the Neighbor Group.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    NeighborGroupName string
    Name of the Neighbor Group.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    neighborGroupName String
    Name of the Neighbor Group.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    neighborGroupName string
    Name of the Neighbor Group.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    neighbor_group_name str
    Name of the Neighbor Group.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    neighborGroupName String
    Name of the Neighbor Group.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getNeighborGroup Result

    The following output properties are available:

    Destination Pulumi.AzureNative.ManagedNetworkFabric.Outputs.NeighborGroupDestinationResponse
    An array of destination IPv4 Addresses or IPv6 Addresses.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    NetworkTapIds List<string>
    List of NetworkTap IDs where neighbor group is associated.
    NetworkTapRuleIds List<string>
    List of Network Tap Rule IDs where neighbor group is associated.
    ProvisioningState string
    The provisioning state of the resource.
    SystemData Pulumi.AzureNative.ManagedNetworkFabric.Outputs.SystemDataResponse
    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"
    Annotation string
    Switch configuration description.
    Tags Dictionary<string, string>
    Resource tags.
    Destination NeighborGroupDestinationResponse
    An array of destination IPv4 Addresses or IPv6 Addresses.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Location string
    The geo-location where the resource lives
    Name string
    The name of the resource
    NetworkTapIds []string
    List of NetworkTap IDs where neighbor group is associated.
    NetworkTapRuleIds []string
    List of Network Tap Rule IDs where neighbor group is associated.
    ProvisioningState string
    The provisioning state of the resource.
    SystemData SystemDataResponse
    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"
    Annotation string
    Switch configuration description.
    Tags map[string]string
    Resource tags.
    destination NeighborGroupDestinationResponse
    An array of destination IPv4 Addresses or IPv6 Addresses.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    networkTapIds List<String>
    List of NetworkTap IDs where neighbor group is associated.
    networkTapRuleIds List<String>
    List of Network Tap Rule IDs where neighbor group is associated.
    provisioningState String
    The provisioning state of the resource.
    systemData SystemDataResponse
    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"
    annotation String
    Switch configuration description.
    tags Map<String,String>
    Resource tags.
    destination NeighborGroupDestinationResponse
    An array of destination IPv4 Addresses or IPv6 Addresses.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location string
    The geo-location where the resource lives
    name string
    The name of the resource
    networkTapIds string[]
    List of NetworkTap IDs where neighbor group is associated.
    networkTapRuleIds string[]
    List of Network Tap Rule IDs where neighbor group is associated.
    provisioningState string
    The provisioning state of the resource.
    systemData SystemDataResponse
    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"
    annotation string
    Switch configuration description.
    tags {[key: string]: string}
    Resource tags.
    destination NeighborGroupDestinationResponse
    An array of destination IPv4 Addresses or IPv6 Addresses.
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location str
    The geo-location where the resource lives
    name str
    The name of the resource
    network_tap_ids Sequence[str]
    List of NetworkTap IDs where neighbor group is associated.
    network_tap_rule_ids Sequence[str]
    List of Network Tap Rule IDs where neighbor group is associated.
    provisioning_state str
    The provisioning state of the resource.
    system_data SystemDataResponse
    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"
    annotation str
    Switch configuration description.
    tags Mapping[str, str]
    Resource tags.
    destination Property Map
    An array of destination IPv4 Addresses or IPv6 Addresses.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    location String
    The geo-location where the resource lives
    name String
    The name of the resource
    networkTapIds List<String>
    List of NetworkTap IDs where neighbor group is associated.
    networkTapRuleIds List<String>
    List of Network Tap Rule IDs where neighbor group is associated.
    provisioningState String
    The provisioning state of the resource.
    systemData 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"
    annotation String
    Switch configuration description.
    tags Map<String>
    Resource tags.

    Supporting Types

    NeighborGroupDestinationResponse

    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

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    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.73.0 published on Wednesday, Nov 20, 2024 by Pulumi