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

Swagger specification for azureWebCategories #10918

Closed
wants to merge 6 commits into from
Closed
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
@@ -0,0 +1,184 @@
{
"swagger": "2.0",
"info": {
"title": "NetworkManagementClient",
"description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.",
"version": "2020-06-01"
},
"host": "management.azure.com",
"schemes": [
"https"
],
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow.",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"paths": {
"/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureWebCategories/{name}": {
"get": {
"tags": [
"AzureWebCategories"
],
"operationId": "AzureWebCategories_Get",
"description": "Gets the specified Azure Web Category.",
"parameters": [
{
"name": "name",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the azureWebCategory."
},
{
"$ref": "./network.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./network.json#/parameters/SubscriptionIdParameter"
},
{
"name": "$expand",
"in": "query",
"required": false,
"type": "string",
"description": "Expands resourceIds back referenced by the azureWebCategory resource."
}
],
"responses": {
"200": {
"description": "Request successful. The operation returns the resulting azureWebCategory resource.",
"schema": {
"$ref": "#/definitions/AzureWebCategory"
}
},
"default": {
"description": "Unexpected error.",
"schema": {
"$ref": "./network.json#/definitions/Error"
}
}
},
"x-ms-examples": {
"Get_azureWebCategory": {
"$ref": "./examples/azureWebCategoryGet.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureWebCategories": {
"get": {
"tags": [
"AzureWebCategories"
],
"operationId": "AzureWebCategories_ListAll",
"description": "Gets all the Azure Web Categorys in a subscription.",
"parameters": [
{
"$ref": "./network.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./network.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Success. The operation returns a list of Azure Web Category resources.",
"schema": {
"$ref": "#/definitions/AzureWebCategoryListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "./network.json#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"List all Azure Web Categorys for a given subscription": {
"$ref": "./examples/AzureWebCategoriesListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"AzureWebCategoryPropertiesFormat": {
"properties": {
"group": {
pilor marked this conversation as resolved.
Show resolved Hide resolved
"type": "string",
"readOnly": true,
"description": "The name of the group that the category belongs to."
}
},
"description": "Azure Web Category Properties."
},
"AzureWebCategory": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/AzureWebCategoryPropertiesFormat",
"description": "Properties of the Azure Web Category."
},
"id": {
"type": "string",
"description": "Resource ID."
},
"name": {
"readOnly": true,
"type": "string",
"description": "Resource name."
},
"type": {
"readOnly": true,
"type": "string",
"description": "Resource type."
},
"etag": {
"readOnly": true,
"type": "string",
"description": "A unique read-only string that changes whenever the resource is updated."
}
},
"description": "Azure Web Category Resource."
},
"AzureWebCategoryListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/AzureWebCategory"
},
"description": "List of Azure Web Categorys for a given Subscription."
},
"nextLink": {
"type": "string",
"description": "URL to get the next set of results."
}
},
"description": "Response for ListAzureWebCategories API service call."
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"parameters": {
"api-version": "2020-08-01",
"subscriptionId": "4de8428a-4a92-4cea-90ff-b47128b8cab8"
},
"responses": {
"200": {
"body": {
"value": [
{
"name": "Arts",
"id": "/subscriptions/4de8428a-4a92-4cea-90ff-b47128b8cab8/providers/Microsoft.Network/azureWebCategories/Arts",
"type": "Microsoft.Network/azureWebCategories",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"properties": {
"group": "General"
}
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"parameters": {
"api-version": "2020-08-01",
"subscriptionId": "4de8428a-4a92-4cea-90ff-b47128b8cab8",
"name": "Arts"
},
"responses": {
"200": {
"body": {
"name": "Arts",
"id": "/subscriptions/4de8428a-4a92-4cea-90ff-b47128b8cab8/providers/Microsoft.Network/azureWebCategories/Arts",
"type": "Microsoft.Network/azureWebCategories",
"etag": "w/\\00000000-0000-0000-0000-000000000000\\",
"properties": {
"group": "General"
}
}
}
}
}
1 change: 1 addition & 0 deletions specification/network/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ input-file:
- Microsoft.Network/stable/2020-06-01/availableServiceAliases.json
- Microsoft.Network/stable/2020-06-01/azureFirewall.json
- Microsoft.Network/stable/2020-06-01/azureFirewallFqdnTag.json
- Microsoft.Network/stable/2020-06-01/azureWebCategory.json
- Microsoft.Network/stable/2020-06-01/bastionHost.json
- Microsoft.Network/stable/2020-06-01/checkDnsAvailability.json
- Microsoft.Network/stable/2020-06-01/customIpPrefix.json
Expand Down