Microsoft.OperationalInsights (stable:2025-02-01)

2025/06/12 • 3 new methods

Workspaces_ListNSP (new)
Description :  Gets a list of NSP configurations for specified workspace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Array of network security perimeter results. ,
Required: False ,
}
[
{
properties:
{
Description: Network security configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a network security perimeter configuration that is being created or updated. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of provisioning issues, if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules ,
Required: False ,
}
{
issueType:
{
Description: Type of issue ,
Enum:
{
Unknown: Unknown issue type ,
ConfigurationPropagationFailure: An error occurred while applying the network security perimeter (NSP) configuration. ,
MissingPerimeterConfiguration: A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules. ,
MissingIdentityConfiguration: An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the issue. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: Fully qualified resource IDs of suggested resources that can be associated to the network security perimeter (NSP) to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the network security profile (NSP) to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: Applies to inbound network traffic to the secured resources. ,
Outbound: Applies to outbound network traffic from the secured resources ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names (FQDN) for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about a network security perimeter (NSP) ,
Required: False ,
}
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode of the resource association ,
Enum:
{
Enforced: Enforced access mode - traffic to the resource that failed access checks is blocked ,
Learning: Learning access mode - traffic to the resource is enabled for analysis but not blocked ,
Audit: Audit access mode - traffic to the resource that fails access checks is logged but not blocked ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Network security perimeter configuration profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int32 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: Applies to inbound network traffic to the secured resources. ,
Outbound: Applies to outbound network traffic from the secured resources ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names (FQDN) for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int32 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories that are enabled ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The link used to get the next page of results. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_GetNSP (new)
Description :  Gets a network security perimeter configuration.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
networkSecurityPerimeterConfigurationName:
{
Description: The name for a network security perimeter configuration ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Network security configuration properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Provisioning state of a network security perimeter configuration that is being created or updated. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Updating: No description available. ,
Deleting: No description available. ,
Accepted: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
provisioningIssues:
{
Description: List of provisioning issues, if any ,
Required: False ,
}
[
{
name:
{
Description: Name of the issue ,
Required: False ,
}
string ,
properties:
{
Description: Details of a provisioning issue for a network security perimeter (NSP) configuration. Resource providers should generate separate provisioning issue elements for each separate issue detected, and include a meaningful and distinctive description, as well as any appropriate suggestedResourceIds and suggestedAccessRules ,
Required: False ,
}
{
issueType:
{
Description: Type of issue ,
Enum:
{
Unknown: Unknown issue type ,
ConfigurationPropagationFailure: An error occurred while applying the network security perimeter (NSP) configuration. ,
MissingPerimeterConfiguration: A network connectivity issue is happening on the resource which could be addressed either by adding new resources to the network security perimeter (NSP) or by modifying access rules. ,
MissingIdentityConfiguration: An managed identity hasn't been associated with the resource. The resource will still be able to validate inbound traffic from the network security perimeter (NSP) or matching inbound access rules, but it won't be able to perform outbound access as a member of the NSP. ,
}
,
Required: False ,
}
enum ,
severity:
{
Description: Severity of the issue. ,
Enum:
{
Warning: No description available. ,
Error: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Description of the issue ,
Required: False ,
}
string ,
suggestedResourceIds:
{
Description: Fully qualified resource IDs of suggested resources that can be associated to the network security perimeter (NSP) to remediate the issue. ,
Required: False ,
}
[
string ,
]
,
suggestedAccessRules:
{
Description: Access rules that can be added to the network security profile (NSP) to remediate the issue. ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: Applies to inbound network traffic to the secured resources. ,
Outbound: Applies to outbound network traffic from the secured resources ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names (FQDN) for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}
,
}
,
]
,
networkSecurityPerimeter:
{
Description: Information about a network security perimeter (NSP) ,
Required: False ,
}
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
resourceAssociation:
{
Description: Information about resource association ,
Required: False ,
}
{
name:
{
Description: Name of the resource association ,
Required: False ,
}
string ,
accessMode:
{
Description: Access mode of the resource association ,
Enum:
{
Enforced: Enforced access mode - traffic to the resource that failed access checks is blocked ,
Learning: Learning access mode - traffic to the resource is enabled for analysis but not blocked ,
Audit: Audit access mode - traffic to the resource that fails access checks is logged but not blocked ,
}
,
Required: False ,
}
enum ,
}
,
profile:
{
Description: Network security perimeter configuration profile ,
Required: False ,
}
{
name:
{
Description: Name of the profile ,
Required: False ,
}
string ,
accessRulesVersion:
{
Description: Current access rules version ,
Format: int32 ,
Required: False ,
}
integer ,
accessRules:
{
Description: List of Access Rules ,
Required: False ,
}
[
{
name:
{
Description: Name of the access rule ,
Required: False ,
}
string ,
properties:
{
Description: Properties of Access Rule ,
Required: False ,
}
{
direction:
{
Description: Direction of Access Rule ,
Enum:
{
Inbound: Applies to inbound network traffic to the secured resources. ,
Outbound: Applies to outbound network traffic from the secured resources ,
}
,
Required: False ,
}
enum ,
addressPrefixes:
{
Description: Address prefixes in the CIDR format for inbound rules ,
Required: False ,
}
[
string ,
]
,
subscriptions:
{
Description: Subscriptions for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: The fully qualified Azure resource ID of the subscription e.g. ('/subscriptions/00000000-0000-0000-0000-000000000000') ,
Format: arm-id ,
Required: False ,
}
string ,
}
,
]
,
networkSecurityPerimeters:
{
Description: Network security perimeters for inbound rules ,
Required: False ,
}
[
{
id:
{
Description: Fully qualified Azure resource ID of the NSP resource ,
Format: arm-id ,
Required: False ,
}
string ,
perimeterGuid:
{
Description: Universal unique ID (UUID) of the network security perimeter ,
Format: uuid ,
Required: False ,
}
string ,
location:
{
Description: Location of the network security perimeter ,
Required: False ,
}
string ,
}
,
]
,
fullyQualifiedDomainNames:
{
Description: Fully qualified domain names (FQDN) for outbound rules ,
Required: False ,
}
[
string ,
]
,
emailAddresses:
{
Description: Email addresses for outbound rules ,
Required: False ,
}
[
string ,
]
,
phoneNumbers:
{
Description: Phone numbers for outbound rules ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
diagnosticSettingsVersion:
{
Description: Current diagnostic settings version ,
Format: int32 ,
Required: False ,
}
integer ,
enabledLogCategories:
{
Description: List of log categories that are enabled ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Workspaces_ReconcileNSP (new)
Description :  Reconcile network security perimeter configuration for Workspace resource.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/networkSecurityPerimeterConfigurations/{networkSecurityPerimeterConfigurationName}/reconcile
{
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
workspaceName:
{
Description: The name of the workspace. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
networkSecurityPerimeterConfigurationName:
{
Description: The name for a network security perimeter configuration ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}