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

Adding the toplevel resource for querying the onboarded resources #15230

Merged
merged 18 commits into from
Jul 20, 2021
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
1 change: 1 addition & 0 deletions custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ asciifolding
Asns
aspnet
assessmentprojects
Associable
Asturian
asyncinfo
asyncoperation
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
{
"title": "List of resources onboarded for network security perimeter feature (perimeter associable resources).",
"parameters": {
"api-version": "2021-03-01-preview",
"subscriptionId": "subId",
"location": "westus"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "Microsoft.Sql.servers",
"id": "/subscriptions/{subscriptionID}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Sql.servers",
"type": "Microsoft.Network/PerimeterAssociableResourceTypes",
"properties": {
"resourceType": "Microsoft.Sql/servers",
"displayName": "Microsoft.Sql/servers",
"publicDnsZones": [
"database.windows.net"
]
}
},
{
"name": "Microsoft.Storage.accounts",
"id": "/subscriptions/{subscriptionId}/providers/Microsoft.Network/perimeterAssociableResourceTypes/Microsoft.Storage.storageAccounts",
"type": "Microsoft.Network/PerimeterAssociableResourceTypes",
"properties": {
"resourceType": "Microsoft.Storage/accounts",
"displayName": "Microsoft.Storage/accounts",
"publicDnsZones": [
"blob.core.windows.net",
"table.core.windows.net",
"queue.core.windows.net",
"file.core.windows.net"
]
}
}
],
"nextLink": "{baseurl}/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/perimeterAssociableResourceTypes?api-version=2021-03-01-preview&$skipToken=10"
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,46 @@
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/perimeterAssociableResourceTypes": {
"get": {
"operationId": "PerimeterAssociableResourceTypes_Get",
"description": "Gets the list of resources that are onboarded with NSP. These resources can be associated with a network security perimeter",
"parameters": [
{
"$ref": "./network.json#/parameters/SubscriptionIdParameter"
},
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The location of the where the association is present."
},
{
"$ref": "./network.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Request successful. Returns the list of resources that are onboarded with network security perimeter feature.",
"schema": {
"$ref": "#/definitions/PerimeterAssociableResourcesListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./network.json#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"Check Dns Name Availability": {
"$ref": "./examples/PerimeterAssociableResourcesList.json"
}
}
}
}
},
"definitions": {
Expand Down Expand Up @@ -310,6 +350,77 @@
}
},
"description": "Properties of network security perimeter."
},
"PerimeterAssociableResource": {
"type": "object",
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/PerimeterAssociableResourceProperties",
"description": "Properties of the perimeter associable resource."
},
"name": {
"type": "string",
"description": "The name of the resource that is unique within a resource group. This name can be used to access the resource."
},
"id": {
"readOnly": true,
"type": "string",
"description": "Identifier of the perimeter associable resource."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Resource type."
}
},
"allOf": [
{
"$ref": "./network.json#/definitions/Resource"
}
],
"description": "Resource that is onboarded to use network security perimeter. Also referred as perimeter associable resource."
},
"PerimeterAssociableResourcesListResult": {
"type": "object",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/PerimeterAssociableResource"
},
"description": "Gets paged list of perimeter associable resources."
},
"nextLink": {
"type": "string",
"description": "Gets the URL to get the next page of results."
}
},
"description": "Paged list of perimeter associable resources."
},
"PerimeterAssociableResourceProperties": {
"type": "object",
"properties": {
"displayName": {
"readOnly": true,
"type": "string",
"description": "A friendly name for the properties of perimeter associable resources."
},
"resourceType": {
"readOnly": true,
"type": "string",
"description": "Resource type/provider name."
},
"publicDnsZones": {
"readOnly": true,
"type": "array",
"items": {
"type": "string"
},
"description": "Public DNS zone names of the resources."
}
},
"description": "Properties of the perimeter associable resources."
}
},
"parameters": {
Expand Down