@azure/arm-sphere package

Reference

Classes

Interfaces

AzureSphereManagementClientOptionalParams	Optional parameters.
Catalog	An Azure Sphere catalog
CatalogListResult	The response of a Catalog list operation.
CatalogProperties	Catalog properties
CatalogUpdate	The type used for update operations of the Catalog.
Catalogs	Interface representing a Catalogs.
CatalogsCountDevicesOptionalParams	Optional parameters.
CatalogsCreateOrUpdateHeaders	Defines headers for Catalogs_createOrUpdate operation.
CatalogsCreateOrUpdateOptionalParams	Optional parameters.
CatalogsDeleteHeaders	Defines headers for Catalogs_delete operation.
CatalogsDeleteOptionalParams	Optional parameters.
CatalogsGetOptionalParams	Optional parameters.
CatalogsListByResourceGroupNextOptionalParams	Optional parameters.
CatalogsListByResourceGroupOptionalParams	Optional parameters.
CatalogsListBySubscriptionNextOptionalParams	Optional parameters.
CatalogsListBySubscriptionOptionalParams	Optional parameters.
CatalogsListDeploymentsNextOptionalParams	Optional parameters.
CatalogsListDeploymentsOptionalParams	Optional parameters.
CatalogsListDeviceGroupsNextOptionalParams	Optional parameters.
CatalogsListDeviceGroupsOptionalParams	Optional parameters.
CatalogsListDeviceInsightsNextOptionalParams	Optional parameters.
CatalogsListDeviceInsightsOptionalParams	Optional parameters.
CatalogsListDevicesNextOptionalParams	Optional parameters.
CatalogsListDevicesOptionalParams	Optional parameters.
CatalogsUpdateOptionalParams	Optional parameters.
CatalogsUploadImageHeaders	Defines headers for Catalogs_uploadImage operation.
CatalogsUploadImageOptionalParams	Optional parameters.
Certificate	An certificate resource belonging to a catalog resource.
CertificateChainResponse	The certificate chain response.
CertificateListResult	The response of a Certificate list operation.
CertificateProperties	The properties of certificate
Certificates	Interface representing a Certificates.
CertificatesGetOptionalParams	Optional parameters.
CertificatesListByCatalogNextOptionalParams	Optional parameters.
CertificatesListByCatalogOptionalParams	Optional parameters.
CertificatesRetrieveCertChainOptionalParams	Optional parameters.
CertificatesRetrieveProofOfPossessionNonceOptionalParams	Optional parameters.
ClaimDevicesRequest	Request to the action call to bulk claim devices.
CountDeviceResponse	Response to the action call for count devices in a catalog (preview API).
CountDevicesResponse	Response to the action call for count devices in a catalog.
CountElementsResponse	Response of the count for elements.
Deployment	An deployment resource belonging to a device group resource.
DeploymentListResult	The response of a Deployment list operation.
DeploymentProperties	The properties of deployment
Deployments	Interface representing a Deployments.
DeploymentsCreateOrUpdateHeaders	Defines headers for Deployments_createOrUpdate operation.
DeploymentsCreateOrUpdateOptionalParams	Optional parameters.
DeploymentsDeleteHeaders	Defines headers for Deployments_delete operation.
DeploymentsDeleteOptionalParams	Optional parameters.
DeploymentsGetOptionalParams	Optional parameters.
DeploymentsListByDeviceGroupNextOptionalParams	Optional parameters.
DeploymentsListByDeviceGroupOptionalParams	Optional parameters.
Device	An device resource belonging to a device group resource.
DeviceGroup	An device group resource belonging to a product resource.
DeviceGroupListResult	The response of a DeviceGroup list operation.
DeviceGroupProperties	The properties of deviceGroup
DeviceGroupUpdate	The type used for update operations of the DeviceGroup.
DeviceGroupUpdateProperties	The updatable properties of the DeviceGroup.
DeviceGroups	Interface representing a DeviceGroups.
DeviceGroupsClaimDevicesHeaders	Defines headers for DeviceGroups_claimDevices operation.
DeviceGroupsClaimDevicesOptionalParams	Optional parameters.
DeviceGroupsCountDevicesOptionalParams	Optional parameters.
DeviceGroupsCreateOrUpdateHeaders	Defines headers for DeviceGroups_createOrUpdate operation.
DeviceGroupsCreateOrUpdateOptionalParams	Optional parameters.
DeviceGroupsDeleteHeaders	Defines headers for DeviceGroups_delete operation.
DeviceGroupsDeleteOptionalParams	Optional parameters.
DeviceGroupsGetOptionalParams	Optional parameters.
DeviceGroupsListByProductNextOptionalParams	Optional parameters.
DeviceGroupsListByProductOptionalParams	Optional parameters.
DeviceGroupsUpdateHeaders	Defines headers for DeviceGroups_update operation.
DeviceGroupsUpdateOptionalParams	Optional parameters.
DeviceInsight	Device insight report.
DeviceListResult	The response of a Device list operation.
DeviceProperties	The properties of device
DeviceUpdate	The type used for update operations of the Device.
DeviceUpdateProperties	The updatable properties of the Device.
Devices	Interface representing a Devices.
DevicesCreateOrUpdateHeaders	Defines headers for Devices_createOrUpdate operation.
DevicesCreateOrUpdateOptionalParams	Optional parameters.
DevicesDeleteHeaders	Defines headers for Devices_delete operation.
DevicesDeleteOptionalParams	Optional parameters.
DevicesGenerateCapabilityImageHeaders	Defines headers for Devices_generateCapabilityImage operation.
DevicesGenerateCapabilityImageOptionalParams	Optional parameters.
DevicesGetOptionalParams	Optional parameters.
DevicesListByDeviceGroupNextOptionalParams	Optional parameters.
DevicesListByDeviceGroupOptionalParams	Optional parameters.
DevicesUpdateHeaders	Defines headers for Devices_update operation.
DevicesUpdateOptionalParams	Optional parameters.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).
GenerateCapabilityImageRequest	Request of the action to create a signed device capability image
Image	An image resource belonging to a catalog resource.
ImageListResult	The response of a Image list operation.
ImageProperties	The properties of image
Images	Interface representing a Images.
ImagesCreateOrUpdateHeaders	Defines headers for Images_createOrUpdate operation.
ImagesCreateOrUpdateOptionalParams	Optional parameters.
ImagesDeleteHeaders	Defines headers for Images_delete operation.
ImagesDeleteOptionalParams	Optional parameters.
ImagesGetOptionalParams	Optional parameters.
ImagesListByCatalogNextOptionalParams	Optional parameters.
ImagesListByCatalogOptionalParams	Optional parameters.
ListDeviceGroupsRequest	Request of the action to list device groups for a catalog.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for this particular operation.
OperationListResult	A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.
Operations	Interface representing a Operations.
OperationsListNextOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
PagedDeviceInsight	Paged collection of DeviceInsight items
Product	An product resource belonging to a catalog resource.
ProductListResult	The response of a Product list operation.
ProductProperties	The properties of product
ProductUpdate	The type used for update operations of the Product.
ProductUpdateProperties	The updatable properties of the Product.
Products	Interface representing a Products.
ProductsCountDevicesOptionalParams	Optional parameters.
ProductsCreateOrUpdateHeaders	Defines headers for Products_createOrUpdate operation.
ProductsCreateOrUpdateOptionalParams	Optional parameters.
ProductsDeleteHeaders	Defines headers for Products_delete operation.
ProductsDeleteOptionalParams	Optional parameters.
ProductsGenerateDefaultDeviceGroupsNextOptionalParams	Optional parameters.
ProductsGenerateDefaultDeviceGroupsOptionalParams	Optional parameters.
ProductsGetOptionalParams	Optional parameters.
ProductsListByCatalogNextOptionalParams	Optional parameters.
ProductsListByCatalogOptionalParams	Optional parameters.
ProductsUpdateHeaders	Defines headers for Products_update operation.
ProductsUpdateOptionalParams	Optional parameters.
ProofOfPossessionNonceRequest	Request for the proof of possession nonce
ProofOfPossessionNonceResponse	Result of the action to generate a proof of possession nonce
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
SignedCapabilityImageResponse	Signed device capability image response
SystemData	Metadata pertaining to creation and last modification of the resource.
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'

