Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update resource association swagger #18432

Merged
merged 25 commits into from
Apr 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,16 @@
"subscriptionId": "subId",
"resourceGroupName": "rg1",
"networkSecurityPerimeterName": "nsp1",
"associationName": "association1"
"associationName": "association1",
"operationId": "operationId1"
},
"responses": {
"200": {},
"202": {
"headers": {
"location": "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityPerimeters/{networkSecurityPerimeterName}/resourceAssociations/{associationName}/operationResults/{operationId}?api-version={api-version}"
}
},
"204": {}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"profile": {
"id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}"
},
"accessMode": "EnforceMode"
"accessMode": "Enforced",
"hasProvisioningIssues": "no"
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
"profile": {
"id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}"
},
"accessMode": "EnforceMode"
"accessMode": "Enforced",
"hasProvisioningIssues": "no"
}
},
{
Expand All @@ -37,7 +38,24 @@
"profile": {
"id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}"
},
"accessMode": "DryRunMode"
"accessMode": "Audit",
"hasProvisioningIssues": "no"
}
},
{
"name": "association3",
"id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/resourceAssociations/association3",
"type": "Microsoft.Network/networkSecurityPerimeters/resourceAssociations",
"properties": {
"provisioningState": "Failed",
"privateLinkResource": {
"id": "/subscriptions/{paasSubscriptionId}/resourceGroups/{paasResourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}"
},
"profile": {
"id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}"
},
"accessMode": "Learning",
"hasProvisioningIssues": "yes"
}
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"profile": {
"id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}"
},
"accessMode": "EnforceMode"
"accessMode": "Enforced"
}
}
},
Expand All @@ -32,7 +32,8 @@
"profile": {
"id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}"
},
"accessMode": "EnforceMode"
"accessMode": "Enforced",
"hasProvisioningIssues": "no"
}
}
},
Expand All @@ -49,7 +50,8 @@
"profile": {
"id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityPerimeters/nsp1/profiles/{profileName}"
},
"accessMode": "EnforceMode"
"accessMode": "Enforced",
"hasProvisioningIssues": "no"
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,12 @@
"type": "Microsoft.Network/networkSecurityPerimeters/profiles",
"location": "resource location",
"properties": {
"accessRulesVersion": "0"
"accessRulesVersion": "0",
"enabledLogCategories": [
{
"name": "NSPOutboundAccessAllowed"
}
]
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,12 @@
"type": "Microsoft.Network/networkSecurityPerimeters/profiles",
"location": "resource location",
"properties": {
"accessRulesVersion": "0"
"accessRulesVersion": "0",
"enabledLogCategories": [
{
"name": "NSPOutboundAccessDenied"
}
]
}
},
{
Expand All @@ -25,7 +30,12 @@
"type": "Microsoft.Network/networkSecurityPerimeters/profiles",
"location": "resource location",
"properties": {
"accessRulesVersion": "0"
"accessRulesVersion": "0",
"enabledLogCategories": [
{
"name": "NSPOutboundAttempt"
}
]
}
}
],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,12 @@
"type": "Microsoft.Network/networkSecurityPerimeters/profiles",
"location": "East US 2 EUAP",
"properties": {
"accessRulesVersion": "0"
"accessRulesVersion": "0",
"enabledLogCategories": [
{
"name": "NSPInboundAccessAllowed"
}
]
}
}
},
Expand All @@ -29,7 +34,12 @@
"type": "Microsoft.Network/networkSecurityPerimeters/profiles",
"location": "East US 2 EUAP",
"properties": {
"accessRulesVersion": "0"
"accessRulesVersion": "0",
"enabledLogCategories": [
{
"name": "NSPInboundAccessDenied"
}
]
}
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -668,6 +668,15 @@
"200": {
"description": "Delete Succeed."
},
"202": {
"description": "Delete in progress.",
"headers": {
"location": {
"description": "location header",
"type": "string"
}
}
},
"204": {
"description": "Request successful. The resource does not exist."
},
Expand All @@ -678,6 +687,7 @@
}
}
},
"x-ms-long-running-operation": true,
"x-ms-examples": {
"NspAssociationDelete": {
"$ref": "./examples/NspAssociationDelete.json"
Expand Down Expand Up @@ -846,7 +856,7 @@
},
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"$ref": "#/definitions/NSPProvisioningState",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the difference between these two provisioningState?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NSPProvisioningState has two extra field: Accepting, Created.

"description": "The provisioning state of the scope assignment resource."
}
},
Expand Down Expand Up @@ -906,6 +916,16 @@
"readOnly": true,
"type": "string",
"description": "Version number that increases with every update to access rules within the profile."
},
"enabledLogCategories": {
"type": "array",
"items": {
"$ref": "#/definitions/LoggingCategory"
},
"x-ms-identifiers": [
"name"
],
"description": "Gets the enabled log categories."
}
},
"description": "Properties of NSP profile."
Expand Down Expand Up @@ -962,7 +982,7 @@
"properties": {
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"$ref": "#/definitions/NSPProvisioningState",
"description": "The provisioning state of the scope assignment resource."
},
"direction": {
Expand Down Expand Up @@ -1080,7 +1100,7 @@
"properties": {
"provisioningState": {
"readOnly": true,
"$ref": "./network.json#/definitions/ProvisioningState",
"$ref": "#/definitions/NSPProvisioningState",
"description": "The provisioning state of the resource association resource."
},
"privateLinkResource": {
Expand All @@ -1094,16 +1114,20 @@
"accessMode": {
"type": "string",
"enum": [
"Unspecified",
"EnforceMode",
"LearningMode",
"DryRunMode"
"Learning",
"Enforced",
"Audit"
],
"x-ms-enum": {
"name": "AssociationAccessMode",
"modelAsString": true
},
"description": "Access mode on the association."
},
"hasProvisioningIssues": {
"readOnly": true,
"type": "string",
"description": "Specifies if there are provisioning issues"
}
}
},
Expand Down Expand Up @@ -1177,6 +1201,33 @@
}
},
"description": "Properties of the perimeter associable resources."
},
"LoggingCategory": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the logging category."
}
},
"description": "Logging Category"
},
"NSPProvisioningState": {
"type": "string",
"readOnly": true,
"description": "The current provisioning state.",
"enum": [
"Succeeded",
"Creating",
"Updating",
"Deleting",
"Accepted",
"Failed"
],
"x-ms-enum": {
"name": "nspProvisioningState",
"modelAsString": true
}
}
},
"parameters": {
Expand Down