Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. azurestackhci
  5. getNetworkSecurityGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.azurestackhci.getNetworkSecurityGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-azure-native

    Gets the specified network security group.

    Uses Azure REST API version 2025-02-01-preview.

    Other available API versions: 2024-02-01-preview, 2024-05-01-preview, 2024-07-15-preview, 2024-08-01-preview, 2024-10-01-preview, 2025-04-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native azurestackhci [ApiVersion]. See the version guide for details.

    Using getNetworkSecurityGroup

    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 getNetworkSecurityGroup(args: GetNetworkSecurityGroupArgs, opts?: InvokeOptions): Promise<GetNetworkSecurityGroupResult>
function getNetworkSecurityGroupOutput(args: GetNetworkSecurityGroupOutputArgs, opts?: InvokeOptions): Output<GetNetworkSecurityGroupResult>
    def get_network_security_group(network_security_group_name: Optional[str] = None,
                               resource_group_name: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetNetworkSecurityGroupResult
def get_network_security_group_output(network_security_group_name: Optional[pulumi.Input[str]] = None,
                               resource_group_name: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetNetworkSecurityGroupResult]
    func LookupNetworkSecurityGroup(ctx *Context, args *LookupNetworkSecurityGroupArgs, opts ...InvokeOption) (*LookupNetworkSecurityGroupResult, error)
func LookupNetworkSecurityGroupOutput(ctx *Context, args *LookupNetworkSecurityGroupOutputArgs, opts ...InvokeOption) LookupNetworkSecurityGroupResultOutput

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

    public static class GetNetworkSecurityGroup 
{
    public static Task<GetNetworkSecurityGroupResult> InvokeAsync(GetNetworkSecurityGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkSecurityGroupResult> Invoke(GetNetworkSecurityGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNetworkSecurityGroupResult> getNetworkSecurityGroup(GetNetworkSecurityGroupArgs args, InvokeOptions options)
public static Output<GetNetworkSecurityGroupResult> getNetworkSecurityGroup(GetNetworkSecurityGroupArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:azurestackhci:getNetworkSecurityGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    NetworkSecurityGroupName string
    Name of the network security group
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    NetworkSecurityGroupName string
    Name of the network security group
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    networkSecurityGroupName String
    Name of the network security group
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    networkSecurityGroupName string
    Name of the network security group
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    network_security_group_name str
    Name of the network security group
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    networkSecurityGroupName String
    Name of the network security group
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getNetworkSecurityGroup Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ETag string
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    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
    NetworkInterfaces List<Pulumi.AzureNative.AzureStackHCI.Outputs.NetworkInterfaceArmReferenceResponse>
    A collection of references to network interfaces that are currently using this NSG.
    ProvisioningState string
    The provisioning state of the network security group resource.
    Status Pulumi.AzureNative.AzureStackHCI.Outputs.NetworkSecurityGroupStatusResponse
    The observed state of Network Security Group
    Subnets List<Pulumi.AzureNative.AzureStackHCI.Outputs.LogicalNetworkArmReferenceResponse>
    A collection of references to logical networks that are currently using this NSG
    SystemData Pulumi.AzureNative.AzureStackHCI.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"
    ExtendedLocation Pulumi.AzureNative.AzureStackHCI.Outputs.ExtendedLocationResponse
    The extendedLocation of the resource.
    Tags Dictionary<string, string>
    Resource tags.
    AzureApiVersion string
    The Azure API version of the resource.
    ETag string
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    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
    NetworkInterfaces []NetworkInterfaceArmReferenceResponse
    A collection of references to network interfaces that are currently using this NSG.
    ProvisioningState string
    The provisioning state of the network security group resource.
    Status NetworkSecurityGroupStatusResponse
    The observed state of Network Security Group
    Subnets []LogicalNetworkArmReferenceResponse
    A collection of references to logical networks that are currently using this NSG
    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"
    ExtendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    Tags map[string]string
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    eTag String
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    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
    networkInterfaces List<NetworkInterfaceArmReferenceResponse>
    A collection of references to network interfaces that are currently using this NSG.
    provisioningState String
    The provisioning state of the network security group resource.
    status NetworkSecurityGroupStatusResponse
    The observed state of Network Security Group
    subnets List<LogicalNetworkArmReferenceResponse>
    A collection of references to logical networks that are currently using this NSG
    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"
    extendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    tags Map<String,String>
    Resource tags.
    azureApiVersion string
    The Azure API version of the resource.
    eTag string
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    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
    networkInterfaces NetworkInterfaceArmReferenceResponse[]
    A collection of references to network interfaces that are currently using this NSG.
    provisioningState string
    The provisioning state of the network security group resource.
    status NetworkSecurityGroupStatusResponse
    The observed state of Network Security Group
    subnets LogicalNetworkArmReferenceResponse[]
    A collection of references to logical networks that are currently using this NSG
    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"
    extendedLocation ExtendedLocationResponse
    The extendedLocation of the resource.
    tags {[key: string]: string}
    Resource tags.
    azure_api_version str
    The Azure API version of the resource.
    e_tag str
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    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_interfaces Sequence[NetworkInterfaceArmReferenceResponse]
    A collection of references to network interfaces that are currently using this NSG.
    provisioning_state str
    The provisioning state of the network security group resource.
    status NetworkSecurityGroupStatusResponse
    The observed state of Network Security Group
    subnets Sequence[LogicalNetworkArmReferenceResponse]
    A collection of references to logical networks that are currently using this NSG
    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"
    extended_location ExtendedLocationResponse
    The extendedLocation of the resource.
    tags Mapping[str, str]
    Resource tags.
    azureApiVersion String
    The Azure API version of the resource.
    eTag String
    If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
    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
    networkInterfaces List<Property Map>
    A collection of references to network interfaces that are currently using this NSG.
    provisioningState String
    The provisioning state of the network security group resource.
    status Property Map
    The observed state of Network Security Group
    subnets List<Property Map>
    A collection of references to logical networks that are currently using this NSG
    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"
    extendedLocation Property Map
    The extendedLocation of the resource.
    tags Map<String>
    Resource tags.

    Supporting Types

    ExtendedLocationResponse

    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    Name string
    The name of the extended location.
    Type string
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.
    name string
    The name of the extended location.
    type string
    The type of the extended location.
    name str
    The name of the extended location.
    type str
    The type of the extended location.
    name String
    The name of the extended location.
    type String
    The type of the extended location.

    LogicalNetworkArmReferenceResponse

    Id string
    The ARM ID for a Logical Network.
    Id string
    The ARM ID for a Logical Network.
    id String
    The ARM ID for a Logical Network.
    id string
    The ARM ID for a Logical Network.
    id str
    The ARM ID for a Logical Network.
    id String
    The ARM ID for a Logical Network.

    NetworkInterfaceArmReferenceResponse

    Id string
    The ARM ID for a Network Interface.
    Id string
    The ARM ID for a Network Interface.
    id String
    The ARM ID for a Network Interface.
    id string
    The ARM ID for a Network Interface.
    id str
    The ARM ID for a Network Interface.
    id String
    The ARM ID for a Network Interface.

    NetworkSecurityGroupStatusProvisioningStatusResponse

    Status string
    The status of the operation performed on the network security group [Succeeded, Failed, InProgress]
    OperationId string
    The ID of the operation performed on the network security group
    Status string
    The status of the operation performed on the network security group [Succeeded, Failed, InProgress]
    OperationId string
    The ID of the operation performed on the network security group
    status String
    The status of the operation performed on the network security group [Succeeded, Failed, InProgress]
    operationId String
    The ID of the operation performed on the network security group
    status string
    The status of the operation performed on the network security group [Succeeded, Failed, InProgress]
    operationId string
    The ID of the operation performed on the network security group
    status str
    The status of the operation performed on the network security group [Succeeded, Failed, InProgress]
    operation_id str
    The ID of the operation performed on the network security group
    status String
    The status of the operation performed on the network security group [Succeeded, Failed, InProgress]
    operationId String
    The ID of the operation performed on the network security group

    NetworkSecurityGroupStatusResponse

    ErrorCode string
    NetworkSecurityGroup provisioning error code
    ErrorMessage string
    Descriptive error message
    ProvisioningStatus Pulumi.AzureNative.AzureStackHCI.Inputs.NetworkSecurityGroupStatusProvisioningStatusResponse
    network security group provisioning status
    ErrorCode string
    NetworkSecurityGroup provisioning error code
    ErrorMessage string
    Descriptive error message
    ProvisioningStatus NetworkSecurityGroupStatusProvisioningStatusResponse
    network security group provisioning status
    errorCode String
    NetworkSecurityGroup provisioning error code
    errorMessage String
    Descriptive error message
    provisioningStatus NetworkSecurityGroupStatusProvisioningStatusResponse
    network security group provisioning status
    errorCode string
    NetworkSecurityGroup provisioning error code
    errorMessage string
    Descriptive error message
    provisioningStatus NetworkSecurityGroupStatusProvisioningStatusResponse
    network security group provisioning status
    error_code str
    NetworkSecurityGroup provisioning error code
    error_message str
    Descriptive error message
    provisioning_status NetworkSecurityGroupStatusProvisioningStatusResponse
    network security group provisioning status
    errorCode String
    NetworkSecurityGroup provisioning error code
    errorMessage String
    Descriptive error message
    provisioningStatus Property Map
    network security group provisioning status

    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 v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-azure-native