Type Aliases

ActionType	Defines values for ActionType. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal
AllowCrashDumpCollection	Defines values for AllowCrashDumpCollection. KnownAllowCrashDumpCollection can be used interchangeably with AllowCrashDumpCollection, this enum contains the known values that the service supports. Known values supported by the service Enabled: Crash dump collection enabled Disabled: Crash dump collection disabled
CapabilityType	Defines values for CapabilityType. KnownCapabilityType can be used interchangeably with CapabilityType, this enum contains the known values that the service supports. Known values supported by the service ApplicationDevelopment: Application development capability FieldServicing: Field servicing capability
CatalogsCountDevicesResponse	Contains response data for the countDevices operation.
CatalogsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
CatalogsGetResponse	Contains response data for the get operation.
CatalogsListByResourceGroupNextResponse	Contains response data for the listByResourceGroupNext operation.
CatalogsListByResourceGroupResponse	Contains response data for the listByResourceGroup operation.
CatalogsListBySubscriptionNextResponse	Contains response data for the listBySubscriptionNext operation.
CatalogsListBySubscriptionResponse	Contains response data for the listBySubscription operation.
CatalogsListDeploymentsNextResponse	Contains response data for the listDeploymentsNext operation.
CatalogsListDeploymentsResponse	Contains response data for the listDeployments operation.
CatalogsListDeviceGroupsNextResponse	Contains response data for the listDeviceGroupsNext operation.
CatalogsListDeviceGroupsResponse	Contains response data for the listDeviceGroups operation.
CatalogsListDeviceInsightsNextResponse	Contains response data for the listDeviceInsightsNext operation.
CatalogsListDeviceInsightsResponse	Contains response data for the listDeviceInsights operation.
CatalogsListDevicesNextResponse	Contains response data for the listDevicesNext operation.
CatalogsListDevicesResponse	Contains response data for the listDevices operation.
CatalogsUpdateResponse	Contains response data for the update operation.
CatalogsUploadImageResponse	Contains response data for the uploadImage operation.
CertificateStatus	Defines values for CertificateStatus. KnownCertificateStatus can be used interchangeably with CertificateStatus, this enum contains the known values that the service supports. Known values supported by the service Active: Certificate is active Inactive: Certificate is inactive Expired: Certificate has expired Revoked: Certificate has been revoked
CertificatesGetResponse	Contains response data for the get operation.
CertificatesListByCatalogNextResponse	Contains response data for the listByCatalogNext operation.
CertificatesListByCatalogResponse	Contains response data for the listByCatalog operation.
CertificatesRetrieveCertChainResponse	Contains response data for the retrieveCertChain operation.
CertificatesRetrieveProofOfPossessionNonceResponse	Contains response data for the retrieveProofOfPossessionNonce operation.
CreatedByType	Defines values for CreatedByType. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User Application ManagedIdentity Key
DeploymentsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DeploymentsGetResponse	Contains response data for the get operation.
DeploymentsListByDeviceGroupNextResponse	Contains response data for the listByDeviceGroupNext operation.
DeploymentsListByDeviceGroupResponse	Contains response data for the listByDeviceGroup operation.
DeviceGroupsClaimDevicesResponse	Contains response data for the claimDevices operation.
DeviceGroupsCountDevicesResponse	Contains response data for the countDevices operation.
DeviceGroupsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DeviceGroupsGetResponse	Contains response data for the get operation.
DeviceGroupsListByProductNextResponse	Contains response data for the listByProductNext operation.
DeviceGroupsListByProductResponse	Contains response data for the listByProduct operation.
DeviceGroupsUpdateResponse	Contains response data for the update operation.
DevicesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
DevicesGenerateCapabilityImageResponse	Contains response data for the generateCapabilityImage operation.
DevicesGetResponse	Contains response data for the get operation.
DevicesListByDeviceGroupNextResponse	Contains response data for the listByDeviceGroupNext operation.
DevicesListByDeviceGroupResponse	Contains response data for the listByDeviceGroup operation.
DevicesUpdateResponse	Contains response data for the update operation.
ImageType	Defines values for ImageType. KnownImageType can be used interchangeably with ImageType, this enum contains the known values that the service supports. Known values supported by the service InvalidImageType: Invalid image. OneBl: One Bl image type PlutonRuntime: Pluton image type WifiFirmware: Wifi firmware image type SecurityMonitor: Security monitor image type NormalWorldLoader: Normal world loader image type NormalWorldDtb: Normal world dtb image type NormalWorldKernel: Normal world kernel image type RootFs: Root FS image type Services: Services image type Applications: Applications image type FwConfig: FW config image type BootManifest: Boot manifest image type Nwfs: Nwfs image type TrustedKeystore: Trusted key store image type Policy: Policy image type CustomerBoardConfig: Customer board config image type UpdateCertStore: Update certificate store image type BaseSystemUpdateManifest: Base system update manifest image type FirmwareUpdateManifest: Firmware update manifest image type CustomerUpdateManifest: Customer update manifest image type RecoveryManifest: Recovery manifest image type ManifestSet: manifest set image type Other: Other image type
ImagesCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ImagesGetResponse	Contains response data for the get operation.
ImagesListByCatalogNextResponse	Contains response data for the listByCatalogNext operation.
ImagesListByCatalogResponse	Contains response data for the listByCatalog operation.
OSFeedType	Defines values for OSFeedType. KnownOSFeedType can be used interchangeably with OSFeedType, this enum contains the known values that the service supports. Known values supported by the service Retail: Retail OS feed type. RetailEval: Retail evaluation OS feed type.
OperationsListNextResponse	Contains response data for the listNext operation.
OperationsListResponse	Contains response data for the list operation.
Origin	Defines values for Origin. KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user system user,system
ProductsCountDevicesResponse	Contains response data for the countDevices operation.
ProductsCreateOrUpdateResponse	Contains response data for the createOrUpdate operation.
ProductsGenerateDefaultDeviceGroupsNextResponse	Contains response data for the generateDefaultDeviceGroupsNext operation.
ProductsGenerateDefaultDeviceGroupsResponse	Contains response data for the generateDefaultDeviceGroups operation.
ProductsGetResponse	Contains response data for the get operation.
ProductsListByCatalogNextResponse	Contains response data for the listByCatalogNext operation.
ProductsListByCatalogResponse	Contains response data for the listByCatalog operation.
ProductsUpdateResponse	Contains response data for the update operation.
ProvisioningState	Defines values for ProvisioningState. KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Provisioning: The resource is being provisioned Updating: The resource is being updated Deleting: The resource is being deleted Accepted: The resource create request has been accepted
RegionalDataBoundary	Defines values for RegionalDataBoundary. KnownRegionalDataBoundary can be used interchangeably with RegionalDataBoundary, this enum contains the known values that the service supports. Known values supported by the service None: No data boundary EU: EU data boundary
UpdatePolicy	Defines values for UpdatePolicy. KnownUpdatePolicy can be used interchangeably with UpdatePolicy, this enum contains the known values that the service supports. Known values supported by the service UpdateAll: Update all policy. No3rdPartyAppUpdates: No update for 3rd party app policy.

Enums

KnownActionType	Known values of ActionType that the service accepts.
KnownAllowCrashDumpCollection	Known values of AllowCrashDumpCollection that the service accepts.
KnownCapabilityType	Known values of CapabilityType that the service accepts.
KnownCertificateStatus	Known values of CertificateStatus that the service accepts.
KnownCreatedByType	Known values of CreatedByType that the service accepts.
KnownImageType	Known values of ImageType that the service accepts.
KnownOSFeedType	Known values of OSFeedType that the service accepts.
KnownOrigin	Known values of Origin that the service accepts.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownRegionalDataBoundary	Known values of RegionalDataBoundary that the service accepts.
KnownUpdatePolicy	Known values of UpdatePolicy that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page: unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

The continuation token that can be passed into byPage() during future calls.

Share via

@azure/arm-sphere package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Function Details

getContinuationToken(unknown)

Parameters

Returns

Additional resources