Package-level declarations

Types

Link copied to clipboard
data class CertificatePropertiesResponse(val certificate: String? = null, val created: String, val expiry: String, val isVerified: Boolean? = null, val subject: String, val thumbprint: String, val updated: String)

The description of an X509 CA Certificate.

Link copied to clipboard
data class GetDpsCertificateResult(val azureApiVersion: String, val etag: String, val id: String, val name: String, val properties: CertificatePropertiesResponse, val systemData: SystemDataResponse, val type: String)

The X509 Certificate.

data class GetIotDpsResourcePrivateEndpointConnectionResult(val azureApiVersion: String, val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val systemData: SystemDataResponse, val type: String)

The private endpoint connection of a provisioning service

Link copied to clipboard
data class GetIotDpsResourceResult(val azureApiVersion: String, val etag: String? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val location: String, val name: String, val properties: IotDpsPropertiesDescriptionResponse, val resourcegroup: String? = null, val sku: IotDpsSkuInfoResponse, val subscriptionid: String? = null, val systemData: SystemDataResponse, val tags: Map<String, String>? = null, val type: String)

The description of the provisioning service.

Link copied to clipboard
data class IotDpsPropertiesDescriptionResponse(val allocationPolicy: String? = null, val authorizationPolicies: List<SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse>? = null, val deviceProvisioningHostName: String, val enableDataResidency: Boolean? = null, val idScope: String, val iotHubs: List<IotHubDefinitionDescriptionResponse>? = null, val ipFilterRules: List<IpFilterRuleResponse>? = null, val portalOperationsHostName: String? = null, val privateEndpointConnections: List<PrivateEndpointConnectionResponse>? = null, val provisioningState: String? = null, val publicNetworkAccess: String? = null, val serviceOperationsHostName: String, val state: String? = null)

the service specific properties of a provisioning service, including keys, linked iot hubs, current state, and system generated properties such as hostname and idScope

Link copied to clipboard
data class IotDpsSkuInfoResponse(val capacity: Double? = null, val name: String? = null, val tier: String)

List of possible provisioning service SKUs.

Link copied to clipboard
data class IotHubDefinitionDescriptionResponse(val allocationWeight: Int? = null, val applyAllocationPolicy: Boolean? = null, val connectionString: String, val location: String, val name: String)

Description of the IoT hub.

Link copied to clipboard
data class IpFilterRuleResponse(val action: String, val filterName: String, val ipMask: String, val target: String? = null)

The IP filter rules for a provisioning Service.

Link copied to clipboard
data class ListIotDpsResourceKeysForKeyNameResult(val keyName: String, val primaryKey: String? = null, val rights: String, val secondaryKey: String? = null)

Description of the shared access key.

Link copied to clipboard

List of shared access keys.

Link copied to clipboard
data class ManagedServiceIdentityResponse(val principalId: String, val tenantId: String, val type: String, val userAssignedIdentities: Map<String, UserAssignedIdentityResponse>? = null)

Managed service identity (system assigned and/or user assigned identities)

data class PrivateEndpointConnectionPropertiesResponse(val privateEndpoint: PrivateEndpointResponse? = null, val privateLinkServiceConnectionState: PrivateLinkServiceConnectionStateResponse)

The properties of a private endpoint connection

Link copied to clipboard
data class PrivateEndpointConnectionResponse(val id: String, val name: String, val properties: PrivateEndpointConnectionPropertiesResponse, val systemData: SystemDataResponse, val type: String)

The private endpoint connection of a provisioning service

Link copied to clipboard
data class PrivateEndpointResponse(val id: String)

The private endpoint property of a private endpoint connection

data class PrivateLinkServiceConnectionStateResponse(val actionsRequired: String? = null, val description: String, val status: String)

The current state of a private endpoint connection

data class SharedAccessSignatureAuthorizationRuleAccessRightsDescriptionResponse(val keyName: String, val primaryKey: String? = null, val rights: String, val secondaryKey: String? = null)

Description of the shared access key.

Link copied to clipboard
data class SystemDataResponse(val createdAt: String? = null, val createdBy: String? = null, val createdByType: String? = null, val lastModifiedAt: String? = null, val lastModifiedBy: String? = null, val lastModifiedByType: String? = null)

Metadata pertaining to creation and last modification of the resource.

Link copied to clipboard
data class UserAssignedIdentityResponse(val clientId: String, val principalId: String)

User assigned identity properties