Skip to content

[Hub Generated] Review request for Microsoft.Devices to add version preview/2022-04-30-preview #18743

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.

Sign up for GitHub

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

Merged
weidongxu-microsoft merged 42 commits into from
Aug 10, 2022
Merged

[Hub Generated] Review request for Microsoft.Devices to add version preview/2022-04-30-preview #18743

Show file tree
Hide file tree
Changes from 38 commits
Commits
Show all changes
42 commits
Select commit Hold shift + click to select a range
462851d
Adds base for updating Microsoft.Devices from version preview/2021-07…
didact2401 Apr 18, 2022
a29a045
Updates readme
didact2401 Apr 18, 2022
874816b
Updates API version in new specs and examples
didact2401 Apr 18, 2022
83f4a7b
Add RoutingCosmosDBCollectionProperties to iothub.json.
Apr 19, 2022
d837bf6
Update naming.
Apr 19, 2022
b167354
Fix enum.
Apr 20, 2022
061ac56
Unique x-ms-enum names.
Apr 26, 2022
6279e70
Use same name for same enum def.
Apr 26, 2022
214fb0a
Revert "Use same name for same enum def."
Apr 26, 2022
366c4b3
Use same name for enum.
Apr 28, 2022
15b8dc9
Revert "Use same name for enum."
Apr 29, 2022
dd9f07f
Adds suppression to readme
didact2401 Apr 29, 2022
0636b65
Revert "Revert "Use same name for enum.""
Apr 30, 2022
96d4e45
Update reason on UniqueXmsEnumName suppression.
May 2, 2022
8c9b66f
Ensure camel casing on partitionKeyName and partitionKeyTemplate.
May 2, 2022
c0ba99e
Add 'deviceid' to custom-words.txt.
May 12, 2022
e04f403
Add x-ms-secret.
May 16, 2022
b8a3f12
Remove secret tag for storage endpoint connection string.
May 16, 2022
3b1b3a0
Adding the change for rootCertificateV2
firstaye-zz Jun 17, 2022
43c1d40
typo
firstaye-zz Jul 13, 2022
811ae38
fixing validation error
firstaye-zz Jul 22, 2022
d5c5d12
Update error response schema
firstaye-zz Jul 22, 2022
04dfea8
fixing tag
firstaye-zz Jul 22, 2022
cd3f84e
adding Azure-AsyncOperation as header
firstaye-zz Jul 22, 2022
7bcd8ff
fix: adding Azure-AsyncOperation as header
firstaye-zz Jul 22, 2022
51f90c3
Fix semantic error
firstaye-zz Jul 25, 2022
47d477e
header fix
firstaye-zz Jul 25, 2022
aeba554
adding x-ms-identifiers
firstaye-zz Jul 25, 2022
14158c9
fix
firstaye-zz Jul 25, 2022
a237dd0
fix
firstaye-zz Jul 25, 2022
998bac5
prettier fix
firstaye-zz Jul 25, 2022
8388c98
Azure-Async header position testing
firstaye-zz Jul 25, 2022
42960e9
re-trigger stuck queue validation jobs
firstaye-zz Jul 26, 2022
8a10eaa
revert change
firstaye-zz Jul 26, 2022
97ce1b2
testing Azure AsyncOperation header
firstaye-zz Jul 26, 2022
7f7d724
Adding Azure-AsyncOperation to other possible place to mitigate the e…
firstaye-zz Jul 26, 2022
9139f88
make small change to retrigger the check queue
firstaye-zz Jul 26, 2022
37eccbc
Adding Async Operation header to the examples.
firstaye-zz Jul 27, 2022
4652054
fix format
firstaye-zz Jul 27, 2022
5d52056
Typo fix
firstaye-zz Jul 27, 2022
845c26b
revert the change of error details schema
firstaye-zz Jul 27, 2022
8827e4e
Revert unwanted changes
firstaye-zz Aug 3, 2022
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -579,6 +579,7 @@ deterministically
deviceclasses
devicecredentials
devicegroups
deviceid
deviceids
deviceprovisioningservices
devicestates
Expand Down
17 changes: 14 additions & 3 deletions ...-manager/Microsoft.Devices/preview/2022-04-30-preview/examples/iothub_createOrUpdate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,10 @@
},
"features": "None",
"minTlsVersion": "1.2",
"enableDataResidency": true
"enableDataResidency": true,
"rootCertificate": {
"enableRootCertificateV2": true
}
},
"sku": {
"name": "S1",
Expand Down Expand Up @@ -181,7 +184,11 @@
},
"features": "None",
"minTlsVersion": "1.2",
"enableDataResidency": true
"enableDataResidency": true,
"rootCertificate": {
"enableRootCertificateV2": true,
"lastUpdatedTimeUtc": "2022-04-08T11:16:49.0748958-07:00"
}
},
"sku": {
"name": "S1",
Expand Down Expand Up @@ -289,7 +296,11 @@
},
"features": "None",
"minTlsVersion": "1.2",
"enableDataResidency": true
"enableDataResidency": true,
"rootCertificate": {
"enableRootCertificateV2": true,
"lastUpdatedTimeUtc": "2022-04-08T11:16:49.0748958-07:00"
}
},
"sku": {
"name": "S1",
Expand Down
6 changes: 6 additions & 0 deletions ...resource-manager/Microsoft.Devices/preview/2022-04-30-preview/examples/iothub_delete.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
},
"responses": {
"200": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2022-04-30-preview"
},
"body": {
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
"name": "testHub",
Expand Down Expand Up @@ -113,6 +116,9 @@
},
"204": {},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2022-04-30-preview"
},
"body": {
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub",
"name": "testHub",
Expand Down
6 changes: 6 additions & 0 deletions ...t.Devices/preview/2022-04-30-preview/examples/iothub_deleteprivateendpointconnection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
},
"responses": {
"200": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2022-04-30-preview"
},
"body": {
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection",
"name": "myPrivateEndpointConnection",
Expand All @@ -25,6 +28,9 @@
}
},
"202": {
"headers": {
"Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/locations/eastus/operationResults/00000000-0000-0000-0000-000000000000/Spring/default?api-version=2022-04-30-preview"
},
"body": {
"id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection",
"name": "myPrivateEndpointConnection",
Expand Down
10 changes: 5 additions & 5 deletions ...r/Microsoft.Devices/preview/2022-04-30-preview/examples/iothub_routingendpointhealth.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
{
"endpointId": "id1",
"healthStatus": "healthy",
"lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z",
"lastSendAttemptTime": "2020-03-26T21:24:57Z"
"lastSuccessfulSendAttemptTime": "Wed, 13 Sep 2017 18:04:32 GMT",
"lastSendAttemptTime": "Wed, 13 Sep 2017 18:04:32 GMT"
},
{
"endpointId": "id2",
Expand All @@ -23,9 +23,9 @@
"endpointId": "id3",
"healthStatus": "unhealthy",
"lastKnownError": "NotFound",
"lastKnownErrorTime": "2020-03-26T21:24:57Z",
"lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z",
"lastSendAttemptTime": "2020-03-26T21:24:57Z"
"lastKnownErrorTime": "Wed, 13 Sep 2017 18:04:32 GMT",
"lastSuccessfulSendAttemptTime": "Wed, 13 Sep 2017 18:04:32 GMT",
"lastSendAttemptTime": "Wed, 13 Sep 2017 18:04:32 GMT"
}
]
}
Expand Down
150 changes: 144 additions & 6 deletions ...fication/iothub/resource-manager/Microsoft.Devices/preview/2022-04-30-preview/iothub.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,12 @@
],
"responses": {
"201": {
"headers": {
Copy link
Member

@raych1 raych1 Jul 25, 2022

Choose a reason for hiding this comment

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

This should be the definition of header instead of the value.
Pls refer to https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#headers-object.

"Azure-AsyncOperation": {
"description": "URL to query for status of the operation.",
"type": "string"
}
},
"description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).",
"schema": {
"$ref": "#/definitions/IotHubDescription"
Expand Down Expand Up @@ -227,6 +233,12 @@
],
"responses": {
"200": {
"headers": {
"Azure-AsyncOperation": {
"description": "URL to query for status of the operation.",
"type": "string"
}
},
"description": "Iot Hub was successfully updated",
"schema": {
"$ref": "#/definitions/IotHubDescription"
Expand Down Expand Up @@ -269,6 +281,12 @@
],
"responses": {
"202": {
"headers": {
"Azure-AsyncOperation": {
"description": "URL to query for status of the operation.",
"type": "string"
}
},
"description": "The Iot Hub resource provider always returns a 202 Accepted status code with valid Location and Retry-After headers. The resource provider also sets the Azure-AsyncOperation header with a URL that points to the operation resource for this operation. Subsequent GET attempts on the resource after a DELETE operation return a resource representation that indicates a transitional provisioning state (such as Terminating). To retrieve the status of the operation, a client can either poll the URL returned in the Location header after the Retry-After interval, get the IoT Hub service status directly, or query the operation resource.",
"schema": {
"$ref": "#/definitions/IotHubDescription"
Expand Down Expand Up @@ -1950,6 +1968,12 @@
],
"responses": {
"201": {
"headers": {
"Azure-AsyncOperation": {
"description": "URL to query for status of the operation.",
"type": "string"
}
},
"description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnection"
Expand Down Expand Up @@ -2002,6 +2026,12 @@
],
"responses": {
"202": {
"headers": {
"Azure-AsyncOperation": {
"description": "URL to query for status of the operation.",
"type": "string"
}
},
"description": "This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnection"
Expand Down Expand Up @@ -2421,6 +2451,9 @@
"enableDataResidency": {
"description": "This property when set to true, will enable data residency, thus, disabling disaster recovery.",
"type": "boolean"
},
"rootCertificate": {
"$ref": "#/definitions/RootCertificateProperties"
}
}
},
Expand Down Expand Up @@ -2919,6 +2952,13 @@
"items": {
"$ref": "#/definitions/RoutingStorageContainerProperties"
}
},
"cosmosDBSqlCollections": {
"description": "The list of Cosmos DB collection endpoints that IoT hub routes messages to, based on the routing rules.",
"type": "array",
"items": {
"$ref": "#/definitions/RoutingCosmosDBSqlApiProperties"
}
}
}
},
Expand All @@ -2932,7 +2972,8 @@
},
"connectionString": {
"description": "The connection string of the service bus queue endpoint.",
"type": "string"
"type": "string",
"x-ms-secret": true
},
"endpointUri": {
"description": "The url of the service bus queue endpoint. It must include the protocol sb://",
Expand Down Expand Up @@ -2986,7 +3027,8 @@
},
"connectionString": {
"description": "The connection string of the service bus topic endpoint.",
"type": "string"
"type": "string",
"x-ms-secret": true
},
"endpointUri": {
"description": "The url of the service bus topic endpoint. It must include the protocol sb://",
Expand Down Expand Up @@ -3040,7 +3082,8 @@
},
"connectionString": {
"description": "The connection string of the event hub endpoint. ",
"type": "string"
"type": "string",
"x-ms-secret": true
},
"endpointUri": {
"description": "The url of the event hub endpoint. It must include the protocol sb://",
Expand Down Expand Up @@ -3094,7 +3137,8 @@
},
"connectionString": {
"description": "The connection string of the storage account.",
"type": "string"
"type": "string",
"x-ms-secret": true
},
"endpointUri": {
"description": "The url of the storage endpoint. It must include the protocol https://",
Expand Down Expand Up @@ -3166,6 +3210,81 @@
"containerName"
]
},
"RoutingCosmosDBSqlApiProperties": {
"description": "The properties related to a cosmos DB sql collection endpoint.",
"type": "object",
"properties": {
"name": {
"description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.",
"type": "string",
"pattern": "^[A-Za-z0-9-._]{1,64}$"
},
"id": {
"description": "Id of the cosmos DB sql collection endpoint",
"type": "string"
},
"subscriptionId": {
"description": "The subscription identifier of the cosmos DB account.",
"type": "string"
},
"resourceGroup": {
"description": "The name of the resource group of the cosmos DB account.",
"type": "string"
},
"endpointUri": {
"description": "The url of the cosmos DB account. It must include the protocol https://",
"type": "string"
},
"authenticationType": {
"description": "Method used to authenticate against the cosmos DB sql collection endpoint",
"enum": [
"keyBased",
"identityBased"
],
"type": "string",
"x-ms-enum": {
"name": "authenticationType",
"modelAsString": true
}
},
"identity": {
"description": "Managed identity properties of routing cosmos DB collection endpoint.",
"$ref": "#/definitions/ManagedIdentity"
},
"primaryKey": {
"description": "The primary key of the cosmos DB account.",
"type": "string",
"x-ms-secret": true
},
"secondaryKey": {
"description": "The secondary key of the cosmos DB account.",
"type": "string",
"x-ms-secret": true
},
"databaseName": {
"description": "The name of the cosmos DB database in the cosmos DB account.",
"type": "string"
},
"collectionName": {
"description": "The name of the cosmos DB sql collection in the cosmos DB database.",
"type": "string"
},
"partitionKeyName": {
"description": "The name of the partition key associated with this cosmos DB sql collection if one exists. This is an optional parameter.",
"type": "string"
},
"partitionKeyTemplate": {
"description": "The template for generating a synthetic partition key value for use with this cosmos DB sql collection. The template must include at least one of the following placeholders: {iothub}, {deviceid}, {DD}, {MM}, and {YYYY}. Any one placeholder may be specified at most once, but order and non-placeholder components are arbitrary. This parameter is only required if PartitionKeyName is specified.",
"type": "string"
}
},
"required": [
"name",
"endpointUri",
"databaseName",
"collectionName"
]
},
"RouteProperties": {
"description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.",
"type": "object",
Expand Down Expand Up @@ -4239,7 +4358,7 @@
"type": "string"
},
"inputBlobName": {
"description": "The blob name to be used when importing from the provided input blob container.",
"description": "from the provided input blob container.",
"type": "string"
},
"outputBlobName": {
Expand Down Expand Up @@ -4372,7 +4491,10 @@
"type": "array",
"items": {
"$ref": "#/definitions/KeyVaultKeyProperties"
}
},
"x-ms-identifiers": [
"keyIdentifier"
]
}
}
},
Expand Down Expand Up @@ -4452,6 +4574,22 @@
"description": "The timestamp of resource last modification (UTC)"
}
}
},
"RootCertificateProperties": {
"description": "This property store root certificate related information",
"type": "object",
"properties": {
"enableRootCertificateV2": {
"description": "This property when set to true, hub will use G2 cert; while it's set to false, hub uses Baltimore Cert.",
"type": "boolean"
},
"lastUpdatedTimeUtc": {
"type": "string",
"readOnly": true,
"format": "date-time",
"description": "the last update time to root certificate flag."
}
}
}
},
"parameters": {
Expand Down
Loading