azure-native.azurestackhci.getNetworkSecurityGroup
Explore with Pulumi AI
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 dictionaryThe following arguments are supported:
- Network
Security stringGroup Name  - Name of the network security group
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- Network
Security stringGroup Name  - Name of the network security group
 - Resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- network
Security StringGroup Name  - Name of the network security group
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
- network
Security stringGroup Name  - Name of the network security group
 - resource
Group stringName  - The name of the resource group. The name is case insensitive.
 
- network_
security_ strgroup_ name  - Name of the network security group
 - resource_
group_ strname  - The name of the resource group. The name is case insensitive.
 
- network
Security StringGroup Name  - Name of the network security group
 - resource
Group StringName  - The name of the resource group. The name is case insensitive.
 
getNetworkSecurityGroup Result
The following output properties are available:
- Azure
Api stringVersion  - 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
 - Network
Interfaces List<Pulumi.Azure Native. Azure Stack HCI. Outputs. Network Interface Arm Reference Response>  - A collection of references to network interfaces that are currently using this NSG.
 - Provisioning
State string - The provisioning state of the network security group resource.
 - Status
Pulumi.
Azure Native. Azure Stack HCI. Outputs. Network Security Group Status Response  - The observed state of Network Security Group
 - Subnets
List<Pulumi.
Azure Native. Azure Stack HCI. Outputs. Logical Network Arm Reference Response>  - A collection of references to logical networks that are currently using this NSG
 - System
Data Pulumi.Azure Native. Azure Stack HCI. 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"
 - Extended
Location Pulumi.Azure Native. Azure Stack HCI. Outputs. Extended Location Response  - The extendedLocation of the resource.
 - Dictionary<string, string>
 - Resource tags.
 
- Azure
Api stringVersion  - 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
 - Network
Interfaces []NetworkInterface Arm Reference Response  - A collection of references to network interfaces that are currently using this NSG.
 - Provisioning
State string - The provisioning state of the network security group resource.
 - Status
Network
Security Group Status Response  - The observed state of Network Security Group
 - Subnets
[]Logical
Network Arm Reference Response  - A collection of references to logical networks that are currently using this NSG
 - 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"
 - Extended
Location ExtendedLocation Response  - The extendedLocation of the resource.
 - map[string]string
 - Resource tags.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - e
Tag 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
 - network
Interfaces List<NetworkInterface Arm Reference Response>  - A collection of references to network interfaces that are currently using this NSG.
 - provisioning
State String - The provisioning state of the network security group resource.
 - status
Network
Security Group Status Response  - The observed state of Network Security Group
 - subnets
List<Logical
Network Arm Reference Response>  - A collection of references to logical networks that are currently using this NSG
 - 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"
 - extended
Location ExtendedLocation Response  - The extendedLocation of the resource.
 - Map<String,String>
 - Resource tags.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - e
Tag 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
 - network
Interfaces NetworkInterface Arm Reference Response[]  - A collection of references to network interfaces that are currently using this NSG.
 - provisioning
State string - The provisioning state of the network security group resource.
 - status
Network
Security Group Status Response  - The observed state of Network Security Group
 - subnets
Logical
Network Arm Reference Response[]  - A collection of references to logical networks that are currently using this NSG
 - 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"
 - extended
Location ExtendedLocation Response  - The extendedLocation of the resource.
 - {[key: string]: string}
 - Resource tags.
 
- azure_
api_ strversion  - 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[NetworkInterface Arm Reference Response]  - 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
Network
Security Group Status Response  - The observed state of Network Security Group
 - subnets
Sequence[Logical
Network Arm Reference Response]  - A collection of references to logical networks that are currently using this NSG
 - 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"
 - extended_
location ExtendedLocation Response  - The extendedLocation of the resource.
 - Mapping[str, str]
 - Resource tags.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - e
Tag 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
 - network
Interfaces List<Property Map> - A collection of references to network interfaces that are currently using this NSG.
 - provisioning
State 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
 - 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"
 - extended
Location Property Map - The extendedLocation of the resource.
 - Map<String>
 - Resource tags.
 
Supporting Types
ExtendedLocationResponse  
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]
 - Operation
Id 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]
 - Operation
Id 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]
 - operation
Id 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]
 - operation
Id 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]
 - operation
Id String - The ID of the operation performed on the network security group
 
NetworkSecurityGroupStatusResponse    
- Error
Code string - NetworkSecurityGroup provisioning error code
 - Error
Message string - Descriptive error message
 - Provisioning
Status Pulumi.Azure Native. Azure Stack HCI. Inputs. Network Security Group Status Provisioning Status Response  - network security group provisioning status
 
- Error
Code string - NetworkSecurityGroup provisioning error code
 - Error
Message string - Descriptive error message
 - Provisioning
Status NetworkSecurity Group Status Provisioning Status Response  - network security group provisioning status
 
- error
Code String - NetworkSecurityGroup provisioning error code
 - error
Message String - Descriptive error message
 - provisioning
Status NetworkSecurity Group Status Provisioning Status Response  - network security group provisioning status
 
- error
Code string - NetworkSecurityGroup provisioning error code
 - error
Message string - Descriptive error message
 - provisioning
Status NetworkSecurity Group Status Provisioning Status Response  - network security group provisioning status
 
- error_
code str - NetworkSecurityGroup provisioning error code
 - error_
message str - Descriptive error message
 - provisioning_
status NetworkSecurity Group Status Provisioning Status Response  - network security group provisioning status
 
- error
Code String - NetworkSecurityGroup provisioning error code
 - error
Message String - Descriptive error message
 - provisioning
Status Property Map - network security group provisioning status
 
SystemDataResponse  
- 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.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0