Guides

MICROSOFT.AZURESPHERE

Suggest Edits
docs.microsoft.com
Azure documentation

Catalogs_CountDevices

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_CreateOrUpdate

valid {
    input.Body.properties == {}
    input.Body.tags.STRING == STRING
    input.Body.location == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_Delete

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_Get

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_ListByResourceGroup

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_ListBySubscription

valid {
    input.ReqMap.SubscriptionID == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
}

Catalogs_ListDeployments

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.Qs.$filter == STRING
    input.Qs.$top == INTEGER
    input.Qs.$skip == INTEGER
    input.Qs.$maxpagesize == INTEGER
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_ListDeviceGroups

valid {
    input.Body.deviceGroupName == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.Qs.$filter == STRING
    input.Qs.$top == INTEGER
    input.Qs.$skip == INTEGER
    input.Qs.$maxpagesize == INTEGER
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_ListDeviceInsights

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.Qs.$filter == STRING
    input.Qs.$top == INTEGER
    input.Qs.$skip == INTEGER
    input.Qs.$maxpagesize == INTEGER
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_ListDevices

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.Qs.$filter == STRING
    input.Qs.$top == INTEGER
    input.Qs.$skip == INTEGER
    input.Qs.$maxpagesize == INTEGER
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_Update

valid {
    input.Body.tags.STRING == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Catalogs_UploadImage

enum_RegionalDataBoundary := [ "None", "EU" ]

valid {
    input.Body.properties.image == STRING
    input.Body.properties.imageId == STRING
    input.Body.properties.regionalDataBoundary == enum_RegionalDataBoundary[_]
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Certificates_Get

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.serialNumber == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Certificates_ListByCatalog

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.Qs.$filter == STRING
    input.Qs.$top == INTEGER
    input.Qs.$skip == INTEGER
    input.Qs.$maxpagesize == INTEGER
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Certificates_RetrieveCertChain

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.serialNumber == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Certificates_RetrieveProofOfPossessionNonce

valid {
    input.Body.proofOfPossessionNonce == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.serialNumber == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Deployments_CreateOrUpdate

enum_RegionalDataBoundary := [ "None", "EU" ]

valid {
    input.Body.properties.deploymentId == STRING
    input.Body.properties.deployedImages[_].properties.image == STRING
    input.Body.properties.deployedImages[_].properties.imageId == STRING
    input.Body.properties.deployedImages[_].properties.regionalDataBoundary == enum_RegionalDataBoundary[_]
    input.Body.STRING == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.ReqMap.deploymentName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Deployments_Delete

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.ReqMap.deploymentName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Deployments_Get

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.ReqMap.deploymentName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Deployments_ListByDeviceGroup

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.Qs.api-version == STRING
    input.Qs.$filter == STRING
    input.Qs.$top == INTEGER
    input.Qs.$skip == INTEGER
    input.Qs.$maxpagesize == INTEGER
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

DeviceGroups_ClaimDevices

valid {
    input.Body.deviceIdentifiers[_] == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

DeviceGroups_CountDevices

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

DeviceGroups_CreateOrUpdate

enum_AllowCrashDumpCollection := [ "Enabled", "Disabled" ]
enum_OSFeedType := [ "Retail", "RetailEval" ]
enum_RegionalDataBoundary := [ "None", "EU" ]
enum_UpdatePolicy := [ "UpdateAll", "No3rdPartyAppUpdates" ]

valid {
    input.Body.properties.description == STRING
    input.Body.properties.osFeedType == enum_OSFeedType[_]
    input.Body.properties.updatePolicy == enum_UpdatePolicy[_]
    input.Body.properties.allowCrashDumpsCollection == enum_AllowCrashDumpCollection[_]
    input.Body.properties.regionalDataBoundary == enum_RegionalDataBoundary[_]
    input.Body.STRING == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

DeviceGroups_Delete

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

DeviceGroups_Get

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

DeviceGroups_ListByProduct

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.Qs.api-version == STRING
    input.Qs.$filter == STRING
    input.Qs.$top == INTEGER
    input.Qs.$skip == INTEGER
    input.Qs.$maxpagesize == INTEGER
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

DeviceGroups_Update

enum_AllowCrashDumpCollection := [ "Enabled", "Disabled" ]
enum_OSFeedType := [ "Retail", "RetailEval" ]
enum_RegionalDataBoundary := [ "None", "EU" ]
enum_UpdatePolicy := [ "UpdateAll", "No3rdPartyAppUpdates" ]

valid {
    input.Body.properties.description == STRING
    input.Body.properties.osFeedType == enum_OSFeedType[_]
    input.Body.properties.updatePolicy == enum_UpdatePolicy[_]
    input.Body.properties.allowCrashDumpsCollection == enum_AllowCrashDumpCollection[_]
    input.Body.properties.regionalDataBoundary == enum_RegionalDataBoundary[_]
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Devices_CreateOrUpdate

valid {
    input.Body.properties.deviceId == STRING
    input.Body.STRING == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.ReqMap.deviceName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Devices_Delete

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.ReqMap.deviceName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Devices_GenerateCapabilityImage

enum_CapabilityType := [ "ApplicationDevelopment", "FieldServicing" ]

valid {
    input.Body.capabilities[_] == enum_CapabilityType[_]
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.ReqMap.deviceName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Devices_Get

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.ReqMap.deviceName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Devices_ListByDeviceGroup

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Devices_Update

valid {
    input.Body.properties.deviceGroupId == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.ReqMap.deviceGroupName == STRING
    input.ReqMap.deviceName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Images_CreateOrUpdate

enum_RegionalDataBoundary := [ "None", "EU" ]

valid {
    input.Body.properties.image == STRING
    input.Body.properties.imageId == STRING
    input.Body.properties.regionalDataBoundary == enum_RegionalDataBoundary[_]
    input.Body.STRING == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.imageName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Images_Delete

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.imageName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Images_Get

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.imageName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Images_ListByCatalog

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.Qs.$filter == STRING
    input.Qs.$top == INTEGER
    input.Qs.$skip == INTEGER
    input.Qs.$maxpagesize == INTEGER
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Operations_List

valid {
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
}

Products_CountDevices

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Products_CreateOrUpdate

valid {
    input.Body.properties.description == STRING
    input.Body.STRING == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Products_Delete

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Products_GenerateDefaultDeviceGroups

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Products_Get

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Products_ListByCatalog

valid {
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Products_Update

valid {
    input.Body.properties.description == STRING
    input.ReqMap.SubscriptionID == STRING
    input.ReqMap.ResourceGroup == STRING
    input.ReqMap.catalogName == STRING
    input.ReqMap.productName == STRING
    input.Qs.api-version == STRING
    input.ProviderMetadata.Region == STRING
    input.ProviderMetadata.SubscriptionID == STRING
    input.ProviderMetadata.ResourceGroup == STRING
}

Updated 8 months ago