diff --git a/specification/sphere/Sphere.Management/catalog.tsp b/specification/sphere/Sphere.Management/catalog.tsp index 4c3c92621d38..bec5ec57fba8 100644 --- a/specification/sphere/Sphere.Management/catalog.tsp +++ b/specification/sphere/Sphere.Management/catalog.tsp @@ -1,9 +1,11 @@ import "@typespec/rest"; +import "@typespec/openapi"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; using TypeSpec.Http; +using TypeSpec.OpenAPI; using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.ResourceManager.Foundations; @@ -25,6 +27,11 @@ model Catalog is TrackedResource { @doc("Catalog properties") model CatalogProperties { + @visibility("read") + @doc("The Azure Sphere tenant ID associated with the catalog.") + @added(Microsoft.AzureSphere.Versions.v2024_04_01) + tenantId?: string; + @visibility("read") @doc("The status of the last operation.") provisioningState?: ProvisioningState; @@ -68,14 +75,28 @@ interface Catalogs Catalog, CatalogProperties > { + @removed(Versions.v2024_04_01) @autoRoute @doc("Counts devices in catalog.") @armResourceAction(Catalog) + @action("countDevices") + @renamedFrom(Versions.v2024_04_01, "countDevices") @post - countDevices( + deprecated( ...ResourceInstanceParameters, ): ArmResponse | ErrorResponse; + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" + @added(Versions.v2024_04_01) + @sharedRoute + @autoRoute + @doc("Counts devices in catalog.") + @armResourceAction(Catalog) + @post + countDevices( + ...ResourceInstanceParameters, + ): ArmResponse | ErrorResponse; + @autoRoute @doc("Lists device insights for catalog.") @armResourceAction(Catalog) @@ -115,4 +136,23 @@ interface Catalogs @body listDeviceGroupsRequest: ListDeviceGroupsRequest, ): ArmResponse> | ErrorResponse; + + @autoRoute + @armResourceAction(Catalog) + @added(Versions.v2024_04_01) + @doc("Creates an image. Use this action when the image ID is unknown.") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + uploadImage( + ...ResourceInstanceParameters, + + @doc("Image upload request body.") + @body + uploadImageRequest: Image, + ): ArmAcceptedLroResponse | ErrorResponse; } diff --git a/specification/sphere/Sphere.Management/common.tsp b/specification/sphere/Sphere.Management/common.tsp index df93ccecdb16..7077008ea5bd 100644 --- a/specification/sphere/Sphere.Management/common.tsp +++ b/specification/sphere/Sphere.Management/common.tsp @@ -18,6 +18,7 @@ interface Operations extends Azure.ResourceManager.Operations {} // Common models /** Provisioning state of the resource. */ +@doc("Provisioning state of resource.") @lroStatus enum ProvisioningState { ...ResourceProvisioningState, @@ -103,9 +104,12 @@ alias StandardListQueryParametersWithCorrectNames = { ...CustomMaxPageSizeQueryParameter; }; -@doc("Response to the action call for count devices in a catalog.") +@doc("Response to the action call for count devices in a catalog (preview API).") model CountDeviceResponse extends CountElementsResponse {} +@doc("Response to the action call for count devices in a catalog.") +model CountDevicesResponse extends CountElementsResponse {} + @doc("Response of the count for elements.") model CountElementsResponse { @doc("Number of children resources in parent resource.") diff --git a/specification/sphere/Sphere.Management/device.tsp b/specification/sphere/Sphere.Management/device.tsp index 721646dde28e..9019f449e917 100644 --- a/specification/sphere/Sphere.Management/device.tsp +++ b/specification/sphere/Sphere.Management/device.tsp @@ -47,7 +47,10 @@ interface ProxyResourceOperationsDevice< @armResourceOperations interface Devices extends ProxyResourceOperationsDevice { @autoRoute + @removed(Versions.v2024_04_01) + @renamedFrom(Versions.v2024_04_01, "generateCapabilityImage") @armResourceAction(Device) + @action("generateCapabilityImage") @post @doc("Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.") @extension("x-ms-long-running-operation", true) @@ -57,13 +60,35 @@ interface Devices extends ProxyResourceOperationsDevice { `final-state-via`: "location", } ) - generateCapabilityImage( + deprecatedGenerateCapabilityImage( ...ResourceInstanceParameters, @doc("Generate capability image request body.") @body generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, ): ArmResponse | ArmAcceptedResponse | ErrorResponse; + + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" + @autoRoute + @sharedRoute + @added(Versions.v2024_04_01) + @armResourceAction(Device) + @post + @doc("Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + generateCapabilityImage( + ...ResourceInstanceParameters, + + @doc("Generate capability image request body.") + @body + generateDeviceCapabilityRequest: GenerateCapabilityImageRequest, + ): ArmResponse | ArmAcceptedLroResponse | ErrorResponse; } @doc("The properties of device") diff --git a/specification/sphere/Sphere.Management/deviceGroup.tsp b/specification/sphere/Sphere.Management/deviceGroup.tsp index 9baf49745b17..8226c0013d66 100644 --- a/specification/sphere/Sphere.Management/deviceGroup.tsp +++ b/specification/sphere/Sphere.Management/deviceGroup.tsp @@ -50,16 +50,33 @@ interface DeviceGroups DeviceGroup, ListQueryParameters > { + @doc("Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.") + @removed(Versions.v2024_04_01) @autoRoute + @renamedFrom(Versions.v2024_04_01, "countDevices") + @armResourceAction(DeviceGroup) + @action("countDevices") + @post + deprecatedCountDevices( + ...ResourceInstanceParameters, + ): ArmResponse | ErrorResponse; + + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" @doc("Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.") + @added(Versions.v2024_04_01) + @autoRoute + @sharedRoute @armResourceAction(DeviceGroup) @post countDevices( ...ResourceInstanceParameters, - ): ArmResponse | ErrorResponse; + ): ArmResponse | ErrorResponse; @autoRoute @armResourceAction(DeviceGroup) + @action("claimDevices") + @removed(Versions.v2024_04_01) + @renamedFrom(Versions.v2024_04_01, "claimDevices") @doc("Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.") @extension("x-ms-long-running-operation", true) @extension( @@ -69,13 +86,35 @@ interface DeviceGroups } ) @post - claimDevices( + deprecatedClaimDevices( ...ResourceInstanceParameters, @doc("Bulk claim devices request body.") @body claimDevicesRequest: ClaimDevicesRequest, ): ArmAcceptedResponse | ErrorResponse; + + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" + @autoRoute + @sharedRoute + @added(Versions.v2024_04_01) + @armResourceAction(DeviceGroup) + @doc("Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.") + @extension("x-ms-long-running-operation", true) + @extension( + "x-ms-long-running-operation-options", + { + `final-state-via`: "location", + } + ) + @post + claimDevices( + ...ResourceInstanceParameters, + + @doc("Bulk claim devices request body.") + @body + claimDevicesRequest: ClaimDevicesRequest, + ): ArmAcceptedLroResponse | ErrorResponse; } @doc("The properties of deviceGroup") diff --git a/specification/sphere/Sphere.Management/examples/DeleteCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/DeleteDeployment.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDeployment.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteDeployment.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDeployment.json diff --git a/specification/sphere/Sphere.Management/examples/DeleteDevice.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDevice.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteDevice.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDevice.json diff --git a/specification/sphere/Sphere.Management/examples/DeleteDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/DeleteImage.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteImage.json similarity index 91% rename from specification/sphere/Sphere.Management/examples/DeleteImage.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteImage.json index c87670823a95..3f46df5bf8c8 100644 --- a/specification/sphere/Sphere.Management/examples/DeleteImage.json +++ b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "imageID", + "imageName": "00000000-0000-0000-0000-000000000000", "api-version": "2022-09-01-preview" }, "responses": { diff --git a/specification/sphere/Sphere.Management/examples/DeleteProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/DeleteProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/DeleteProduct.json diff --git a/specification/sphere/Sphere.Management/examples/GetCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/GetCatalogsRG.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalogsRG.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCatalogsRG.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalogsRG.json diff --git a/specification/sphere/Sphere.Management/examples/GetCatalogsSub.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalogsSub.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCatalogsSub.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCatalogsSub.json diff --git a/specification/sphere/Sphere.Management/examples/GetCertificate.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCertificate.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCertificate.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCertificate.json diff --git a/specification/sphere/Sphere.Management/examples/GetCertificates.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCertificates.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetCertificates.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetCertificates.json diff --git a/specification/sphere/Sphere.Management/examples/GetDeployment.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeployment.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDeployment.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeployment.json diff --git a/specification/sphere/Sphere.Management/examples/GetDeployments.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeployments.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDeployments.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeployments.json diff --git a/specification/sphere/Sphere.Management/examples/GetDevice.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDevice.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDevice.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDevice.json diff --git a/specification/sphere/Sphere.Management/examples/GetDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/GetDeviceGroups.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeviceGroups.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDeviceGroups.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDeviceGroups.json diff --git a/specification/sphere/Sphere.Management/examples/GetDevices.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDevices.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetDevices.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetDevices.json diff --git a/specification/sphere/Sphere.Management/examples/GetImage.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImage.json similarity index 87% rename from specification/sphere/Sphere.Management/examples/GetImage.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImage.json index 3023a79d50c5..ca620f29bb05 100644 --- a/specification/sphere/Sphere.Management/examples/GetImage.json +++ b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "myImageId", + "imageName": "00000000-0000-0000-0000-000000000000", "api-version": "2022-09-01-preview" }, "responses": { diff --git a/specification/sphere/Sphere.Management/examples/GetImages.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImages.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetImages.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetImages.json diff --git a/specification/sphere/Sphere.Management/examples/GetOperations.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetOperations.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetOperations.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetOperations.json diff --git a/specification/sphere/Sphere.Management/examples/GetProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetProduct.json diff --git a/specification/sphere/Sphere.Management/examples/GetProducts.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetProducts.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/GetProducts.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/GetProducts.json diff --git a/specification/sphere/Sphere.Management/examples/PatchCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PatchCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PatchDevice.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchDevice.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PatchDevice.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchDevice.json diff --git a/specification/sphere/Sphere.Management/examples/PatchDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PatchDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/PatchProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PatchProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PatchProduct.json diff --git a/specification/sphere/Sphere.Management/examples/PostClaimDevices.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostClaimDevices.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostClaimDevices.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostClaimDevices.json diff --git a/specification/sphere/Sphere.Management/examples/PostCountDevicesCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostCountDevicesCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostCountDevicesDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostCountDevicesDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/PostCountDevicesProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostCountDevicesProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostCountDevicesProduct.json diff --git a/specification/sphere/Sphere.Management/examples/PostGenerateDefaultDeviceGroups.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostGenerateDefaultDeviceGroups.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostGenerateDefaultDeviceGroups.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostGenerateDefaultDeviceGroups.json diff --git a/specification/sphere/Sphere.Management/examples/PostGenerateDeviceCapabilityImage.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostGenerateDeviceCapabilityImage.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostGenerateDeviceCapabilityImage.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostGenerateDeviceCapabilityImage.json diff --git a/specification/sphere/Sphere.Management/examples/PostListDeploymentsByCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeploymentsByCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostListDeploymentsByCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeploymentsByCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostListDeviceGroupsCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeviceGroupsCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostListDeviceGroupsCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeviceGroupsCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostListDeviceInsightsCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeviceInsightsCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostListDeviceInsightsCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDeviceInsightsCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostListDevicesByCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDevicesByCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostListDevicesByCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostListDevicesByCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PostRetrieveCatalogCertChain.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostRetrieveCatalogCertChain.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostRetrieveCatalogCertChain.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostRetrieveCatalogCertChain.json diff --git a/specification/sphere/Sphere.Management/examples/PostRetrieveProofOfPossessionNonce.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostRetrieveProofOfPossessionNonce.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PostRetrieveProofOfPossessionNonce.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PostRetrieveProofOfPossessionNonce.json diff --git a/specification/sphere/Sphere.Management/examples/PutCatalog.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutCatalog.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutCatalog.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutCatalog.json diff --git a/specification/sphere/Sphere.Management/examples/PutDeployment.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDeployment.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutDeployment.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDeployment.json diff --git a/specification/sphere/Sphere.Management/examples/PutDevice.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDevice.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutDevice.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDevice.json diff --git a/specification/sphere/Sphere.Management/examples/PutDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDeviceGroup.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutDeviceGroup.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutDeviceGroup.json diff --git a/specification/sphere/Sphere.Management/examples/PutImage.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutImage.json similarity index 97% rename from specification/sphere/Sphere.Management/examples/PutImage.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutImage.json index c28ad12e90d3..7034054644d6 100644 --- a/specification/sphere/Sphere.Management/examples/PutImage.json +++ b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "default", + "imageName": ".default", "resource": { "properties": { "image": "bXliYXNlNjRzdHJpbmc=" diff --git a/specification/sphere/Sphere.Management/examples/PutProduct.json b/specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutProduct.json similarity index 100% rename from specification/sphere/Sphere.Management/examples/PutProduct.json rename to specification/sphere/Sphere.Management/examples/2022-09-01-preview/PutProduct.json diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteCatalog.json new file mode 100644 index 000000000000..658bc7b9990c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteCatalog.json @@ -0,0 +1,24 @@ +{ + "operationId": "Catalogs_Delete", + "title": "Catalogs_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeployment.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeployment.json new file mode 100644 index 000000000000..6a3411f17082 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeployment.json @@ -0,0 +1,27 @@ +{ + "operationId": "Deployments_Delete", + "title": "Deployments_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "deviceGroupName": "DeviceGroupName1", + "deploymentName": "MyDeploymentName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDevice.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDevice.json new file mode 100644 index 000000000000..057b4d7b71c7 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDevice.json @@ -0,0 +1,27 @@ +{ + "operationId": "Devices_Delete", + "title": "Devices_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "deviceGroupName": "DeviceGroupName1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeviceGroup.json new file mode 100644 index 000000000000..41eab5c0492c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteDeviceGroup.json @@ -0,0 +1,26 @@ +{ + "operationId": "DeviceGroups_Delete", + "title": "DeviceGroups_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteImage.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteImage.json new file mode 100644 index 000000000000..45b70048d57b --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteImage.json @@ -0,0 +1,25 @@ +{ + "operationId": "Images_Delete", + "title": "Images_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteProduct.json new file mode 100644 index 000000000000..0f5433be7216 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/DeleteProduct.json @@ -0,0 +1,25 @@ +{ + "operationId": "Products_Delete", + "title": "Products_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalog.json new file mode 100644 index 000000000000..87771799dffc --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalog.json @@ -0,0 +1,21 @@ +{ + "operationId": "Catalogs_Get", + "title": "Catalogs_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsRG.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsRG.json new file mode 100644 index 000000000000..488c94bc3c23 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsRG.json @@ -0,0 +1,30 @@ +{ + "operationId": "Catalogs_ListByResourceGroup", + "title": "Catalogs_ListByResourceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog2", + "name": "MyCatalog2", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsSub.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsSub.json new file mode 100644 index 000000000000..d715ad91a2ef --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCatalogsSub.json @@ -0,0 +1,29 @@ +{ + "operationId": "Catalogs_ListBySubscription", + "title": "Catalogs_ListBySubscription", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup2/providers/Microsoft.AzureSphere/catalogs/MyCatalog2", + "name": "MyCatalog2", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificate.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificate.json new file mode 100644 index 000000000000..a8c64f3db445 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificate.json @@ -0,0 +1,17 @@ +{ + "operationId": "Certificates_Get", + "title": "Certificates_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": {} + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificates.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificates.json new file mode 100644 index 000000000000..9c3fd6281498 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetCertificates.json @@ -0,0 +1,18 @@ +{ + "operationId": "Certificates_ListByCatalog", + "title": "Certificates_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployment.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployment.json new file mode 100644 index 000000000000..fc9af844c81f --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployment.json @@ -0,0 +1,38 @@ +{ + "operationId": "Deployments_Get", + "title": "Deployments_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deploymentName": "MyDeployment1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "dGVzdGltYWdl", + "regionalDataBoundary": "None", + "uri": "imageUri", + "description": "description", + "componentId": "componentId", + "imageType": "ImageType", + "provisioningState": "Succeeded" + } + } + ] + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployments.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployments.json new file mode 100644 index 000000000000..eef2ff5d1ac8 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeployments.json @@ -0,0 +1,42 @@ +{ + "operationId": "Deployments_ListByDeviceGroup", + "title": "Deployments_ListByDeviceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "dGVzdGltYWdl", + "regionalDataBoundary": "None", + "uri": "imageUri", + "description": "description", + "componentId": "componentId", + "imageType": "ImageType", + "provisioningState": "Succeeded" + } + } + ], + "deploymentDateUtc": "2022-09-30T21:51:39.2698729Z" + } + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevice.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevice.json new file mode 100644 index 000000000000..858ee313939f --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevice.json @@ -0,0 +1,29 @@ +{ + "operationId": "Devices_Get", + "title": "Devices_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": { + "chipSku": "MyChipSku1", + "lastAvailableOsVersion": "AvailableOsVersion1", + "lastInstalledOsVersion": "InstalledOsVersion1", + "lastOsUpdateUtc": "2022-09-30T23:54:21.96Z", + "lastUpdateRequestUtc": "2022-10-01T23:54:21.96Z" + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroup.json new file mode 100644 index 000000000000..1e8379ab7772 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroup.json @@ -0,0 +1,26 @@ +{ + "operationId": "DeviceGroups_Get", + "title": "DeviceGroups_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups", + "properties": { + "description": "The description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroups.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroups.json new file mode 100644 index 000000000000..46123e6f6d98 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDeviceGroups.json @@ -0,0 +1,30 @@ +{ + "operationId": "DeviceGroups_ListByProduct", + "title": "DeviceGroups_ListByProduct", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/Products/MyProduct2/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevices.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevices.json new file mode 100644 index 000000000000..c011cde1148a --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetDevices.json @@ -0,0 +1,29 @@ +{ + "operationId": "Devices_ListByDeviceGroup", + "title": "Devices_ListByDeviceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000-0000-0000-0000-000000000001", + "properties": {} + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000-0000-0000-0000-000000000002", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetImage.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetImage.json new file mode 100644 index 000000000000..8943a1fcf403 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetImage.json @@ -0,0 +1,17 @@ +{ + "operationId": "Images_Get", + "title": "Images_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": {} + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetImages.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetImages.json new file mode 100644 index 000000000000..7701f85222a1 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetImages.json @@ -0,0 +1,27 @@ +{ + "operationId": "Images_ListByCatalog", + "title": "Images_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "00000000-0000-0000-0000-000000000001", + "name": "MyImage1" + }, + { + "id": "00000000-0000-0000-0000-000000000002", + "name": "MyImage2" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetOperations.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetOperations.json new file mode 100644 index 000000000000..5a4b09163c2d --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetOperations.json @@ -0,0 +1,35 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "Microsoft.AzureSphere/catalogs/Read", + "display": { + "provider": "Microsoft.AzureSphere", + "resource": "catalog", + "operation": "Gets/List catalog", + "description": "Read Azure Sphere catalogs" + } + }, + { + "name": "Microsoft.AzureSphere/catalogs/Write", + "display": { + "provider": "Microsoft.AzureSphere", + "resource": "catalog", + "operation": "Create/Update catalog", + "description": "Writes Azure Sphere catalogs" + } + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetProduct.json new file mode 100644 index 000000000000..570db8296b81 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetProduct.json @@ -0,0 +1,23 @@ +{ + "operationId": "Products_Get", + "title": "Products_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "type": "microsoft.azureSphere/catalogs/products", + "properties": { + "description": "product description." + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/GetProducts.json b/specification/sphere/Sphere.Management/examples/2024-04-01/GetProducts.json new file mode 100644 index 000000000000..915cd38158a3 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/GetProducts.json @@ -0,0 +1,29 @@ +{ + "operationId": "Products_ListByCatalog", + "title": "Products_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/products" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2", + "name": "MyProduct2", + "type": "Microsoft.AzureSphere/catalogs/products" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PatchCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchCatalog.json new file mode 100644 index 000000000000..bec2ebeca152 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchCatalog.json @@ -0,0 +1,25 @@ +{ + "operationId": "Catalogs_Update", + "title": "Catalogs_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "properties": {}, + "resource": { + "location": "global" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDevice.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDevice.json new file mode 100644 index 000000000000..6dd5ed784af2 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDevice.json @@ -0,0 +1,36 @@ +{ + "operationId": "Devices_Update", + "title": "Devices_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1/device/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "type": "Microsoft.AzureSphere/catalogs/products/devicegroups", + "properties": { + "chipSku": "MyChipSku1", + "lastAvailableOsVersion": "AvailableOsVersion1", + "lastInstalledOsVersion": "InstalledOsVersion1", + "lastOsUpdateUtc": "2022-10-30T23:54:21.96Z", + "lastUpdateRequestUtc": "2022-10-01T23:54:21.96Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "The device update started successfully." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDeviceGroup.json new file mode 100644 index 000000000000..84cd946a5ca9 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchDeviceGroup.json @@ -0,0 +1,33 @@ +{ + "operationId": "DeviceGroups_Update", + "title": "DeviceGroups_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups", + "properties": { + "description": "The description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "Resource update request accepted." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PatchProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchProduct.json new file mode 100644 index 000000000000..e2da1aafeb7e --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PatchProduct.json @@ -0,0 +1,30 @@ +{ + "operationId": "Products_Update", + "title": "Products_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "type": "microsoft.azureSphere/catalogs/products", + "properties": { + "description": "Product description." + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "Resource update request accepted." + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostClaimDevices.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostClaimDevices.json new file mode 100644 index 000000000000..193ef5d3e2a6 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostClaimDevices.json @@ -0,0 +1,25 @@ +{ + "operationId": "DeviceGroups_ClaimDevices", + "title": "DeviceGroups_ClaimDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "claimDevicesRequest": { + "deviceIdentifiers": [ + "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + ] + }, + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesCatalog.json new file mode 100644 index 000000000000..979f312d235a --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesCatalog.json @@ -0,0 +1,18 @@ +{ + "operationId": "Catalogs_CountDevices", + "title": "Catalogs_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesDeviceGroup.json new file mode 100644 index 000000000000..45e5e0b05ad3 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesDeviceGroup.json @@ -0,0 +1,20 @@ +{ + "operationId": "DeviceGroups_CountDevices", + "title": "DeviceGroups_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesProduct.json new file mode 100644 index 000000000000..4ca2bcd28a2c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostCountDevicesProduct.json @@ -0,0 +1,21 @@ +{ + "operationId": "Products_CountDevices", + "title": "Products_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "productGroupName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDefaultDeviceGroups.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDefaultDeviceGroups.json new file mode 100644 index 000000000000..b86ea57c2833 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDefaultDeviceGroups.json @@ -0,0 +1,40 @@ +{ + "operationId": "Products_GenerateDefaultDeviceGroups", + "title": "Products_GenerateDefaultDeviceGroups", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "properties": { + "description": "Device group description 1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll", + "allowCrashDumpsCollection": "Enabled" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "properties": { + "description": "Device group description 2", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll", + "allowCrashDumpsCollection": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDeviceCapabilityImage.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDeviceCapabilityImage.json new file mode 100644 index 000000000000..3f10e240a86c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostGenerateDeviceCapabilityImage.json @@ -0,0 +1,32 @@ +{ + "operationId": "Devices_GenerateCapabilityImage", + "title": "Devices_GenerateCapabilityImage", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "generateDeviceCapabilityRequest": { + "capabilities": [ + "ApplicationDevelopment" + ] + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "image": "TheDeviceCapabilityImage" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeploymentsByCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeploymentsByCatalog.json new file mode 100644 index 000000000000..9e1bafb39819 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeploymentsByCatalog.json @@ -0,0 +1,27 @@ +{ + "operationId": "Catalogs_ListDeployments", + "title": "Catalogs_ListDeployments", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "DeploymentName1111", + "properties": {} + }, + { + "name": "DeploymentName1121", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceGroupsCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceGroupsCatalog.json new file mode 100644 index 000000000000..59a575a79ed0 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceGroupsCatalog.json @@ -0,0 +1,32 @@ +{ + "operationId": "Catalogs_ListDeviceGroups", + "title": "Catalogs_ListDeviceGroups", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "listDeviceGroupsRequest": { + "deviceGroupName": "MyDeviceGroup1" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceInsightsCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceInsightsCatalog.json new file mode 100644 index 000000000000..836f912dca25 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDeviceInsightsCatalog.json @@ -0,0 +1,40 @@ +{ + "operationId": "Catalogs_ListDeviceInsights", + "title": "Catalogs_ListDeviceInsights", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "$top": 10, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "description": "eventDescription1", + "deviceId": "eventIdentifier1", + "startTimestampUtc": "2021-09-30T21:51:39.26Z", + "endTimestampUtc": "2021-09-30T23:54:21.96Z", + "eventCategory": "eventCategory1", + "eventClass": "eventClass1", + "eventType": "eventType1", + "eventCount": 1 + }, + { + "description": "eventDescription2", + "deviceId": "eventIdentifier2", + "startTimestampUtc": "2022-12-06T12:41:39.26Z", + "endTimestampUtc": "2022-12-07T17:34:12.50Z", + "eventCategory": "eventCategory2", + "eventClass": "eventClass2", + "eventType": "eventType2", + "eventCount": 1 + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDevicesByCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDevicesByCatalog.json new file mode 100644 index 000000000000..adfc7215cb82 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostListDevicesByCatalog.json @@ -0,0 +1,27 @@ +{ + "operationId": "Catalogs_ListDevices", + "title": "Catalogs_ListDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {} + }, + { + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveCatalogCertChain.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveCatalogCertChain.json new file mode 100644 index 000000000000..d899e89ea6d6 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveCatalogCertChain.json @@ -0,0 +1,19 @@ +{ + "operationId": "Certificates_RetrieveCertChain", + "title": "Certificates_RetrieveCertChain", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "active", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "certificateChain": "ABynaryRepresentationOfTheRequestedCatalogCertificateChain" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveProofOfPossessionNonce.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveProofOfPossessionNonce.json new file mode 100644 index 000000000000..400c9af86b8a --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostRetrieveProofOfPossessionNonce.json @@ -0,0 +1,22 @@ +{ + "operationId": "Certificates_RetrieveProofOfPossessionNonce", + "title": "Certificates_RetrieveProofOfPossessionNonce", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "active", + "proofOfPossessionNonceRequest": { + "proofOfPossessionNonce": "proofOfPossessionNonce" + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "certificate": "bXliYXNlNjRzdHJpbmc=" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PostUploadImageCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PostUploadImageCatalog.json new file mode 100644 index 000000000000..022a60a12a4f --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PostUploadImageCatalog.json @@ -0,0 +1,23 @@ +{ + "operationId": "Catalogs_UploadImage", + "title": "Catalogs_UploadImage", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "uploadImageRequest": { + "properties": { + "image": "bXliYXNlNjRzdHJpbmc=" + } + } + }, + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutCatalog.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutCatalog.json new file mode 100644 index 000000000000..6fedad40487c --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutCatalog.json @@ -0,0 +1,34 @@ +{ + "operationId": "Catalogs_CreateOrUpdate", + "title": "Catalogs_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "location": "global", + "resource": { + "location": "global" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeployment.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeployment.json new file mode 100644 index 000000000000..ce2abff598ca --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeployment.json @@ -0,0 +1,47 @@ +{ + "operationId": "Deployments_CreateOrUpdate", + "title": "Deployments_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deploymentName": "MyDeployment1", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "MyImage", + "imageId": "00000000-0000-0000-0000-000000000000", + "uri": "imageUri", + "regionalDataBoundary": "None", + "imageType": "InvalidImageType", + "provisioningState": "Succeeded" + } + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups/deployments" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutDevice.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDevice.json new file mode 100644 index 000000000000..7e69ec373bf2 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDevice.json @@ -0,0 +1,34 @@ +{ + "operationId": "Devices_CreateOrUpdate", + "title": "Devices_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": { + "chipSku": "MyChipSku1" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups/devices" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeviceGroup.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeviceGroup.json new file mode 100644 index 000000000000..eaf9e7a53c95 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutDeviceGroup.json @@ -0,0 +1,46 @@ +{ + "operationId": "DeviceGroups_CreateOrUpdate", + "title": "DeviceGroups_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01", + "resource": { + "properties": { + "description": "Description for MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.AzureSphere/catalogs/products/devicegroups", + "properties": { + "description": "Description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1", + "name": "MyDeviceId1", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups", + "properties": { + "description": "Description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutImage.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutImage.json new file mode 100644 index 000000000000..6d26ad07a8ae --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutImage.json @@ -0,0 +1,34 @@ +{ + "operationId": "Images_CreateOrUpdate", + "title": "Image_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": { + "image": "bXliYXNlNjRzdHJpbmc=" + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/default", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/images" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/default", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/images" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/examples/2024-04-01/PutProduct.json b/specification/sphere/Sphere.Management/examples/2024-04-01/PutProduct.json new file mode 100644 index 000000000000..75a53ec45323 --- /dev/null +++ b/specification/sphere/Sphere.Management/examples/2024-04-01/PutProduct.json @@ -0,0 +1,30 @@ +{ + "operationId": "Products_CreateOrUpdate", + "title": "Products_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/products" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs" + } + } + } +} diff --git a/specification/sphere/Sphere.Management/image.tsp b/specification/sphere/Sphere.Management/image.tsp index 5bb6bec02d80..2f82e03f9ac6 100644 --- a/specification/sphere/Sphere.Management/image.tsp +++ b/specification/sphere/Sphere.Management/image.tsp @@ -1,9 +1,11 @@ import "@typespec/rest"; +import "@typespec/openapi"; import "@typespec/versioning"; import "@azure-tools/typespec-azure-core"; import "@azure-tools/typespec-azure-resource-manager"; using TypeSpec.Http; +using TypeSpec.OpenAPI; using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.ResourceManager.Foundations; @@ -16,7 +18,7 @@ namespace Microsoft.AzureSphere; @doc("An image resource belonging to a catalog resource.") @parentResource(Catalog) model Image is ProxyResource { - @doc("Image name. Use .default for image creation.") + @doc("Image name. Use an image GUID for GA versions of the API.") @key("imageName") @path @segment("images") @@ -69,12 +71,6 @@ model ImageProperties { provisioningState?: ProvisioningState; } -@doc("Image upload request body.") -model ImageUploadRequestBody { - @doc(".") - images: string; -} - @doc("Image type values.") enum ImageType { /** Invalid image. */ diff --git a/specification/sphere/Sphere.Management/main.tsp b/specification/sphere/Sphere.Management/main.tsp index 7bd635ad2bb0..b3a4b71fa8b9 100644 --- a/specification/sphere/Sphere.Management/main.tsp +++ b/specification/sphere/Sphere.Management/main.tsp @@ -22,9 +22,20 @@ using Azure.ResourceManager; @armProviderNamespace @service({ title: "AzureSphereProviderClient", - version: "2022-09-01-preview", }) @doc("Azure Sphere resource management API.") -@useDependency(Azure.Core.Versions.v1_0_Preview_1) -@useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) +@versioned(Microsoft.AzureSphere.Versions) namespace Microsoft.AzureSphere; + +@doc("Azure Sphere API versions.") +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("Public preview API version.") + v2022_09_01: "2022-09-01-preview", + + @useDependency(Azure.Core.Versions.v1_0_Preview_1) + @useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) + @doc("Initial GA API version.") + v2024_04_01: "2024-04-01", +} diff --git a/specification/sphere/Sphere.Management/product.tsp b/specification/sphere/Sphere.Management/product.tsp index 09d6c83c9dad..abde83c8564e 100644 --- a/specification/sphere/Sphere.Management/product.tsp +++ b/specification/sphere/Sphere.Management/product.tsp @@ -52,13 +52,27 @@ interface Products extends ProxyResourceOperationsProducts { ...ResourceInstanceParameters, ): ArmResponse> | ErrorResponse; + @doc("Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.") + @removed(Versions.v2024_04_01) @autoRoute + @renamedFrom(Versions.v2024_04_01, "countDevices") + @armResourceAction(Product) + @action("countDevices") + @post + deprecated( + ...ResourceInstanceParameters, + ): ArmResponse | ErrorResponse; + + #suppress "@azure-tools/typespec-providerhub/non-breaking-versioning" "preview api" @doc("Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.") + @added(Versions.v2024_04_01) + @autoRoute + @sharedRoute @armResourceAction(Product) @post countDevices( ...ResourceInstanceParameters, - ): ArmResponse | ErrorResponse; + ): ArmResponse | ErrorResponse; } @doc("The properties of product") diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json index 077b2b100494..4ff7b1b65b24 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json @@ -787,7 +787,7 @@ { "name": "imageName", "in": "path", - "description": "Image name. Use .default for image creation.", + "description": "Image name. Use an image GUID for GA versions of the API.", "required": true, "type": "string" } @@ -839,7 +839,7 @@ { "name": "imageName", "in": "path", - "description": "Image name. Use .default for image creation.", + "description": "Image name. Use an image GUID for GA versions of the API.", "required": true, "type": "string" }, @@ -917,7 +917,7 @@ { "name": "imageName", "in": "path", - "description": "Image name. Use .default for image creation.", + "description": "Image name. Use an image GUID for GA versions of the API.", "required": true, "type": "string" } @@ -3292,6 +3292,15 @@ ] }, "CountDeviceResponse": { + "type": "object", + "description": "Response to the action call for count devices in a catalog (preview API).", + "allOf": [ + { + "$ref": "#/definitions/CountElementsResponse" + } + ] + }, + "CountDevicesResponse": { "type": "object", "description": "Response to the action call for count devices in a catalog.", "allOf": [ @@ -3948,19 +3957,6 @@ ] } }, - "ImageUploadRequestBody": { - "type": "object", - "description": "Image upload request body.", - "properties": { - "images": { - "type": "string", - "description": "." - } - }, - "required": [ - "images" - ] - }, "ListDeviceGroupsRequest": { "type": "object", "description": "Request of the action to list device groups for a catalog.", @@ -4120,7 +4116,7 @@ }, "ProvisioningState": { "type": "string", - "description": "Provisioning state of the resource.", + "description": "Provisioning state of resource.", "enum": [ "Succeeded", "Failed", @@ -4230,6 +4226,30 @@ } ] } + }, + "Versions": { + "type": "string", + "description": "Azure Sphere API versions.", + "enum": [ + "2022-09-01-preview", + "2024-04-01" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2022_09_01", + "value": "2022-09-01-preview", + "description": "Public preview API version." + }, + { + "name": "v2024_04_01", + "value": "2024-04-01", + "description": "Initial GA API version." + } + ] + } } }, "parameters": { diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/DeleteImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/DeleteImage.json index c87670823a95..3f46df5bf8c8 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/DeleteImage.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/DeleteImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "imageID", + "imageName": "00000000-0000-0000-0000-000000000000", "api-version": "2022-09-01-preview" }, "responses": { diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/GetImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/GetImage.json index 3023a79d50c5..ca620f29bb05 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/GetImage.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/GetImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "myImageId", + "imageName": "00000000-0000-0000-0000-000000000000", "api-version": "2022-09-01-preview" }, "responses": { diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/PutImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/PutImage.json index c28ad12e90d3..7034054644d6 100644 --- a/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/PutImage.json +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/preview/2022-09-01-preview/examples/PutImage.json @@ -5,7 +5,7 @@ "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "MyResourceGroup1", "catalogName": "MyCatalog1", - "imageName": "default", + "imageName": ".default", "resource": { "properties": { "image": "bXliYXNlNjRzdHJpbmc=" diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json new file mode 100644 index 000000000000..6f5960517ab1 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json @@ -0,0 +1,4377 @@ +{ + "swagger": "2.0", + "info": { + "title": "AzureSphereProviderClient", + "version": "2024-04-01", + "description": "Azure Sphere resource management API.", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "host": "management.azure.com", + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "Operations" + }, + { + "name": "Catalogs" + }, + { + "name": "Images" + }, + { + "name": "DeviceGroups" + }, + { + "name": "Certificates" + }, + { + "name": "Deployments" + }, + { + "name": "Devices" + }, + { + "name": "Products" + } + ], + "paths": { + "/providers/Microsoft.AzureSphere/operations": { + "get": { + "operationId": "Operations_List", + "tags": [ + "Operations" + ], + "description": "List the operations for the provider", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/GetOperations.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureSphere/catalogs": { + "get": { + "operationId": "Catalogs_ListBySubscription", + "tags": [ + "Catalogs" + ], + "description": "List Catalog resources by subscription ID", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListBySubscription": { + "$ref": "./examples/GetCatalogsSub.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs": { + "get": { + "operationId": "Catalogs_ListByResourceGroup", + "tags": [ + "Catalogs" + ], + "description": "List Catalog resources by resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListByResourceGroup": { + "$ref": "./examples/GetCatalogsRG.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}": { + "get": { + "operationId": "Catalogs_Get", + "tags": [ + "Catalogs" + ], + "description": "Get a Catalog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Get": { + "$ref": "./examples/GetCatalog.json" + } + } + }, + "put": { + "operationId": "Catalogs_CreateOrUpdate", + "tags": [ + "Catalogs" + ], + "description": "Create a Catalog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Catalog" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Catalog' update operation succeeded", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "201": { + "description": "Resource 'Catalog' create operation succeeded", + "schema": { + "$ref": "#/definitions/Catalog" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_CreateOrUpdate": { + "$ref": "./examples/PutCatalog.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Catalogs_Update", + "tags": [ + "Catalogs" + ], + "description": "Update a Catalog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/CatalogUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Update": { + "$ref": "./examples/PatchCatalog.json" + } + } + }, + "delete": { + "operationId": "Catalogs_Delete", + "tags": [ + "Catalogs" + ], + "description": "Delete a Catalog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_Delete": { + "$ref": "./examples/DeleteCatalog.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates": { + "get": { + "operationId": "Certificates_ListByCatalog", + "tags": [ + "Certificates" + ], + "description": "List Certificate resources by Catalog", + "parameters": [ + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_ListByCatalog": { + "$ref": "./examples/GetCertificates.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}": { + "get": { + "operationId": "Certificates_Get", + "tags": [ + "Certificates" + ], + "description": "Get a Certificate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "serialNumber", + "in": "path", + "description": "Serial number of the certificate. Use '.default' to get current active certificate.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Certificate" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_Get": { + "$ref": "./examples/GetCertificate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveCertChain": { + "post": { + "operationId": "Certificates_RetrieveCertChain", + "tags": [ + "Certificates" + ], + "description": "Retrieves cert chain.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "serialNumber", + "in": "path", + "description": "Serial number of the certificate. Use '.default' to get current active certificate.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CertificateChainResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_RetrieveCertChain": { + "$ref": "./examples/PostRetrieveCatalogCertChain.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveProofOfPossessionNonce": { + "post": { + "operationId": "Certificates_RetrieveProofOfPossessionNonce", + "tags": [ + "Certificates" + ], + "description": "Gets the proof of possession nonce.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "serialNumber", + "in": "path", + "description": "Serial number of the certificate. Use '.default' to get current active certificate.", + "required": true, + "type": "string" + }, + { + "name": "proofOfPossessionNonceRequest", + "in": "body", + "description": "Proof of possession nonce request body ", + "required": true, + "schema": { + "$ref": "#/definitions/ProofOfPossessionNonceRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProofOfPossessionNonceResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Certificates_RetrieveProofOfPossessionNonce": { + "$ref": "./examples/PostRetrieveProofOfPossessionNonce.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/countDevices": { + "post": { + "operationId": "Catalogs_CountDevices", + "tags": [ + "Catalogs" + ], + "description": "Counts devices in catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CountDevicesResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_CountDevices": { + "$ref": "./examples/PostCountDevicesCatalog.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images": { + "get": { + "operationId": "Images_ListByCatalog", + "tags": [ + "Images" + ], + "description": "List Image resources by Catalog", + "parameters": [ + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_ListByCatalog": { + "$ref": "./examples/GetImages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images/{imageName}": { + "get": { + "operationId": "Images_Get", + "tags": [ + "Images" + ], + "description": "Get a Image", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "imageName", + "in": "path", + "description": "Image name. Use an image GUID for GA versions of the API.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_Get": { + "$ref": "./examples/GetImage.json" + } + } + }, + "put": { + "operationId": "Images_CreateOrUpdate", + "tags": [ + "Images" + ], + "description": "Create a Image", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "imageName", + "in": "path", + "description": "Image name. Use an image GUID for GA versions of the API.", + "required": true, + "type": "string" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Image' update operation succeeded", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Resource 'Image' create operation succeeded", + "schema": { + "$ref": "#/definitions/Image" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Image_CreateOrUpdate": { + "$ref": "./examples/PutImage.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Images_Delete", + "tags": [ + "Images" + ], + "description": "Delete a Image", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "imageName", + "in": "path", + "description": "Image name. Use an image GUID for GA versions of the API.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Images_Delete": { + "$ref": "./examples/DeleteImage.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeployments": { + "post": { + "operationId": "Catalogs_ListDeployments", + "tags": [ + "Catalogs" + ], + "description": "Lists deployments for catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListDeployments": { + "$ref": "./examples/PostListDeploymentsByCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups": { + "post": { + "operationId": "Catalogs_ListDeviceGroups", + "tags": [ + "Catalogs" + ], + "description": "List the device groups for the catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "name": "listDeviceGroupsRequest", + "in": "body", + "description": "List device groups for catalog.", + "required": true, + "schema": { + "$ref": "#/definitions/ListDeviceGroupsRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListDeviceGroups": { + "$ref": "./examples/PostListDeviceGroupsCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceInsights": { + "post": { + "operationId": "Catalogs_ListDeviceInsights", + "tags": [ + "Catalogs" + ], + "description": "Lists device insights for catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/PagedDeviceInsight" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListDeviceInsights": { + "$ref": "./examples/PostListDeviceInsightsCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDevices": { + "post": { + "operationId": "Catalogs_ListDevices", + "tags": [ + "Catalogs" + ], + "description": "Lists devices for catalog.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_ListDevices": { + "$ref": "./examples/PostListDevicesByCatalog.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products": { + "get": { + "operationId": "Products_ListByCatalog", + "tags": [ + "Products" + ], + "description": "List Product resources by Catalog", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/ProductListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_ListByCatalog": { + "$ref": "./examples/GetProducts.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}": { + "get": { + "operationId": "Products_Get", + "tags": [ + "Products" + ], + "description": "Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_Get": { + "$ref": "./examples/GetProduct.json" + } + } + }, + "put": { + "operationId": "Products_CreateOrUpdate", + "tags": [ + "Products" + ], + "description": "Create a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Product" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Product' update operation succeeded", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "201": { + "description": "Resource 'Product' create operation succeeded", + "schema": { + "$ref": "#/definitions/Product" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_CreateOrUpdate": { + "$ref": "./examples/PutProduct.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Products_Update", + "tags": [ + "Products" + ], + "description": "Update a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/ProductUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_Update": { + "$ref": "./examples/PatchProduct.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Products_Delete", + "tags": [ + "Products" + ], + "description": "Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_Delete": { + "$ref": "./examples/DeleteProduct.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/countDevices": { + "post": { + "operationId": "Products_CountDevices", + "tags": [ + "Products" + ], + "description": "Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CountDevicesResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_CountDevices": { + "$ref": "./examples/PostCountDevicesProduct.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups": { + "get": { + "operationId": "DeviceGroups_ListByProduct", + "tags": [ + "DeviceGroups" + ], + "description": "List DeviceGroup resources by Product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_ListByProduct": { + "$ref": "./examples/GetDeviceGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}": { + "get": { + "operationId": "DeviceGroups_Get", + "tags": [ + "DeviceGroups" + ], + "description": "Get a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroup" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_Get": { + "$ref": "./examples/GetDeviceGroup.json" + } + } + }, + "put": { + "operationId": "DeviceGroups_CreateOrUpdate", + "tags": [ + "DeviceGroups" + ], + "description": "Create a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceGroup" + } + } + ], + "responses": { + "200": { + "description": "Resource 'DeviceGroup' update operation succeeded", + "schema": { + "$ref": "#/definitions/DeviceGroup" + } + }, + "201": { + "description": "Resource 'DeviceGroup' create operation succeeded", + "schema": { + "$ref": "#/definitions/DeviceGroup" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_CreateOrUpdate": { + "$ref": "./examples/PutDeviceGroup.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "DeviceGroups_Update", + "tags": [ + "DeviceGroups" + ], + "description": "Update a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceGroupUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroup" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_Update": { + "$ref": "./examples/PatchDeviceGroup.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "DeviceGroups_Delete", + "tags": [ + "DeviceGroups" + ], + "description": "Delete a DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_Delete": { + "$ref": "./examples/DeleteDeviceGroup.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/claimDevices": { + "post": { + "operationId": "DeviceGroups_ClaimDevices", + "tags": [ + "DeviceGroups" + ], + "description": "Bulk claims the devices. Use '.unassigned' or '.default' for the device group and product names when bulk claiming devices to a catalog only.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "claimDevicesRequest", + "in": "body", + "description": "Bulk claim devices request body.", + "required": true, + "schema": { + "$ref": "#/definitions/ClaimDevicesRequest" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_ClaimDevices": { + "$ref": "./examples/PostClaimDevices.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/countDevices": { + "post": { + "operationId": "DeviceGroups_CountDevices", + "tags": [ + "DeviceGroups" + ], + "description": "Counts devices in device group. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/CountDevicesResponse" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "DeviceGroups_CountDevices": { + "$ref": "./examples/PostCountDevicesDeviceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments": { + "get": { + "operationId": "Deployments_ListByDeviceGroup", + "tags": [ + "Deployments" + ], + "description": "List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "#/parameters/CustomFilterQueryParameter" + }, + { + "$ref": "#/parameters/CustomTopQueryParameter" + }, + { + "$ref": "#/parameters/CustomSkipQueryParameter" + }, + { + "$ref": "#/parameters/CustomMaxPageSizeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_ListByDeviceGroup": { + "$ref": "./examples/GetDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/deployments/{deploymentName}": { + "get": { + "operationId": "Deployments_Get", + "tags": [ + "Deployments" + ], + "description": "Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Get": { + "$ref": "./examples/GetDeployment.json" + } + } + }, + "put": { + "operationId": "Deployments_CreateOrUpdate", + "tags": [ + "Deployments" + ], + "description": "Create a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.", + "required": true, + "type": "string" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Deployment' update operation succeeded", + "schema": { + "$ref": "#/definitions/Deployment" + } + }, + "201": { + "description": "Resource 'Deployment' create operation succeeded", + "schema": { + "$ref": "#/definitions/Deployment" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_CreateOrUpdate": { + "$ref": "./examples/PutDeployment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Deployments_Delete", + "tags": [ + "Deployments" + ], + "description": "Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deploymentName", + "in": "path", + "description": "Deployment name. Use .default for deployment creation and to get the current deployment for the associated device group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deployments_Delete": { + "$ref": "./examples/DeleteDeployment.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices": { + "get": { + "operationId": "Devices_ListByDeviceGroup", + "tags": [ + "Devices" + ], + "description": "List Device resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_ListByDeviceGroup": { + "$ref": "./examples/GetDevices.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}": { + "get": { + "operationId": "Devices_Get", + "tags": [ + "Devices" + ], + "description": "Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_Get": { + "$ref": "./examples/GetDevice.json" + } + } + }, + "put": { + "operationId": "Devices_CreateOrUpdate", + "tags": [ + "Devices" + ], + "description": "Create a Device. Use '.unassigned' or '.default' for the device group and product names to claim a device to the catalog only.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + }, + { + "name": "resource", + "in": "body", + "description": "Resource create parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/Device" + } + } + ], + "responses": { + "200": { + "description": "Resource 'Device' update operation succeeded", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "201": { + "description": "Resource 'Device' create operation succeeded", + "schema": { + "$ref": "#/definitions/Device" + }, + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_CreateOrUpdate": { + "$ref": "./examples/PutDevice.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "Devices_Update", + "tags": [ + "Devices" + ], + "description": "Update a Device. Use '.unassigned' or '.default' for the device group and product names to move a device to the catalog level.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + }, + { + "name": "properties", + "in": "body", + "description": "The resource properties to be updated.", + "required": true, + "schema": { + "$ref": "#/definitions/DeviceUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Device" + } + }, + "202": { + "description": "Resource update request accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_Update": { + "$ref": "./examples/PatchDevice.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + }, + "delete": { + "operationId": "Devices_Delete", + "tags": [ + "Devices" + ], + "description": "Delete a Device", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_Delete": { + "$ref": "./examples/DeleteDevice.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/deviceGroups/{deviceGroupName}/devices/{deviceName}/generateCapabilityImage": { + "post": { + "operationId": "Devices_GenerateCapabilityImage", + "tags": [ + "Devices" + ], + "description": "Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceGroupName", + "in": "path", + "description": "Name of device group.", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]{1,2}$|^[A-Za-z0-9][A-Za-z0-9\\s]{1,48}[A-Za-z0-9]$|^\\.default$|^\\.unassigned$" + }, + { + "name": "deviceName", + "in": "path", + "description": "Device name", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9-]{128}$" + }, + { + "name": "generateDeviceCapabilityRequest", + "in": "body", + "description": "Generate capability image request body.", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateCapabilityImageRequest" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/SignedCapabilityImageResponse" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Devices_GenerateCapabilityImage": { + "$ref": "./examples/PostGenerateDeviceCapabilityImage.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/products/{productName}/generateDefaultDeviceGroups": { + "post": { + "operationId": "Products_GenerateDefaultDeviceGroups", + "tags": [ + "Products" + ], + "description": "Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "productName", + "in": "path", + "description": "Name of product.", + "required": true, + "type": "string", + "pattern": "^[\\w][\\w\\s]{1,48}[\\w]$|^\\.default$|^\\.unassigned$" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/DeviceGroupListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Products_GenerateDefaultDeviceGroups": { + "$ref": "./examples/PostGenerateDefaultDeviceGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/uploadImage": { + "post": { + "operationId": "Catalogs_UploadImage", + "tags": [ + "Catalogs" + ], + "description": "Creates an image. Use this action when the image ID is unknown.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "catalogName", + "in": "path", + "description": "Name of catalog", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9_-]{1,50}$" + }, + { + "name": "uploadImageRequest", + "in": "body", + "description": "Image upload request body.", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + } + } + ], + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Retry-After": { + "type": "integer", + "format": "int32", + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status." + }, + "Location": { + "type": "string", + "description": "The Location header contains the URL where the status of the long running operation can be checked." + } + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Catalogs_UploadImage": { + "$ref": "./examples/PostUploadImageCatalog.json" + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AllowCrashDumpCollection": { + "type": "string", + "description": "Allow crash dumps values.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "AllowCrashDumpCollection", + "modelAsString": true, + "values": [ + { + "name": "Enabled", + "value": "Enabled", + "description": "Crash dump collection enabled" + }, + { + "name": "Disabled", + "value": "Disabled", + "description": "Crash dump collection disabled" + } + ] + } + }, + "CapabilityType": { + "type": "string", + "description": "Capability image type", + "enum": [ + "ApplicationDevelopment", + "FieldServicing" + ], + "x-ms-enum": { + "name": "CapabilityType", + "modelAsString": true, + "values": [ + { + "name": "ApplicationDevelopment", + "value": "ApplicationDevelopment", + "description": "Application development capability" + }, + { + "name": "FieldServicing", + "value": "FieldServicing", + "description": "Field servicing capability" + } + ] + } + }, + "Catalog": { + "type": "object", + "description": "An Azure Sphere catalog", + "properties": { + "properties": { + "$ref": "#/definitions/CatalogProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "CatalogListResult": { + "type": "object", + "description": "The response of a Catalog list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Catalog items on this page", + "items": { + "$ref": "#/definitions/Catalog" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CatalogProperties": { + "type": "object", + "description": "Catalog properties", + "properties": { + "tenantId": { + "type": "string", + "description": "The Azure Sphere tenant ID associated with the catalog.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CatalogUpdate": { + "type": "object", + "description": "The type used for update operations of the Catalog.", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Certificate": { + "type": "object", + "description": "An certificate resource belonging to a catalog resource.", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "CertificateChainResponse": { + "type": "object", + "description": "The certificate chain response.", + "properties": { + "certificateChain": { + "type": "string", + "description": "The certificate chain.", + "readOnly": true + } + } + }, + "CertificateListResult": { + "type": "object", + "description": "The response of a Certificate list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Certificate items on this page", + "items": { + "$ref": "#/definitions/Certificate" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "CertificateProperties": { + "type": "object", + "description": "The properties of certificate", + "properties": { + "certificate": { + "type": "string", + "description": "The certificate as a UTF-8 encoded base 64 string.", + "readOnly": true + }, + "status": { + "$ref": "#/definitions/CertificateStatus", + "description": "The certificate status.", + "readOnly": true + }, + "subject": { + "type": "string", + "description": "The certificate subject.", + "readOnly": true + }, + "thumbprint": { + "type": "string", + "description": "The certificate thumbprint.", + "readOnly": true + }, + "expiryUtc": { + "type": "string", + "format": "date-time", + "description": "The certificate expiry date.", + "readOnly": true + }, + "notBeforeUtc": { + "type": "string", + "format": "date-time", + "description": "The certificate not before date.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "CertificateStatus": { + "type": "string", + "description": "Certificate status values.", + "enum": [ + "Active", + "Inactive", + "Expired", + "Revoked" + ], + "x-ms-enum": { + "name": "CertificateStatus", + "modelAsString": true, + "values": [ + { + "name": "Active", + "value": "Active", + "description": "Certificate is active" + }, + { + "name": "Inactive", + "value": "Inactive", + "description": "Certificate is inactive" + }, + { + "name": "Expired", + "value": "Expired", + "description": "Certificate has expired" + }, + { + "name": "Revoked", + "value": "Revoked", + "description": "Certificate has been revoked" + } + ] + } + }, + "ClaimDevicesRequest": { + "type": "object", + "description": "Request to the action call to bulk claim devices.", + "properties": { + "deviceIdentifiers": { + "type": "array", + "description": "Device identifiers of the devices to be claimed.", + "items": { + "type": "string" + } + } + }, + "required": [ + "deviceIdentifiers" + ] + }, + "CountDeviceResponse": { + "type": "object", + "description": "Response to the action call for count devices in a catalog (preview API).", + "allOf": [ + { + "$ref": "#/definitions/CountElementsResponse" + } + ] + }, + "CountDevicesResponse": { + "type": "object", + "description": "Response to the action call for count devices in a catalog.", + "allOf": [ + { + "$ref": "#/definitions/CountElementsResponse" + } + ] + }, + "CountElementsResponse": { + "type": "object", + "description": "Response of the count for elements.", + "properties": { + "value": { + "type": "integer", + "format": "int32", + "description": "Number of children resources in parent resource." + } + }, + "required": [ + "value" + ] + }, + "Deployment": { + "type": "object", + "description": "An deployment resource belonging to a device group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeploymentListResult": { + "type": "object", + "description": "The response of a Deployment list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Deployment items on this page", + "items": { + "$ref": "#/definitions/Deployment" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DeploymentProperties": { + "type": "object", + "description": "The properties of deployment", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "deployedImages": { + "type": "array", + "description": "Images deployed", + "items": { + "$ref": "#/definitions/Image" + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "deploymentDateUtc": { + "type": "string", + "format": "date-time", + "description": "Deployment date UTC", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "Device": { + "type": "object", + "description": "An device resource belonging to a device group resource.", + "properties": { + "properties": { + "$ref": "#/definitions/DeviceProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeviceGroup": { + "type": "object", + "description": "An device group resource belonging to a product resource.", + "properties": { + "properties": { + "$ref": "#/definitions/DeviceGroupProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "DeviceGroupListResult": { + "type": "object", + "description": "The response of a DeviceGroup list operation.", + "properties": { + "value": { + "type": "array", + "description": "The DeviceGroup items on this page", + "items": { + "$ref": "#/definitions/DeviceGroup" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DeviceGroupProperties": { + "type": "object", + "description": "The properties of deviceGroup", + "properties": { + "description": { + "type": "string", + "description": "Description of the device group." + }, + "osFeedType": { + "$ref": "#/definitions/OSFeedType", + "description": "Operating system feed type of the device group." + }, + "updatePolicy": { + "$ref": "#/definitions/UpdatePolicy", + "description": "Update policy of the device group." + }, + "allowCrashDumpsCollection": { + "$ref": "#/definitions/AllowCrashDumpCollection", + "description": "Flag to define if the user allows for crash dump collection." + }, + "regionalDataBoundary": { + "$ref": "#/definitions/RegionalDataBoundary", + "description": "Regional data boundary for the device group." + }, + "hasDeployment": { + "type": "boolean", + "description": "Deployment status for the device group.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DeviceGroupUpdate": { + "type": "object", + "description": "The type used for update operations of the DeviceGroup.", + "properties": { + "properties": { + "$ref": "#/definitions/DeviceGroupUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "DeviceGroupUpdateProperties": { + "type": "object", + "description": "The updatable properties of the DeviceGroup.", + "properties": { + "description": { + "type": "string", + "description": "Description of the device group." + }, + "osFeedType": { + "$ref": "#/definitions/OSFeedType", + "description": "Operating system feed type of the device group." + }, + "updatePolicy": { + "$ref": "#/definitions/UpdatePolicy", + "description": "Update policy of the device group." + }, + "allowCrashDumpsCollection": { + "$ref": "#/definitions/AllowCrashDumpCollection", + "description": "Flag to define if the user allows for crash dump collection." + }, + "regionalDataBoundary": { + "$ref": "#/definitions/RegionalDataBoundary", + "description": "Regional data boundary for the device group." + } + } + }, + "DeviceInsight": { + "type": "object", + "description": "Device insight report.", + "properties": { + "deviceId": { + "type": "string", + "description": "Device ID" + }, + "description": { + "type": "string", + "description": "Event description" + }, + "startTimestampUtc": { + "type": "string", + "format": "date-time", + "description": "Event start timestamp" + }, + "endTimestampUtc": { + "type": "string", + "format": "date-time", + "description": "Event end timestamp" + }, + "eventCategory": { + "type": "string", + "description": "Event category" + }, + "eventClass": { + "type": "string", + "description": "Event class" + }, + "eventType": { + "type": "string", + "description": "Event type" + }, + "eventCount": { + "type": "integer", + "format": "int32", + "description": "Event count" + } + }, + "required": [ + "deviceId", + "description", + "startTimestampUtc", + "endTimestampUtc", + "eventCategory", + "eventClass", + "eventType", + "eventCount" + ] + }, + "DeviceListResult": { + "type": "object", + "description": "The response of a Device list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Device items on this page", + "items": { + "$ref": "#/definitions/Device" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "DevicePatchProperties": { + "type": "object", + "description": "The properties of device patch", + "properties": { + "deviceGroupId": { + "type": "string", + "description": "Device group id" + } + }, + "required": [ + "deviceGroupId" + ] + }, + "DeviceProperties": { + "type": "object", + "description": "The properties of device", + "properties": { + "deviceId": { + "type": "string", + "description": "Device ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "chipSku": { + "type": "string", + "description": "SKU of the chip", + "readOnly": true + }, + "lastAvailableOsVersion": { + "type": "string", + "description": "OS version available for installation when update requested", + "readOnly": true + }, + "lastInstalledOsVersion": { + "type": "string", + "description": "OS version running on device when update requested", + "readOnly": true + }, + "lastOsUpdateUtc": { + "type": "string", + "format": "date-time", + "description": "Time when update requested and new OS version available", + "readOnly": true + }, + "lastUpdateRequestUtc": { + "type": "string", + "format": "date-time", + "description": "Time when update was last requested", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "DeviceUpdate": { + "type": "object", + "description": "The type used for update operations of the Device.", + "properties": { + "properties": { + "$ref": "#/definitions/DeviceUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "DeviceUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Device.", + "properties": { + "deviceGroupId": { + "type": "string", + "description": "Device group id" + } + } + }, + "GenerateCapabilityImageRequest": { + "type": "object", + "description": "Request of the action to create a signed device capability image", + "properties": { + "capabilities": { + "type": "array", + "description": "List of capabilities to create", + "items": { + "$ref": "#/definitions/CapabilityType" + } + } + }, + "required": [ + "capabilities" + ] + }, + "Image": { + "type": "object", + "description": "An image resource belonging to a catalog resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ImageProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ImageListResult": { + "type": "object", + "description": "The response of a Image list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Image items on this page", + "items": { + "$ref": "#/definitions/Image" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ImageProperties": { + "type": "object", + "description": "The properties of image", + "properties": { + "image": { + "type": "string", + "description": "Image as a UTF-8 encoded base 64 string on image create. This field contains the image URI on image reads.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "imageId": { + "type": "string", + "description": "Image ID", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "imageName": { + "type": "string", + "description": "Image name", + "readOnly": true + }, + "regionalDataBoundary": { + "$ref": "#/definitions/RegionalDataBoundary", + "description": "Regional data boundary for an image", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "uri": { + "type": "string", + "description": "Location the image", + "readOnly": true + }, + "description": { + "type": "string", + "description": "The image description.", + "readOnly": true + }, + "componentId": { + "type": "string", + "description": "The image component id.", + "readOnly": true + }, + "imageType": { + "$ref": "#/definitions/ImageType", + "description": "The image type.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + } + }, + "ImageType": { + "type": "string", + "description": "Image type values.", + "enum": [ + "InvalidImageType", + "OneBl", + "PlutonRuntime", + "WifiFirmware", + "SecurityMonitor", + "NormalWorldLoader", + "NormalWorldDtb", + "NormalWorldKernel", + "RootFs", + "Services", + "Applications", + "FwConfig", + "BootManifest", + "Nwfs", + "TrustedKeystore", + "Policy", + "CustomerBoardConfig", + "UpdateCertStore", + "BaseSystemUpdateManifest", + "FirmwareUpdateManifest", + "CustomerUpdateManifest", + "RecoveryManifest", + "ManifestSet", + "Other" + ], + "x-ms-enum": { + "name": "ImageType", + "modelAsString": true, + "values": [ + { + "name": "InvalidImageType", + "value": "InvalidImageType", + "description": "Invalid image." + }, + { + "name": "OneBl", + "value": "OneBl", + "description": "One Bl image type" + }, + { + "name": "PlutonRuntime", + "value": "PlutonRuntime", + "description": "Pluton image type" + }, + { + "name": "WifiFirmware", + "value": "WifiFirmware", + "description": "Wifi firmware image type" + }, + { + "name": "SecurityMonitor", + "value": "SecurityMonitor", + "description": "Security monitor image type" + }, + { + "name": "NormalWorldLoader", + "value": "NormalWorldLoader", + "description": "Normal world loader image type" + }, + { + "name": "NormalWorldDtb", + "value": "NormalWorldDtb", + "description": "Normal world dtb image type" + }, + { + "name": "NormalWorldKernel", + "value": "NormalWorldKernel", + "description": "Normal world kernel image type" + }, + { + "name": "RootFs", + "value": "RootFs", + "description": "Root FS image type" + }, + { + "name": "Services", + "value": "Services", + "description": "Services image type" + }, + { + "name": "Applications", + "value": "Applications", + "description": "Applications image type" + }, + { + "name": "FwConfig", + "value": "FwConfig", + "description": "FW config image type" + }, + { + "name": "BootManifest", + "value": "BootManifest", + "description": "Boot manifest image type" + }, + { + "name": "Nwfs", + "value": "Nwfs", + "description": "Nwfs image type" + }, + { + "name": "TrustedKeystore", + "value": "TrustedKeystore", + "description": "Trusted key store image type" + }, + { + "name": "Policy", + "value": "Policy", + "description": "Policy image type" + }, + { + "name": "CustomerBoardConfig", + "value": "CustomerBoardConfig", + "description": "Customer board config image type" + }, + { + "name": "UpdateCertStore", + "value": "UpdateCertStore", + "description": "Update certificate store image type" + }, + { + "name": "BaseSystemUpdateManifest", + "value": "BaseSystemUpdateManifest", + "description": "Base system update manifest image type" + }, + { + "name": "FirmwareUpdateManifest", + "value": "FirmwareUpdateManifest", + "description": "Firmware update manifest image type" + }, + { + "name": "CustomerUpdateManifest", + "value": "CustomerUpdateManifest", + "description": "Customer update manifest image type" + }, + { + "name": "RecoveryManifest", + "value": "RecoveryManifest", + "description": "Recovery manifest image type" + }, + { + "name": "ManifestSet", + "value": "ManifestSet", + "description": "manifest set image type" + }, + { + "name": "Other", + "value": "Other", + "description": "Other image type" + } + ] + } + }, + "ListDeviceGroupsRequest": { + "type": "object", + "description": "Request of the action to list device groups for a catalog.", + "properties": { + "deviceGroupName": { + "type": "string", + "description": "Device Group name." + } + } + }, + "OSFeedType": { + "type": "string", + "description": "OS feed type values.", + "enum": [ + "Retail", + "RetailEval" + ], + "x-ms-enum": { + "name": "OSFeedType", + "modelAsString": true, + "values": [ + { + "name": "Retail", + "value": "Retail", + "description": "Retail OS feed type." + }, + { + "name": "RetailEval", + "value": "RetailEval", + "description": "Retail evaluation OS feed type." + } + ] + } + }, + "PagedDeviceInsight": { + "type": "object", + "description": "Paged collection of DeviceInsight items", + "properties": { + "value": { + "type": "array", + "description": "The DeviceInsight items on this page", + "items": { + "$ref": "#/definitions/DeviceInsight" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "Product": { + "type": "object", + "description": "An product resource belonging to a catalog resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ProductProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ] + }, + "ProductListResult": { + "type": "object", + "description": "The response of a Product list operation.", + "properties": { + "value": { + "type": "array", + "description": "The Product items on this page", + "items": { + "$ref": "#/definitions/Product" + } + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items" + } + }, + "required": [ + "value" + ] + }, + "ProductProperties": { + "type": "object", + "description": "The properties of product", + "properties": { + "description": { + "type": "string", + "description": "Description of the product" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "required": [ + "description" + ] + }, + "ProductUpdate": { + "type": "object", + "description": "The type used for update operations of the Product.", + "properties": { + "properties": { + "$ref": "#/definitions/ProductUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "ProductUpdateProperties": { + "type": "object", + "description": "The updatable properties of the Product.", + "properties": { + "description": { + "type": "string", + "description": "Description of the product" + } + } + }, + "ProofOfPossessionNonceRequest": { + "type": "object", + "description": "Request for the proof of possession nonce", + "properties": { + "proofOfPossessionNonce": { + "type": "string", + "description": "The proof of possession nonce" + } + }, + "required": [ + "proofOfPossessionNonce" + ] + }, + "ProofOfPossessionNonceResponse": { + "type": "object", + "description": "Result of the action to generate a proof of possession nonce", + "allOf": [ + { + "$ref": "#/definitions/CertificateProperties" + } + ] + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of resource.", + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Provisioning", + "Updating", + "Deleting", + "Accepted" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "name": "Succeeded", + "value": "Succeeded", + "description": "Resource has been created." + }, + { + "name": "Failed", + "value": "Failed", + "description": "Resource creation failed." + }, + { + "name": "Canceled", + "value": "Canceled", + "description": "Resource creation was canceled." + }, + { + "name": "Provisioning", + "value": "Provisioning", + "description": "The resource is being provisioned" + }, + { + "name": "Updating", + "value": "Updating", + "description": "The resource is being updated" + }, + { + "name": "Deleting", + "value": "Deleting", + "description": "The resource is being deleted" + }, + { + "name": "Accepted", + "value": "Accepted", + "description": "The resource create request has been accepted" + } + ] + } + }, + "RegionalDataBoundary": { + "type": "string", + "description": "Regional data boundary values.", + "enum": [ + "None", + "EU" + ], + "x-ms-enum": { + "name": "RegionalDataBoundary", + "modelAsString": true, + "values": [ + { + "name": "None", + "value": "None", + "description": "No data boundary" + }, + { + "name": "EU", + "value": "EU", + "description": "EU data boundary" + } + ] + } + }, + "SignedCapabilityImageResponse": { + "type": "object", + "description": "Signed device capability image response", + "properties": { + "image": { + "type": "string", + "description": "The signed device capability image as a UTF-8 encoded base 64 string.", + "readOnly": true + } + } + }, + "UpdatePolicy": { + "type": "string", + "description": "Update policy values.", + "enum": [ + "UpdateAll", + "No3rdPartyAppUpdates" + ], + "x-ms-enum": { + "name": "UpdatePolicy", + "modelAsString": true, + "values": [ + { + "name": "UpdateAll", + "value": "UpdateAll", + "description": "Update all policy." + }, + { + "name": "No3rdPartyAppUpdates", + "value": "No3rdPartyAppUpdates", + "description": "No update for 3rd party app policy." + } + ] + } + }, + "Versions": { + "type": "string", + "description": "Azure Sphere API versions.", + "enum": [ + "2022-09-01-preview", + "2024-04-01" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2022_09_01", + "value": "2022-09-01-preview", + "description": "Public preview API version." + }, + { + "name": "v2024_04_01", + "value": "2024-04-01", + "description": "Initial GA API version." + } + ] + } + } + }, + "parameters": { + "CustomFilterQueryParameter": { + "name": "$filter", + "in": "query", + "description": "Filter the result list using the given expression", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-client-name": "filter" + }, + "CustomMaxPageSizeQueryParameter": { + "name": "$maxpagesize", + "in": "query", + "description": "The maximum number of result items per page.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method", + "x-ms-client-name": "maxpagesize" + }, + "CustomSkipQueryParameter": { + "name": "$skip", + "in": "query", + "description": "The number of result items to skip.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method", + "x-ms-client-name": "skip" + }, + "CustomTopQueryParameter": { + "name": "$top", + "in": "query", + "description": "The number of result items to return.", + "required": false, + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method", + "x-ms-client-name": "top" + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteCatalog.json new file mode 100644 index 000000000000..658bc7b9990c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteCatalog.json @@ -0,0 +1,24 @@ +{ + "operationId": "Catalogs_Delete", + "title": "Catalogs_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeployment.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeployment.json new file mode 100644 index 000000000000..6a3411f17082 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeployment.json @@ -0,0 +1,27 @@ +{ + "operationId": "Deployments_Delete", + "title": "Deployments_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "deviceGroupName": "DeviceGroupName1", + "deploymentName": "MyDeploymentName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDevice.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDevice.json new file mode 100644 index 000000000000..057b4d7b71c7 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDevice.json @@ -0,0 +1,27 @@ +{ + "operationId": "Devices_Delete", + "title": "Devices_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "deviceGroupName": "DeviceGroupName1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeviceGroup.json new file mode 100644 index 000000000000..41eab5c0492c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteDeviceGroup.json @@ -0,0 +1,26 @@ +{ + "operationId": "DeviceGroups_Delete", + "title": "DeviceGroups_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteImage.json new file mode 100644 index 000000000000..45b70048d57b --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteImage.json @@ -0,0 +1,25 @@ +{ + "operationId": "Images_Delete", + "title": "Images_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteProduct.json new file mode 100644 index 000000000000..0f5433be7216 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/DeleteProduct.json @@ -0,0 +1,25 @@ +{ + "operationId": "Products_Delete", + "title": "Products_Delete", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProductName1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + }, + "204": { + "description": "Resource deleted successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalog.json new file mode 100644 index 000000000000..87771799dffc --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalog.json @@ -0,0 +1,21 @@ +{ + "operationId": "Catalogs_Get", + "title": "Catalogs_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsRG.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsRG.json new file mode 100644 index 000000000000..488c94bc3c23 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsRG.json @@ -0,0 +1,30 @@ +{ + "operationId": "Catalogs_ListByResourceGroup", + "title": "Catalogs_ListByResourceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog2", + "name": "MyCatalog2", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsSub.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsSub.json new file mode 100644 index 000000000000..d715ad91a2ef --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCatalogsSub.json @@ -0,0 +1,29 @@ +{ + "operationId": "Catalogs_ListBySubscription", + "title": "Catalogs_ListBySubscription", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup2/providers/Microsoft.AzureSphere/catalogs/MyCatalog2", + "name": "MyCatalog2", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificate.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificate.json new file mode 100644 index 000000000000..a8c64f3db445 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificate.json @@ -0,0 +1,17 @@ +{ + "operationId": "Certificates_Get", + "title": "Certificates_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "default", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": {} + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificates.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificates.json new file mode 100644 index 000000000000..9c3fd6281498 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetCertificates.json @@ -0,0 +1,18 @@ +{ + "operationId": "Certificates_ListByCatalog", + "title": "Certificates_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployment.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployment.json new file mode 100644 index 000000000000..fc9af844c81f --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployment.json @@ -0,0 +1,38 @@ +{ + "operationId": "Deployments_Get", + "title": "Deployments_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deploymentName": "MyDeployment1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "dGVzdGltYWdl", + "regionalDataBoundary": "None", + "uri": "imageUri", + "description": "description", + "componentId": "componentId", + "imageType": "ImageType", + "provisioningState": "Succeeded" + } + } + ] + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.json new file mode 100644 index 000000000000..eef2ff5d1ac8 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeployments.json @@ -0,0 +1,42 @@ +{ + "operationId": "Deployments_ListByDeviceGroup", + "title": "Deployments_ListByDeviceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "dGVzdGltYWdl", + "regionalDataBoundary": "None", + "uri": "imageUri", + "description": "description", + "componentId": "componentId", + "imageType": "ImageType", + "provisioningState": "Succeeded" + } + } + ], + "deploymentDateUtc": "2022-09-30T21:51:39.2698729Z" + } + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevice.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevice.json new file mode 100644 index 000000000000..858ee313939f --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevice.json @@ -0,0 +1,29 @@ +{ + "operationId": "Devices_Get", + "title": "Devices_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": { + "chipSku": "MyChipSku1", + "lastAvailableOsVersion": "AvailableOsVersion1", + "lastInstalledOsVersion": "InstalledOsVersion1", + "lastOsUpdateUtc": "2022-09-30T23:54:21.96Z", + "lastUpdateRequestUtc": "2022-10-01T23:54:21.96Z" + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroup.json new file mode 100644 index 000000000000..1e8379ab7772 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroup.json @@ -0,0 +1,26 @@ +{ + "operationId": "DeviceGroups_Get", + "title": "DeviceGroups_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups", + "properties": { + "description": "The description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.json new file mode 100644 index 000000000000..46123e6f6d98 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDeviceGroups.json @@ -0,0 +1,30 @@ +{ + "operationId": "DeviceGroups_ListByProduct", + "title": "DeviceGroups_ListByProduct", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/Products/MyProduct2/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevices.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevices.json new file mode 100644 index 000000000000..c011cde1148a --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetDevices.json @@ -0,0 +1,29 @@ +{ + "operationId": "Devices_ListByDeviceGroup", + "title": "Devices_ListByDeviceGroup", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000-0000-0000-0000-000000000001", + "properties": {} + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000-0000-0000-0000-000000000002", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImage.json new file mode 100644 index 000000000000..8943a1fcf403 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImage.json @@ -0,0 +1,17 @@ +{ + "operationId": "Images_Get", + "title": "Images_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": {} + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json new file mode 100644 index 000000000000..7701f85222a1 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetImages.json @@ -0,0 +1,27 @@ +{ + "operationId": "Images_ListByCatalog", + "title": "Images_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "00000000-0000-0000-0000-000000000001", + "name": "MyImage1" + }, + { + "id": "00000000-0000-0000-0000-000000000002", + "name": "MyImage2" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetOperations.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetOperations.json new file mode 100644 index 000000000000..5a4b09163c2d --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetOperations.json @@ -0,0 +1,35 @@ +{ + "operationId": "Operations_List", + "title": "Operations_List", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "Microsoft.AzureSphere/catalogs/Read", + "display": { + "provider": "Microsoft.AzureSphere", + "resource": "catalog", + "operation": "Gets/List catalog", + "description": "Read Azure Sphere catalogs" + } + }, + { + "name": "Microsoft.AzureSphere/catalogs/Write", + "display": { + "provider": "Microsoft.AzureSphere", + "resource": "catalog", + "operation": "Create/Update catalog", + "description": "Writes Azure Sphere catalogs" + } + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProduct.json new file mode 100644 index 000000000000..570db8296b81 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProduct.json @@ -0,0 +1,23 @@ +{ + "operationId": "Products_Get", + "title": "Products_Get", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "type": "microsoft.azureSphere/catalogs/products", + "properties": { + "description": "product description." + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProducts.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProducts.json new file mode 100644 index 000000000000..915cd38158a3 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/GetProducts.json @@ -0,0 +1,29 @@ +{ + "operationId": "Products_ListByCatalog", + "title": "Products_ListByCatalog", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/products" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2", + "name": "MyProduct2", + "type": "Microsoft.AzureSphere/catalogs/products" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchCatalog.json new file mode 100644 index 000000000000..bec2ebeca152 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchCatalog.json @@ -0,0 +1,25 @@ +{ + "operationId": "Catalogs_Update", + "title": "Catalogs_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "properties": {}, + "resource": { + "location": "global" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDevice.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDevice.json new file mode 100644 index 000000000000..6dd5ed784af2 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDevice.json @@ -0,0 +1,36 @@ +{ + "operationId": "Devices_Update", + "title": "Devices_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1/device/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "type": "Microsoft.AzureSphere/catalogs/products/devicegroups", + "properties": { + "chipSku": "MyChipSku1", + "lastAvailableOsVersion": "AvailableOsVersion1", + "lastInstalledOsVersion": "InstalledOsVersion1", + "lastOsUpdateUtc": "2022-10-30T23:54:21.96Z", + "lastUpdateRequestUtc": "2022-10-01T23:54:21.96Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "The device update started successfully." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDeviceGroup.json new file mode 100644 index 000000000000..84cd946a5ca9 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchDeviceGroup.json @@ -0,0 +1,33 @@ +{ + "operationId": "DeviceGroups_Update", + "title": "DeviceGroups_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups", + "properties": { + "description": "The description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "Resource update request accepted." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchProduct.json new file mode 100644 index 000000000000..e2da1aafeb7e --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PatchProduct.json @@ -0,0 +1,30 @@ +{ + "operationId": "Products_Update", + "title": "Products_Update", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "properties": {}, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "type": "microsoft.azureSphere/catalogs/products", + "properties": { + "description": "Product description." + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + }, + "description": "Resource update request accepted." + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostClaimDevices.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostClaimDevices.json new file mode 100644 index 000000000000..193ef5d3e2a6 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostClaimDevices.json @@ -0,0 +1,25 @@ +{ + "operationId": "DeviceGroups_ClaimDevices", + "title": "DeviceGroups_ClaimDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "claimDevicesRequest": { + "deviceIdentifiers": [ + "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000" + ] + }, + "api-version": "2024-04-01" + }, + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesCatalog.json new file mode 100644 index 000000000000..979f312d235a --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesCatalog.json @@ -0,0 +1,18 @@ +{ + "operationId": "Catalogs_CountDevices", + "title": "Catalogs_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesDeviceGroup.json new file mode 100644 index 000000000000..45e5e0b05ad3 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesDeviceGroup.json @@ -0,0 +1,20 @@ +{ + "operationId": "DeviceGroups_CountDevices", + "title": "DeviceGroups_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesProduct.json new file mode 100644 index 000000000000..4ca2bcd28a2c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostCountDevicesProduct.json @@ -0,0 +1,21 @@ +{ + "operationId": "Products_CountDevices", + "title": "Products_CountDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "productGroupName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": 3 + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDefaultDeviceGroups.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDefaultDeviceGroups.json new file mode 100644 index 000000000000..b86ea57c2833 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDefaultDeviceGroups.json @@ -0,0 +1,40 @@ +{ + "operationId": "Products_GenerateDefaultDeviceGroups", + "title": "Products_GenerateDefaultDeviceGroups", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "properties": { + "description": "Device group description 1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll", + "allowCrashDumpsCollection": "Enabled" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "properties": { + "description": "Device group description 2", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll", + "allowCrashDumpsCollection": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDeviceCapabilityImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDeviceCapabilityImage.json new file mode 100644 index 000000000000..3f10e240a86c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostGenerateDeviceCapabilityImage.json @@ -0,0 +1,32 @@ +{ + "operationId": "Devices_GenerateCapabilityImage", + "title": "Devices_GenerateCapabilityImage", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "generateDeviceCapabilityRequest": { + "capabilities": [ + "ApplicationDevelopment" + ] + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "image": "TheDeviceCapabilityImage" + } + }, + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeploymentsByCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeploymentsByCatalog.json new file mode 100644 index 000000000000..9e1bafb39819 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeploymentsByCatalog.json @@ -0,0 +1,27 @@ +{ + "operationId": "Catalogs_ListDeployments", + "title": "Catalogs_ListDeployments", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "DeploymentName1111", + "properties": {} + }, + { + "name": "DeploymentName1121", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json new file mode 100644 index 000000000000..59a575a79ed0 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceGroupsCatalog.json @@ -0,0 +1,32 @@ +{ + "operationId": "Catalogs_ListDeviceGroups", + "title": "Catalogs_ListDeviceGroups", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "listDeviceGroupsRequest": { + "deviceGroupName": "MyDeviceGroup1" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "name": "MyDeviceGroup1", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct2/devicegroups/MyDeviceGroup2", + "name": "MyDeviceGroup2", + "type": "microsoft.azureSphere/catalogs/products/devicegroups" + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceInsightsCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceInsightsCatalog.json new file mode 100644 index 000000000000..836f912dca25 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDeviceInsightsCatalog.json @@ -0,0 +1,40 @@ +{ + "operationId": "Catalogs_ListDeviceInsights", + "title": "Catalogs_ListDeviceInsights", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "$top": 10, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "description": "eventDescription1", + "deviceId": "eventIdentifier1", + "startTimestampUtc": "2021-09-30T21:51:39.26Z", + "endTimestampUtc": "2021-09-30T23:54:21.96Z", + "eventCategory": "eventCategory1", + "eventClass": "eventClass1", + "eventType": "eventType1", + "eventCount": 1 + }, + { + "description": "eventDescription2", + "deviceId": "eventIdentifier2", + "startTimestampUtc": "2022-12-06T12:41:39.26Z", + "endTimestampUtc": "2022-12-07T17:34:12.50Z", + "eventCategory": "eventCategory2", + "eventClass": "eventClass2", + "eventType": "eventType2", + "eventCount": 1 + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDevicesByCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDevicesByCatalog.json new file mode 100644 index 000000000000..adfc7215cb82 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostListDevicesByCatalog.json @@ -0,0 +1,27 @@ +{ + "operationId": "Catalogs_ListDevices", + "title": "Catalogs_ListDevices", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "value": [ + { + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {} + }, + { + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": {} + } + ] + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveCatalogCertChain.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveCatalogCertChain.json new file mode 100644 index 000000000000..d899e89ea6d6 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveCatalogCertChain.json @@ -0,0 +1,19 @@ +{ + "operationId": "Certificates_RetrieveCertChain", + "title": "Certificates_RetrieveCertChain", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "active", + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "certificateChain": "ABynaryRepresentationOfTheRequestedCatalogCertificateChain" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveProofOfPossessionNonce.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveProofOfPossessionNonce.json new file mode 100644 index 000000000000..400c9af86b8a --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostRetrieveProofOfPossessionNonce.json @@ -0,0 +1,22 @@ +{ + "operationId": "Certificates_RetrieveProofOfPossessionNonce", + "title": "Certificates_RetrieveProofOfPossessionNonce", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "serialNumber": "active", + "proofOfPossessionNonceRequest": { + "proofOfPossessionNonce": "proofOfPossessionNonce" + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "certificate": "bXliYXNlNjRzdHJpbmc=" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostUploadImageCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostUploadImageCatalog.json new file mode 100644 index 000000000000..022a60a12a4f --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PostUploadImageCatalog.json @@ -0,0 +1,23 @@ +{ + "operationId": "Catalogs_UploadImage", + "title": "Catalogs_UploadImage", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "uploadImageRequest": { + "properties": { + "image": "bXliYXNlNjRzdHJpbmc=" + } + } + }, + "responses": { + "202": { + "description": "Resource operation accepted.", + "headers": { + "Azure-AsyncOperation": "https://foo.com/operationstatus" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutCatalog.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutCatalog.json new file mode 100644 index 000000000000..6fedad40487c --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutCatalog.json @@ -0,0 +1,34 @@ +{ + "operationId": "Catalogs_CreateOrUpdate", + "title": "Catalogs_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "api-version": "2024-04-01", + "location": "global", + "resource": { + "location": "global" + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1", + "name": "MyCatalog1", + "type": "Microsoft.AzureSphere/catalogs", + "location": "global" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeployment.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeployment.json new file mode 100644 index 000000000000..ce2abff598ca --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeployment.json @@ -0,0 +1,47 @@ +{ + "operationId": "Deployments_CreateOrUpdate", + "title": "Deployments_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deploymentName": "MyDeployment1", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/deviceGroups/MyDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "properties": { + "deployedImages": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/MyImage1", + "properties": { + "image": "MyImage", + "imageId": "00000000-0000-0000-0000-000000000000", + "uri": "imageUri", + "regionalDataBoundary": "None", + "imageType": "InvalidImageType", + "provisioningState": "Succeeded" + } + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/deployments/MyDeployment1", + "name": "MyDeployment1", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups/deployments" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDevice.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDevice.json new file mode 100644 index 000000000000..7e69ec373bf2 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDevice.json @@ -0,0 +1,34 @@ +{ + "operationId": "Devices_CreateOrUpdate", + "title": "Devices_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "myDeviceGroup1", + "deviceName": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "properties": { + "chipSku": "MyChipSku1" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1/devices/00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "name": "00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups/devices" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeviceGroup.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeviceGroup.json new file mode 100644 index 000000000000..eaf9e7a53c95 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutDeviceGroup.json @@ -0,0 +1,46 @@ +{ + "operationId": "DeviceGroups_CreateOrUpdate", + "title": "DeviceGroups_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "deviceGroupName": "MyDeviceGroup1", + "api-version": "2024-04-01", + "resource": { + "properties": { + "description": "Description for MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1/devicegroups/MyDeviceGroup1", + "type": "microsoft.AzureSphere/catalogs/products/devicegroups", + "properties": { + "description": "Description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/myProduct1/deviceGroups/myDeviceGroup1", + "name": "MyDeviceId1", + "type": "Microsoft.AzureSphere/catalogs/products/deviceGroups", + "properties": { + "description": "Description of MyDeviceGroup1", + "osFeedType": "Retail", + "updatePolicy": "UpdateAll" + } + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutImage.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutImage.json new file mode 100644 index 000000000000..6d26ad07a8ae --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutImage.json @@ -0,0 +1,34 @@ +{ + "operationId": "Images_CreateOrUpdate", + "title": "Image_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "imageName": "00000000-0000-0000-0000-000000000000", + "resource": { + "properties": { + "image": "bXliYXNlNjRzdHJpbmc=" + } + }, + "api-version": "2024-04-01" + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/default", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/images" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/images/default", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/images" + } + } + } +} diff --git a/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutProduct.json b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutProduct.json new file mode 100644 index 000000000000..75a53ec45323 --- /dev/null +++ b/specification/sphere/resource-manager/Microsoft.AzureSphere/stable/2024-04-01/examples/PutProduct.json @@ -0,0 +1,30 @@ +{ + "operationId": "Products_CreateOrUpdate", + "title": "Products_CreateOrUpdate", + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MyResourceGroup1", + "catalogName": "MyCatalog1", + "productName": "MyProduct1", + "api-version": "2024-04-01", + "resource": {} + }, + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs/products" + } + }, + "201": { + "description": "ARM create operation completed successfully.", + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup1/providers/Microsoft.AzureSphere/catalogs/MyCatalog1/products/MyProduct1", + "name": "MyProduct1", + "type": "Microsoft.AzureSphere/catalogs" + } + } + } +} diff --git a/specification/sphere/resource-manager/readme.md b/specification/sphere/resource-manager/readme.md index 5c4ecd51faec..e126e3cabf37 100644 --- a/specification/sphere/resource-manager/readme.md +++ b/specification/sphere/resource-manager/readme.md @@ -40,6 +40,15 @@ input-file: - Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json ``` +### Tag: package-2024-04-01 + +These settings apply only when `--tag=package-2024-04-01` is specified on the command line. + +``` yaml $(tag) == 'package-2024-04-01' +input-file: +- Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json +``` + # Code Generation ## Swagger to SDK @@ -108,6 +117,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/Microsoft.AzureSphere/preview/2022-09-01-preview/azuresphere.json + - $(this-folder)/Microsoft.AzureSphere/stable/2024-04-01/azuresphere.json ``` If there are files that should not be in the `all-api-versions` set,