Azure Native

Pulumi Official
Package maintained by Pulumi
v1.68.1 published on Monday, Aug 15, 2022 by Pulumi

getNetworkGroup

The network group resource API Version: 2021-02-01-preview.

Using getNetworkGroup

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 getNetworkGroup(args: GetNetworkGroupArgs, opts?: InvokeOptions): Promise<GetNetworkGroupResult>
function getNetworkGroupOutput(args: GetNetworkGroupOutputArgs, opts?: InvokeOptions): Output<GetNetworkGroupResult>
def get_network_group(network_group_name: Optional[str] = None,
                      network_manager_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetNetworkGroupResult
def get_network_group_output(network_group_name: Optional[pulumi.Input[str]] = None,
                      network_manager_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetNetworkGroupResult]
func LookupNetworkGroup(ctx *Context, args *LookupNetworkGroupArgs, opts ...InvokeOption) (*LookupNetworkGroupResult, error)
func LookupNetworkGroupOutput(ctx *Context, args *LookupNetworkGroupOutputArgs, opts ...InvokeOption) LookupNetworkGroupResultOutput

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

public static class GetNetworkGroup 
{
    public static Task<GetNetworkGroupResult> InvokeAsync(GetNetworkGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkGroupResult> Invoke(GetNetworkGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNetworkGroupResult> getNetworkGroup(GetNetworkGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: azure-native:network:getNetworkGroup
  Arguments:
    # Arguments dictionary

The following arguments are supported:

NetworkGroupName string

The name of the network group to get.

NetworkManagerName string

The name of the network manager.

ResourceGroupName string

The name of the resource group.

NetworkGroupName string

The name of the network group to get.

NetworkManagerName string

The name of the network manager.

ResourceGroupName string

The name of the resource group.

networkGroupName String

The name of the network group to get.

networkManagerName String

The name of the network manager.

resourceGroupName String

The name of the resource group.

networkGroupName string

The name of the network group to get.

networkManagerName string

The name of the network manager.

resourceGroupName string

The name of the resource group.

network_group_name str

The name of the network group to get.

network_manager_name str

The name of the network manager.

resource_group_name str

The name of the resource group.

networkGroupName String

The name of the network group to get.

networkManagerName String

The name of the network manager.

resourceGroupName String

The name of the resource group.

getNetworkGroup Result

The following output properties are available:

Etag string

A unique read-only string that changes whenever the resource is updated.

Id string

Resource ID.

Name string

Resource name.

ProvisioningState string

The provisioning state of the scope assignment resource.

SystemData Pulumi.AzureNative.Network.Outputs.SystemDataResponse

The system metadata related to this resource.

Type string

Resource type.

ConditionalMembership string

Network group conditional filter.

Description string

A description of the network group.

DisplayName string

A friendly name for the network group.

GroupMembers List<Pulumi.AzureNative.Network.Outputs.GroupMembersItemResponse>

Group members of network group.

MemberType string

Group member type.

Etag string

A unique read-only string that changes whenever the resource is updated.

Id string

Resource ID.

Name string

Resource name.

ProvisioningState string

The provisioning state of the scope assignment resource.

SystemData SystemDataResponse

The system metadata related to this resource.

Type string

Resource type.

ConditionalMembership string

Network group conditional filter.

Description string

A description of the network group.

DisplayName string

A friendly name for the network group.

GroupMembers []GroupMembersItemResponse

Group members of network group.

MemberType string

Group member type.

etag String

A unique read-only string that changes whenever the resource is updated.

id String

Resource ID.

name String

Resource name.

provisioningState String

The provisioning state of the scope assignment resource.

systemData SystemDataResponse

The system metadata related to this resource.

type String

Resource type.

conditionalMembership String

Network group conditional filter.

description String

A description of the network group.

displayName String

A friendly name for the network group.

groupMembers List<GroupMembersItemResponse>

Group members of network group.

memberType String

Group member type.

etag string

A unique read-only string that changes whenever the resource is updated.

id string

Resource ID.

name string

Resource name.

provisioningState string

The provisioning state of the scope assignment resource.

systemData SystemDataResponse

The system metadata related to this resource.

type string

Resource type.

conditionalMembership string

Network group conditional filter.

description string

A description of the network group.

displayName string

A friendly name for the network group.

groupMembers GroupMembersItemResponse[]

Group members of network group.

memberType string

Group member type.

etag str

A unique read-only string that changes whenever the resource is updated.

id str

Resource ID.

name str

Resource name.

provisioning_state str

The provisioning state of the scope assignment resource.

system_data SystemDataResponse

The system metadata related to this resource.

type str

Resource type.

conditional_membership str

Network group conditional filter.

description str

A description of the network group.

display_name str

A friendly name for the network group.

group_members Sequence[GroupMembersItemResponse]

Group members of network group.

member_type str

Group member type.

etag String

A unique read-only string that changes whenever the resource is updated.

id String

Resource ID.

name String

Resource name.

provisioningState String

The provisioning state of the scope assignment resource.

systemData Property Map

The system metadata related to this resource.

type String

Resource type.

conditionalMembership String

Network group conditional filter.

description String

A description of the network group.

displayName String

A friendly name for the network group.

groupMembers List<Property Map>

Group members of network group.

memberType String

Group member type.

Supporting Types

GroupMembersItemResponse

ResourceId string

Resource Id.

ResourceId string

Resource Id.

resourceId String

Resource Id.

resourceId string

Resource Id.

resource_id str

Resource Id.

resourceId String

Resource Id.

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

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 type of identity that last modified the resource.

lastModifiedBy String

The identity that last modified the resource.

lastModifiedByType String

The type of identity that last modified the resource.

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0