@azure/arm-iotcentral package

Classes

IotCentralClient

Interfaces

App

The IoT Central application.

AppAvailabilityInfo

The properties indicating whether a given IoT Central application name or subdomain is available.

AppListResult

A list of IoT Central Applications with a next link.

AppPatch

The description of the IoT Central application.

AppSkuInfo

Information about the SKU of the IoT Central application.

AppTemplate

IoT Central Application Template.

AppTemplateLocations

IoT Central Application Template Locations.

AppTemplatesResult

A list of IoT Central Application Templates with a next link.

Apps

Interface representing a Apps.

AppsCheckNameAvailabilityOptionalParams

Optional parameters.

AppsCheckSubdomainAvailabilityOptionalParams

Optional parameters.

AppsCreateOrUpdateHeaders

Defines headers for Apps_createOrUpdate operation.

AppsCreateOrUpdateOptionalParams

Optional parameters.

AppsDeleteHeaders

Defines headers for Apps_delete operation.

AppsDeleteOptionalParams

Optional parameters.

AppsGetOptionalParams

Optional parameters.

AppsListByResourceGroupNextOptionalParams

Optional parameters.

AppsListByResourceGroupOptionalParams

Optional parameters.

AppsListBySubscriptionNextOptionalParams

Optional parameters.

AppsListBySubscriptionOptionalParams

Optional parameters.

AppsListTemplatesNextOptionalParams

Optional parameters.

AppsListTemplatesOptionalParams

Optional parameters.

AppsUpdateHeaders

Defines headers for Apps_update operation.

AppsUpdateOptionalParams

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.).

IotCentralClientOptionalParams

Optional parameters.

NetworkRuleSetIpRule

An object for an IP range that will be allowed access.

NetworkRuleSets

Network Rule Set Properties of this IoT Central application.

Operation

IoT Central REST API operation

OperationDisplay

The object that represents the operation.

OperationInputs

Input values.

OperationListResult

A list of IoT Central operations. It contains a list of operations and a URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

PrivateEndpoint

The private endpoint resource.

PrivateEndpointConnection

The private endpoint connection resource.

PrivateEndpointConnectionListResult

List of private endpoint connections associated with the specified resource.

PrivateEndpointConnections

Interface representing a PrivateEndpointConnections.

PrivateEndpointConnectionsCreateHeaders

Defines headers for PrivateEndpointConnections_create operation.

PrivateEndpointConnectionsCreateOptionalParams

Optional parameters.

PrivateEndpointConnectionsDeleteHeaders

Defines headers for PrivateEndpointConnections_delete operation.

PrivateEndpointConnectionsDeleteOptionalParams

Optional parameters.

PrivateEndpointConnectionsGetOptionalParams

Optional parameters.

PrivateEndpointConnectionsListOptionalParams

Optional parameters.

PrivateLinkResource

A private link resource.

PrivateLinkResourceListResult

A list of private link resources.

PrivateLinkServiceConnectionState

A collection of information about the state of the connection between service consumer and provider.

PrivateLinks

Interface representing a PrivateLinks.

PrivateLinksGetOptionalParams

Optional parameters.

PrivateLinksListOptionalParams

Optional parameters.

Resource

Common fields that are returned in the response for all Azure Resource Manager resources

ResourceAutoGenerated

Common fields that are returned in the response for all Azure Resource Manager resources

SystemAssignedServiceIdentity

Managed service identity (either system assigned, or none)

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

AppSku

Defines values for AppSku.
KnownAppSku can be used interchangeably with AppSku, this enum contains the known values that the service supports.

Known values supported by the service

ST0
ST1
ST2

AppState

Defines values for AppState.
KnownAppState can be used interchangeably with AppState, this enum contains the known values that the service supports.

Known values supported by the service

created
suspended

AppsCheckNameAvailabilityResponse

Contains response data for the checkNameAvailability operation.

AppsCheckSubdomainAvailabilityResponse

Contains response data for the checkSubdomainAvailability operation.

AppsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

AppsDeleteResponse

Contains response data for the delete operation.

AppsGetResponse

Contains response data for the get operation.

AppsListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

AppsListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

AppsListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

AppsListBySubscriptionResponse

Contains response data for the listBySubscription operation.

AppsListTemplatesNextResponse

Contains response data for the listTemplatesNext operation.

AppsListTemplatesResponse

Contains response data for the listTemplates operation.

AppsUpdateResponse

Contains response data for the update 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

IpRuleAction

Defines values for IpRuleAction.
KnownIpRuleAction can be used interchangeably with IpRuleAction, this enum contains the known values that the service supports.

Known values supported by the service

Allow

NetworkAction

Defines values for NetworkAction.
KnownNetworkAction can be used interchangeably with NetworkAction, this enum contains the known values that the service supports.

Known values supported by the service

Allow
Deny

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

PrivateEndpointConnectionProvisioningState

Defines values for PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports.

Known values supported by the service

Succeeded
Creating
Deleting
Failed

PrivateEndpointConnectionsCreateResponse

Contains response data for the create operation.

PrivateEndpointConnectionsDeleteResponse

Contains response data for the delete operation.

PrivateEndpointConnectionsGetResponse

Contains response data for the get operation.

PrivateEndpointConnectionsListResponse

Contains response data for the list operation.

PrivateEndpointServiceConnectionStatus

Defines values for PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports.

Known values supported by the service

Pending
Approved
Rejected

PrivateLinksGetResponse

Contains response data for the get operation.

PrivateLinksListResponse

Contains response data for the list 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

Creating
Deleting
Updating
Succeeded
Failed
Canceled

PublicNetworkAccess

Defines values for PublicNetworkAccess.
KnownPublicNetworkAccess can be used interchangeably with PublicNetworkAccess, this enum contains the known values that the service supports.

Known values supported by the service

Enabled
Disabled

SystemAssignedServiceIdentityType

Defines values for SystemAssignedServiceIdentityType.
KnownSystemAssignedServiceIdentityType can be used interchangeably with SystemAssignedServiceIdentityType, this enum contains the known values that the service supports.

Known values supported by the service

None
SystemAssigned

Enums

KnownAppSku

Known values of AppSku that the service accepts.

KnownAppState

Known values of AppState that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownIpRuleAction

Known values of IpRuleAction that the service accepts.

KnownNetworkAction

Known values of NetworkAction that the service accepts.

KnownPrivateEndpointConnectionProvisioningState

Known values of PrivateEndpointConnectionProvisioningState that the service accepts.

KnownPrivateEndpointServiceConnectionStatus

Known values of PrivateEndpointServiceConnectionStatus that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

KnownPublicNetworkAccess

Known values of PublicNetworkAccess that the service accepts.

KnownSystemAssignedServiceIdentityType

Known values of SystemAssignedServiceIdentityType that the service accepts.

Functions

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given a result page from a pageable operation, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

A result object from calling .byPage() on a paged operation.

Returns

string | undefined

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