@azure/arm-edgeoperator package

Classes

EdgeOperatorClient

Interfaces

EdgeOperatorClientOptionalParams	Optional parameters for the client.
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.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
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
SystemData	Metadata pertaining to creation and last modification of the resource.
SystemReadiness	The system readiness status for Azure Local Disconnected Operations (ALDO). Reports whether the ALDO system is ready. This is a read-only singleton resource — the only accepted resource name is default. The subscription in the request path must be the Operator subscription. This subscription is used only for the access check: the resource provider verifies it on every request, and only operators have access to the Operator subscription and can therefore invoke the Microsoft.EdgeOperator APIs. Requests scoped to any other subscription are rejected.
SystemReadinessCategory	The readiness state reported for a single provider-defined category.
SystemReadinessOperationsGetOptionalParams	Optional parameters.
SystemReadinessOperationsOperations	Interface representing a SystemReadinessOperations operations.
SystemReadinessProperties	The readiness state of the Azure Local Disconnected Operations (ALDO) system. All fields are computed by the resource provider and are read-only.

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownCreatedByType	The kind of entity that created the resource.
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownVersions	The available API versions.

Functions

isRestError(unknown)

Typeguard for RestError

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e is RestError

Parameters

e

unknown

Something caught by a catch clause.

Returns

e is RestError

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor