@azure/arm-edgezones package

Classes

EdgeZonesClient

Interfaces

EdgeZonesClientOptionalParams	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.
ExtendedZone	Resource that represents an Azure Extended Zone available to a subscription for registering and unregistering.
ExtendedZoneProperties	The properties of an Extended Zone resource.
ExtendedZonesGetOptionalParams	Optional parameters.
ExtendedZonesListBySubscriptionOptionalParams	Optional parameters.
ExtendedZonesOperations	Interface representing a ExtendedZones operations.
ExtendedZonesRegisterOptionalParams	Optional parameters.
ExtendedZonesUnregisterOptionalParams	Optional parameters.
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.

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.
ProvisioningState	The status of the current operation. 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: Provisioning State Updating: Updating State Deleting: Deleting State Accepted: Accepted State
RegistrationState	The Azure Extended Zone registration status for a subscription KnownRegistrationState can be used interchangeably with RegistrationState, this enum contains the known values that the service supports. Known values supported by the service NotRegistered: Subscription not registered for the Azure Extended Zone PendingRegister: Subscription pending registration for the Azure Extended Zone Registered: Subscription is registered for the Azure Extended Zone PendingUnregister: Subscription is pending unregistering for the Azure Extended Zone

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"
KnownProvisioningState	The status of the current operation.
KnownRegistrationState	The Azure Extended Zone registration status for a subscription
KnownVersions	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

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor