Network Security Perimeter Configurations - Reconcile
Reconcile the NSP configuration for an account.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CognitiveServices/accounts/{accountName}/networkSecurityPerimeterConfigurations/{nspConfigurationName}/reconcile?api-version=2024-10-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
The name of Cognitive Services account. Regex pattern: |
nsp
|
path | True |
string |
The name of the NSP Configuration. Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string |
The ID of the target subscription. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successfully Reconciled the NSP configuration. |
|
202 Accepted |
Request to reconcile the NSP configuration accepted. Headers location: string |
|
Other Status Codes |
Error response describing why the operation failed. |
Examples
ReconcileNetworkSecurityPerimeterConfigurations
Sample request
POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations/NSPConfigurationName/reconcile?api-version=2024-10-01
Sample response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.CognitiveServices/accounts/accountName/networkSecurityPerimeterConfigurations",
"name": "networkSecurityPerimeterConfigurationName",
"type": "Microsoft.CognitiveServices/accounts/networkSecurityPerimeterConfigurations",
"properties": {
"provisioningState": "Succeeded",
"networkSecurityPerimeter": {
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroupName/providers/Microsoft.Network/networkSecurityPerimeters/perimeter",
"perimeterGuid": "00000000-0000-0000-0000-000000000000",
"location": "East US"
},
"resourceAssociation": {
"name": "associationName",
"accessMode": "Enforced"
},
"profile": {
"name": "profileName",
"accessRulesVersion": 1,
"accessRules": [
{
"name": "ruleName",
"properties": {
"direction": "Inbound",
"addressPrefixes": [
"148.0.0.0/8",
"152.4.6.0/24"
]
}
}
]
}
}
}
azure-asyncoperation: http://azure.async.operation/status
Definitions
Name | Description |
---|---|
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Network |
Information about a linked Network Security Perimeter |
Network |
Network Security Perimeter Access Rule |
Network |
The Properties of Network Security Perimeter Rule |
Network |
NSP Configuration for an Cognitive Services account. |
Network |
Network Security Perimeter Configuration Association Information |
Network |
The properties of an NSP Configuration. |
Network |
Network Security Perimeter Profile Information |
Nsp |
Direction of Access Rule |
Provisioning |
|
Provisioning |
Properties of Provisioning Issue |
Subscriptions |
Subscriptions for inbound rules |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
The error detail.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
NetworkSecurityPerimeter
Information about a linked Network Security Perimeter
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified identifier of the resource |
location |
string |
Location of the resource |
perimeterGuid |
string |
Guid of the resource |
NetworkSecurityPerimeterAccessRule
Network Security Perimeter Access Rule
Name | Type | Description |
---|---|---|
name |
string |
Network Security Perimeter Access Rule Name |
properties |
Properties of Network Security Perimeter Access Rule |
NetworkSecurityPerimeterAccessRuleProperties
The Properties of Network Security Perimeter Rule
Name | Type | Description |
---|---|---|
addressPrefixes |
string[] |
Address prefixes for inbound rules |
direction |
Direction of Access Rule |
|
fullyQualifiedDomainNames |
string[] |
Fully qualified domain name for outbound rules |
networkSecurityPerimeters |
NetworkSecurityPerimeters for inbound rules |
|
subscriptions |
Subscriptions for inbound rules |
NetworkSecurityPerimeterConfiguration
NSP Configuration for an Cognitive Services account.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties |
NSP Configuration properties. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
NetworkSecurityPerimeterConfigurationAssociationInfo
Network Security Perimeter Configuration Association Information
Name | Type | Description |
---|---|---|
accessMode |
string |
Access Mode of the resource association |
name |
string |
Name of the resource association |
NetworkSecurityPerimeterConfigurationProperties
The properties of an NSP Configuration.
Name | Type | Description |
---|---|---|
networkSecurityPerimeter |
Information about a linked Network Security Perimeter |
|
profile |
Network Security Perimeter Profile Information |
|
provisioningIssues |
List of Provisioning Issues |
|
provisioningState |
string |
Provisioning state of NetworkSecurityPerimeter configuration |
resourceAssociation |
Network Security Perimeter Configuration Association Information |
NetworkSecurityPerimeterProfileInfo
Network Security Perimeter Profile Information
Name | Type | Description |
---|---|---|
accessRules |
Network Security Perimeter Access Rule |
|
accessRulesVersion |
integer |
Access rules version of the resource profile |
diagnosticSettingsVersion |
integer |
Current diagnostic settings version |
enabledLogCategories |
string[] |
List of enabled log categories |
name |
string |
Name of the resource profile |
NspAccessRuleDirection
Direction of Access Rule
Name | Type | Description |
---|---|---|
Inbound |
string |
|
Outbound |
string |
ProvisioningIssue
Name | Type | Description |
---|---|---|
name |
string |
Name of the NSP provisioning issue |
properties |
Properties of Provisioning Issue |
ProvisioningIssueProperties
Properties of Provisioning Issue
Name | Type | Description |
---|---|---|
description |
string |
Description of the issue |
issueType |
string |
Type of Issue |
severity |
string |
Severity of the issue |
suggestedAccessRules |
Optional array, suggested access rules |
|
suggestedResourceIds |
string[] |
IDs of resources that can be associated to the same perimeter to remediate the issue. |
Subscriptions
Subscriptions for inbound rules
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified identifier of subscription |