The Microsoft Azure Sphere Provider Client is a software tool developed by Microsoft that acts as a bridge between the Azure Sphere operating system and the Azure IoT service. It enables seamless communication and integration between Azure Sphere-powered devices and the Azure cloud platform, allowing for secure and reliable data exchange, remote monitoring, and management of connected devices.
swagger: '2.0'
info:
title: Microsoft Azure AzureSphereProviderClient
version: 2022-09-01-preview
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: Catalogs
- name: Certificates
- name: Deployments
- name: DeviceGroups
- name: Devices
- name: Images
- name: Operations
- name: Products
paths:
/providers/Microsoft.AzureSphere/operations:
get:
operationId: microsoftAzureOperationsList
tags:
- Operations
description: List the operations for the provider
parameters:
- $ref: >-
../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter
responses:
'200':
description: Azure 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
summary: Get Providers Microsoft Azuresphere Operations
/subscriptions/{subscriptionId}/providers/Microsoft.AzureSphere/catalogs:
get:
operationId: microsoftAzureCatalogsListbysubscription
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: Azure 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
summary: >-
Get Subscriptions Subscriptionid Providers Microsoft Azuresphere
Catalogs
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs:
get:
operationId: microsoftAzureCatalogsListbyresourcegroup
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: Azure 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
summary: >-
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}:
get:
operationId: microsoftAzureCatalogsGet
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: Azure 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
summary: >-
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname
put:
operationId: microsoftAzureCatalogsCreateorupdate
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
summary: >-
Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname
patch:
operationId: microsoftAzureCatalogsUpdate
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: Azure 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
summary: >-
Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname
delete:
operationId: microsoftAzureCatalogsDelete
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:
Location:
type: string
description: >-
The Location header contains the URL where the status of the
long running operation can be checked.
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
'204':
description: Resource does not exist.
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
summary: >-
Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates
: get:
operationId: microsoftAzureCertificatesListbycatalog
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: Azure 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
summary: >-
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Certificates
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}
: get:
operationId: microsoftAzureCertificatesGet
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: Azure 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
summary: >-
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Certificates
Serialnumber
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveCertChain
: post:
operationId: microsoftAzureCertificatesRetrievecertchain
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: Azure 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
summary: >-
Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Certificates
Serialnumber Retrievecertchain
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/certificates/{serialNumber}/retrieveProofOfPossessionNonce
: post:
operationId: microsoftAzureCertificatesRetrieveproofofpossessionnonce
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: Azure 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
summary: >-
Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Certificates
Serialnumber Retrieveproofofpossessionnonce
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/countDevices
: post:
operationId: microsoftAzureCatalogsCountdevices
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: Azure operation completed successfully.
schema:
$ref: '#/definitions/CountDeviceResponse'
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
summary: >-
Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Countdevices
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images
: get:
operationId: microsoftAzureImagesListbycatalog
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: Azure 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
summary: >-
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Images
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/images/{imageName}
: get:
operationId: microsoftAzureImagesGet
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: Azure 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
summary: >-
Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Images Imagename
put:
operationId: microsoftAzureImagesCreateorupdate
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
summary: >-
Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Images Imagename
delete:
operationId: microsoftAzureImagesDelete
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:
Location:
type: string
description: >-
The Location header contains the URL where the status of the
long running operation can be checked.
Retry-After:
type: integer
format: int32
description: >-
The Retry-After header can indicate how long the client should
wait before polling the operation status.
'204':
description: Resource does not exist.
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
summary: >-
Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Images Imagename
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeployments
: post:
operationId: microsoftAzureCatalogsListdeployments
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: Azure 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
summary: >-
Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Listdeployments
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceGroups
: post:
operationId: microsoftAzureCatalogsListdevicegroups
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: Azure 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
summary: >-
Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname
Providers Microsoft Azuresphere Catalogs Catalogname Listdevicegroups
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureSphere/catalogs/{catalogName}/listDeviceInsights
: post:
operationId: microsoftAzureCatalogsListdeviceinsights
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:
# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/azuresphereproviderclient-openapi-original.yml