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

Specs for ServiceTags resource #6084

Merged
merged 4 commits into from
May 23, 2019
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
@@ -0,0 +1,88 @@
{
"parameters": {
"api-version": "2019-04-01",
"location": "regionName",
"subscriptionId": "subId"
},
"responses": {
"200": {
"body": {
"name": "public",
"id": "/subscriptions/subId/providers/Microsoft.Network/serviceTags/public",
"type": "Microsoft.Network/serviceTags",
"changeNumber": "63",
"cloud": "Public",
"values": [
{
"name": "ApiManagement",
"id": "ApiManagement",
"properties": {
"changeNumber": "7",
"region": "",
"systemService": "AzureApiManagement",
"addressPrefixes": [
"13.64.39.16/32",
"40.74.146.80/31",
"40.74.147.32/28"
]
}
},
{
"name": "ApiManagement.AustraliaCentral",
"id": "ApiManagement.AustraliaCentral",
"properties": {
"changeNumber": "2",
"region": "australiacentral",
"systemService": "AzureApiManagement",
"addressPrefixes": [
"20.36.106.68/31",
"20.36.107.176/28"
]
}
},
{
"name": "AppService",
"id": "AppService",
"properties": {
"changeNumber": "13",
"region": "",
"systemService": "AzureAppService",
"addressPrefixes": [
"13.64.73.110/32",
"191.235.208.12/32",
"191.235.215.184/32"
]
}
},
{
"name": "ServiceBus",
"id": "ServiceBus",
"properties": {
"changeNumber": "10",
"region": "",
"systemService": "AzureServiceBus",
"addressPrefixes": [
"23.98.82.96/29",
"40.68.127.68/32",
"40.70.146.64/29"
]
}
},
{
"name": "ServiceBus.EastUS2",
"id": "ServiceBus.EastUS2",
"properties": {
"changeNumber": "1",
"region": "eastus2",
"systemService": "AzureServiceBus",
"addressPrefixes": [
"13.68.110.36/32",
"40.70.146.64/29"
]
}
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
{
"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": "2019-04-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/locations/{location}/serviceTags": {
"get": {
"operationId": "ServiceTags_List",
"description": "Gets a list of service tag information resources.",
"parameters": [
{
"name": "location",
"in": "path",
"required": true,
"type": "string",
"description": "The location."
},
{
"$ref": "./network.json#/parameters/ApiVersionParameter"
},
{
"$ref": "./network.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Request successful. Returns a list of service tag information resources.",
"schema": {
"$ref": "#/definitions/ServiceTagsListResult"
}
}
},
"x-ms-examples": {
"Get list of service tags": {
"$ref": "./examples/ServiceTagsList.json"
}
}
}
}
},
"definitions": {
"ServiceTagsListResult": {
"properties": {
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a bit confusing.
The list result contains name, id and type along with an array of ServiceTagInformation objects which in turn have the same name, id, type properties?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

name. id in ServiceTagsListResult are for from which cloud the data is (Public, Chinese, US Government or German Government).
name and id of ServiceTagInformation show which service the inforrmation is about

{
  "name": "public",
  "id": "/subscriptions/subId/providers/Microsoft.Network/serviceTags/public",
  "values": [
    {
      "name": "ApiManagement",
      "id": "ApiManagement"
     }
  ]
}

Maybe @chandrasekarsrinivasan could give more context if it's still unclear

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the explanation. I think someone from ARM should sign this off.
Per your explanation it seems like name, id, type must be readonly

Copy link
Contributor

Choose a reason for hiding this comment

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

Per offline thread, these are read only operations, please mark the appropriate properties as readonly

Copy link
Contributor

Choose a reason for hiding this comment

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

Already sent the ARM approval email.

"name": {
"type": "string",
"readOnly": true,
"description": "The name of the cloud."
},
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of the cloud."
},
"type": {
"type": "string",
"readOnly": true,
"description": "The azure resource type."
},
"changeNumber": {
"type": "string",
"readOnly": true,
"description": "The iteration number."
},
"cloud": {
"type": "string",
"readOnly": true,
"description": "The name of the cloud."
},
"values": {
"type": "array",
"items": {
"$ref": "#/definitions/ServiceTagInformation"
},
"readOnly": true,
"description": "The list of service tag information resources."
}
},
"description": "Response for the ListServiceTags API service call."
},
"ServiceTagInformation": {
"properties": {
"properties": {
"$ref": "#/definitions/ServiceTagInformationPropertiesFormat",
"readOnly": true,
"description": "Properties of the service tag information."
},
"name": {
"type": "string",
"readOnly": true,
"description": "The name of service tag."
},
"id": {
"type": "string",
"readOnly": true,
"description": "The ID of service tag."
}
},
"description": "The service tag information."
},
"ServiceTagInformationPropertiesFormat": {
"properties": {
"changeNumber": {
"type": "string",
"readOnly": true,
"description": "The iteration number of service tag."
},
"region": {
"type": "string",
"readOnly": true,
"description": "The region of service tag."
},
"systemService": {
"type": "string",
"readOnly": true,
"description": "The name of system service."
},
"addressPrefixes": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true,
"description": "The list of IP address prefixes."
}
},
"description": "Properties of the service tag information."
}
}
}
1 change: 1 addition & 0 deletions specification/network/resource-manager/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ input-file:
- Microsoft.Network/stable/2019-04-01/routeTable.json
- Microsoft.Network/stable/2019-04-01/serviceCommunity.json
- Microsoft.Network/stable/2019-04-01/serviceEndpointPolicy.json
- Microsoft.Network/stable/2019-04-01/serviceTags.json
- Microsoft.Network/stable/2019-04-01/usage.json
- Microsoft.Network/stable/2019-04-01/virtualNetwork.json
- Microsoft.Network/stable/2019-04-01/virtualNetworkGateway.json
Expand Down