@azure/arm-enclave package

Classes

Interfaces

ApprovalActionRequest	Request body for calling post-action
ApprovalActionResponse	Response body after handling of approvalCallbackRequest
ApprovalCallbackRequest	Request body for calling post-action
ApprovalCreateOrUpdateOptionalParams	Optional parameters.
ApprovalDeleteOptionalParams	Optional parameters.
ApprovalDeletionCallbackRequest	Request body for calling post-action
ApprovalGetOptionalParams	Optional parameters.
ApprovalListByParentOptionalParams	Optional parameters.
ApprovalNotifyInitiatorOptionalParams	Optional parameters.
ApprovalOperations	Interface representing a Approval operations.
ApprovalPatchModel	Approvals patch model.
ApprovalPatchProperties	Approvals patch properties.
ApprovalProperties	Approval Base model.
ApprovalResource	Approval Model Resource
ApprovalSettingConfiguration	Granular approval setting configuration with policy, minimum approvers, and mandatory approvers.
ApprovalSettings	Granular ApprovalSettings Properties for 2025-11-01-preview and later versions
ApprovalSettingsPatchProperties	Granular ApprovalSettings Patch Properties
ApprovalUpdateOptionalParams	Optional parameters.
Approver	Approver Metadata for approvals request.
CheckAddressSpaceAvailabilityRequest	Request to the action call to check address space availability.
CheckAddressSpaceAvailabilityResponse	Response of availability of the requested address space.
CommunityCheckAddressSpaceAvailabilityOptionalParams	Optional parameters.
CommunityCreateOrUpdateOptionalParams	Optional parameters.
CommunityDeleteOptionalParams	Optional parameters.
CommunityEndpointDestinationRule	Base type for destination rules.
CommunityEndpointPatchModel	Community Endpoint Patch Resource
CommunityEndpointPatchProperties	Community Endpoint patchable Properties
CommunityEndpointProperties	Community Endpoint Resource properties
CommunityEndpointResource	CommunityEndpoint Model Resource
CommunityEndpointsCreateOrUpdateOptionalParams	Optional parameters.
CommunityEndpointsDeleteOptionalParams	Optional parameters.
CommunityEndpointsGetOptionalParams	Optional parameters.
CommunityEndpointsHandleApprovalCreationOptionalParams	Optional parameters.
CommunityEndpointsHandleApprovalDeletionOptionalParams	Optional parameters.
CommunityEndpointsListByCommunityResourceOptionalParams	Optional parameters.
CommunityEndpointsListBySubscriptionOptionalParams	Optional parameters.
CommunityEndpointsOperations	Interface representing a CommunityEndpoints operations.
CommunityEndpointsUpdateOptionalParams	Optional parameters.
CommunityGetOptionalParams	Optional parameters.
CommunityListByResourceGroupOptionalParams	Optional parameters.
CommunityListBySubscriptionOptionalParams	Optional parameters.
CommunityOperations	Interface representing a Community operations.
CommunityPatchModel	Community Patch Resource
CommunityPatchProperties	Community Resource Properties without default values
CommunityProperties	Community Resource Properties
CommunityResource	Community Model Resource
CommunityUpdateOptionalParams	Optional parameters.
DedicatedHubCreateOrUpdateOptionalParams	Optional parameters.
DedicatedHubDeleteOptionalParams	Optional parameters.
DedicatedHubGetOptionalParams	Optional parameters.
DedicatedHubListByCommunityResourceOptionalParams	Optional parameters.
DedicatedHubListBySubscriptionOptionalParams	Optional parameters.
DedicatedHubOperations	Interface representing a DedicatedHub operations.
DedicatedHubPatchModel	Dedicated Hub Patch Resource
DedicatedHubPatchProperties	Dedicated Hub patchable Properties
DedicatedHubProperties	Describes the properties of a Dedicated Hub.
DedicatedHubResource	DedicatedHub Model Resource
DedicatedHubUpdateOptionalParams	Optional parameters.
EnclaveAddressSpacesModel	Enclave Address Spaces
EnclaveConnectionCreateOrUpdateOptionalParams	Optional parameters.
EnclaveConnectionDeleteOptionalParams	Optional parameters.
EnclaveConnectionGetOptionalParams	Optional parameters.
EnclaveConnectionHandleApprovalCreationOptionalParams	Optional parameters.
EnclaveConnectionHandleApprovalDeletionOptionalParams	Optional parameters.
EnclaveConnectionListByResourceGroupOptionalParams	Optional parameters.
EnclaveConnectionListBySubscriptionOptionalParams	Optional parameters.
EnclaveConnectionOperations	Interface representing a EnclaveConnection operations.
EnclaveConnectionPatchModel	Enclave Connection Patch Resource
EnclaveConnectionPatchProperties	Enclave Connection patchable Properties
EnclaveConnectionProperties	Enclave Connection Resource properties
EnclaveConnectionResource	EnclaveConnection Model Resource
EnclaveConnectionUpdateOptionalParams	Optional parameters.
EnclaveDefaultSettingsModel	Virtual Enclave Default Settings
EnclaveDefaultSettingsPatchModel	Virtual Enclave Default Settings
EnclaveEndpointDestinationRule	Enclave Endpoint Rule Properties
EnclaveEndpointPatchModel	Enclave Endpoint Patch Resource
EnclaveEndpointPatchProperties	Enclave Endpoint patchable Properties
EnclaveEndpointProperties	Enclave Endpoint Resource properties
EnclaveEndpointResource	EnclaveEndpoint Model Resource
EnclaveEndpointsCreateOrUpdateOptionalParams	Optional parameters.
EnclaveEndpointsDeleteOptionalParams	Optional parameters.
EnclaveEndpointsGetOptionalParams	Optional parameters.
EnclaveEndpointsHandleApprovalCreationOptionalParams	Optional parameters.
EnclaveEndpointsHandleApprovalDeletionOptionalParams	Optional parameters.
EnclaveEndpointsListByEnclaveResourceOptionalParams	Optional parameters.
EnclaveEndpointsListBySubscriptionOptionalParams	Optional parameters.
EnclaveEndpointsOperations	Interface representing a EnclaveEndpoints operations.
EnclaveEndpointsUpdateOptionalParams	Optional parameters.
EnclaveResource	Virtual Enclave Model Resource
EnclaveVirtualNetworkModel	Enclave Virtual Network Properties
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.
ExtensionResource	The base extension resource.
GovernedServiceItem	GovernedServiceItem Properties
MaintenanceModeConfigurationModel	Maintenance Mode
MaintenanceModeConfigurationPatchModel	Maintenance Mode Patch Model
ManagedOnBehalfOfConfiguration	Managed-On-Behalf-Of configuration properties. This configuration exists for the resources where a resource provider manages those resources on behalf of the resource owner.
ManagedServiceIdentity	Managed service identity (system assigned and/or user assigned identities)
MandatoryApprover	Approver Metadata for approvals request.
MissionClientOptionalParams	Optional parameters for the client.
MoboBrokerResource	Managed-On-Behalf-Of broker resource. This resource is created by the Resource Provider to manage some resources on behalf of the user.
MonitoringDestination	Monitoring destination configuration with multiple workspaces
MonitoringDestinationPatchModel	Monitoring Destination Patch Model
MonitoringSettingsModel	Monitoring Settings
MonitoringSettingsPatchModel	Monitoring Settings Patch Model
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.
Principal	Principal for maintenance mode or role assignments
RequestMetadata	Request Metadata for approvals request.
RequestMetadataUpdatableProperties	Request Metadata patch properties.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
RoleAssignmentItem	Role assignment item that indicates which principals should be assigned this role definition
SubnetConfiguration	Subnet Configuration
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'
TransitHubCreateOrUpdateOptionalParams	Optional parameters.
TransitHubDeleteOptionalParams	Optional parameters.
TransitHubGetOptionalParams	Optional parameters.
TransitHubListByCommunityResourceOptionalParams	Optional parameters.
TransitHubListBySubscriptionOptionalParams	Optional parameters.
TransitHubOperations	Interface representing a TransitHub operations.
TransitHubPatchModel	TH Patch Resource
TransitHubPatchProperties	Transit Hub patchable Properties
TransitHubProperties	Describes the properties of an Transit Hub.
TransitHubResource	TransitHub Model Resource
TransitHubUpdateOptionalParams	Optional parameters.
TransitOption	TransitOption Properties
TransitOptionParams	TransitOptionParams Properties
UserAssignedIdentity	User assigned identity properties
VirtualEnclaveApprovalSettings	Virtual Enclave ApprovalSettings Properties for 2025-11-01-preview and later versions
VirtualEnclaveApprovalSettingsPatchProperties	Virtual Enclave ApprovalSettings Patch Properties
VirtualEnclaveCreateOrUpdateOptionalParams	Optional parameters.
VirtualEnclaveDeleteOptionalParams	Optional parameters.
VirtualEnclaveGetOptionalParams	Optional parameters.
VirtualEnclaveHandleApprovalCreationOptionalParams	Optional parameters.
VirtualEnclaveHandleApprovalDeletionOptionalParams	Optional parameters.
VirtualEnclaveListByResourceGroupOptionalParams	Optional parameters.
VirtualEnclaveListBySubscriptionOptionalParams	Optional parameters.
VirtualEnclaveOperations	Interface representing a VirtualEnclave operations.
VirtualEnclavePatchModel	Virtual Enclave Patch Model
VirtualEnclavePatchProperties	Virtual Enclave Patchable Properties
VirtualEnclaveProperties	Virtual Enclave Resource properties
VirtualEnclaveUpdateOptionalParams	Optional parameters.
WorkloadCreateOrUpdateOptionalParams	Optional parameters.
WorkloadDeleteOptionalParams	Optional parameters.
WorkloadGetOptionalParams	Optional parameters.
WorkloadListByEnclaveResourceOptionalParams	Optional parameters.
WorkloadListBySubscriptionOptionalParams	Optional parameters.
WorkloadOperations	Interface representing a Workload operations.
WorkloadPatchModel	Workload Patch Resource
WorkloadPatchProperties	Workload patchable Properties
WorkloadProperties	Workload Resource properties
WorkloadResource	Workload Model Resource
WorkloadUpdateOptionalParams	Optional parameters.

Type Aliases

ActionPerformed	Specifies the action performed by the approver KnownActionPerformed can be used interchangeably with ActionPerformed, this enum contains the known values that the service supports. Known values supported by the service Approved: Action was Approved Rejected: Action was Rejected
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.
ApprovalPolicy	Approval Policy. KnownApprovalPolicy can be used interchangeably with ApprovalPolicy, this enum contains the known values that the service supports. Known values supported by the service Required: Approval will be required for the specified action. NotRequired: Approval will not be required for the specified action.
ApprovalStatus	Approval Status. It can be Approved, Rejected, Pending, Deleted or Expired. KnownApprovalStatus can be used interchangeably with ApprovalStatus, this enum contains the known values that the service supports. Known values supported by the service Approved: ApprovalStatus Type Approved Rejected: ApprovalStatus Type Rejected Pending: ApprovalStatus Type Pending Deleted: ApprovalStatus Type Deleted Expired: ApprovalStatus Type Expired
AzureSupportedClouds	The supported values for cloud setting as a string literal type
CommunityEndpointProtocol	Community Endpoint Protocol Enum KnownCommunityEndpointProtocol can be used interchangeably with CommunityEndpointProtocol, this enum contains the known values that the service supports. Known values supported by the service ANY: CommunityEndpointProtocol Type ANY TCP: CommunityEndpointProtocol Type TCP UDP: CommunityEndpointProtocol Type UDP ICMP: CommunityEndpointProtocol Type ICMP ESP: CommunityEndpointProtocol Type ESP AH: CommunityEndpointProtocol Type AH HTTPS: CommunityEndpointProtocol Type HTTPS HTTP: CommunityEndpointProtocol Type HTTP
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.
Designation	Specifies the designation of the dedicated hub. KnownDesignation can be used interchangeably with Designation, this enum contains the known values that the service supports. Known values supported by the service Pooled: Designation Type Pooled Reserved: Designation Type Reserved
DestinationType	Destination Type Enum KnownDestinationType can be used interchangeably with DestinationType, this enum contains the known values that the service supports. Known values supported by the service FQDN: DestinationType Type FQDN FQDNTag: DestinationType Type FQDNTag IPAddress: DestinationType Type IPAddress PrivateNetwork: DestinationType Type PrivateNetwork ServiceTag: DestinationType Type ServiceTag
DiagnosticDestination	Specifies the destination of where to store diagnostic logs. KnownDiagnosticDestination can be used interchangeably with DiagnosticDestination, this enum contains the known values that the service supports. Known values supported by the service CommunityOnly: DiagnosticDestination Type CommunityOnly EnclaveOnly: DiagnosticDestination Type EnclaveOnly Both: DiagnosticDestination Type Both
EnclaveConnectionState	Specifies the state of the enclave connection. KnownEnclaveConnectionState can be used interchangeably with EnclaveConnectionState, this enum contains the known values that the service supports. Known values supported by the service PendingApproval: EnclaveConnectionState Type Pending Approval PendingUpdate: EnclaveConnectionState Type Pending Update Approved: EnclaveConnectionState Type Approved Active: EnclaveConnectionState Type Active Failed: EnclaveConnectionState Type Failed Connected: EnclaveConnectionState Type Connected Disconnected: EnclaveConnectionState Type Disconnected
EnclaveEndpointProtocol	Enclave Endpoint Protocol Enum KnownEnclaveEndpointProtocol can be used interchangeably with EnclaveEndpointProtocol, this enum contains the known values that the service supports. Known values supported by the service ANY: EndpointProtocol Type ANY TCP: EndpointProtocol Type TCP UDP: EndpointProtocol Type UDP ICMP: EndpointProtocol Type ICMP ESP: EndpointProtocol Type ESP AH: EndpointProtocol Type AH
FirewallSKU	Azure Firewall SKU KnownFirewallSKU can be used interchangeably with FirewallSKU, this enum contains the known values that the service supports. Known values supported by the service Basic: FirewallSKU Basic Standard: FirwallSKU Standard Premium: FirewallSKU Premium
ManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). KnownManagedServiceIdentityType can be used interchangeably with ManagedServiceIdentityType, this enum contains the known values that the service supports. Known values supported by the service None: No managed identity. SystemAssigned: System assigned managed identity. UserAssigned: User assigned managed identity. SystemAssigned,UserAssigned: System and user assigned managed identity.
MonitoringDestinationType	List of destination types for monitoring logs KnownMonitoringDestinationType can be used interchangeably with MonitoringDestinationType, this enum contains the known values that the service supports. Known values supported by the service CommunityWorkspace: MonitoringDestinationType Type CommunityWorkspace EnclaveWorkspace: MonitoringDestinationType Type EnclaveWorkspace CustomWorkspace: MonitoringDestinationType Type CustomWorkspace
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 provisioning status of the resource. 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. Accepted: Provisioning State Type Accepted Creating: Provisioning State Type Creating Deleting: Provisioning State Type Deleting NotSpecified: Provisioning State Type NotSpecified Running: Provisioning State Type Running Updating: Provisioning State Type Updating
RbacInheritanceMode	Rbac Inheritance Mode KnownRbacInheritanceMode can be used interchangeably with RbacInheritanceMode, this enum contains the known values that the service supports. Known values supported by the service Enabled: RbacInheritanceMode Type Enabled Disabled: RbacInheritanceMode Type Disabled
ResourceVisibilityMode	Resource Visibility Mode KnownResourceVisibilityMode can be used interchangeably with ResourceVisibilityMode, this enum contains the known values that the service supports. Known values supported by the service Enabled: ResourceVisibilityMode Type Enabled Disabled: ResourceVisibilityMode Type Disabled
SecurityProvider	Specifies the security provider for the transit hub. KnownSecurityProvider can be used interchangeably with SecurityProvider, this enum contains the known values that the service supports. Known values supported by the service None: No security provider AzureFirewall: Azure Firewall security provider
ServiceIdentifier	Identifier for governed services. KnownServiceIdentifier can be used interchangeably with ServiceIdentifier, this enum contains the known values that the service supports. Known values supported by the service AKS: Service identifier for AKS AppService: Service identifier for App Service AzureFirewalls: Service identifier for Azure Firewalls ContainerRegistry: Service identifier for Container Registry CosmosDB: Service identifier for CosmosDB DataConnectors: Service identifier for Data Connectors Insights: Service identifier for Insights KeyVault: Service identifier for Key Vault Logic: Service identifier for Logic MicrosoftSQL: Service identifier for Microsoft SQL Monitoring: Service identifier for Monitoring PostgreSQL: Service identifier for PostgreSQL PrivateDNSZones: Service identifier for Private DNS Zones ServiceBus: Service identifier for Service Bus Storage: Service identifier for Storage
TransitHubState	Specifies the state of the transitHub. KnownTransitHubState can be used interchangeably with TransitHubState, this enum contains the known values that the service supports. Known values supported by the service PendingApproval: TransitHubState Type PendingApproval Approved: TransitHubState Type Approved PendingUpdate: TransitHubState Type PendingUpdate Active: TransitHubState Type Active Failed: TransitHubState Type Failed
TransitOptionType	Specifies the type of the transitOption. KnownTransitOptionType can be used interchangeably with TransitOptionType, this enum contains the known values that the service supports. Known values supported by the service ExpressRoute: TransitOptionType ExpressRoute Gateway: TransitOptionType Gateway Peering: TransitOptionType Peering
UpdateMode	Update Mode KnownUpdateMode can be used interchangeably with UpdateMode, this enum contains the known values that the service supports. Known values supported by the service Automatic: UpdateMode Type Automatic Manual: UpdateMode Type Manual

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionPerformed	Specifies the action performed by the approver
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownApprovalPolicy	Approval Policy.
KnownApprovalStatus	Approval Status. It can be Approved, Rejected, Pending, Deleted or Expired.
KnownCommunityEndpointProtocol	Community Endpoint Protocol Enum
KnownCreatedByType	The kind of entity that created the resource.
KnownDesignation	Specifies the designation of the dedicated hub.
KnownDestinationType	Destination Type Enum
KnownDiagnosticDestination	Specifies the destination of where to store diagnostic logs.
KnownEnclaveConnectionState	Specifies the state of the enclave connection.
KnownEnclaveEndpointProtocol	Enclave Endpoint Protocol Enum
KnownFirewallSKU	Azure Firewall SKU
KnownManagedServiceIdentityType	Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
KnownMonitoringDestinationType	List of destination types for monitoring logs
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 provisioning status of the resource.
KnownRbacInheritanceMode	Rbac Inheritance Mode
KnownResourceVisibilityMode	Resource Visibility Mode
KnownSecurityProvider	Specifies the security provider for the transit hub.
KnownServiceIdentifier	Identifier for governed services.
KnownTransitHubState	Specifies the state of the transitHub.
KnownTransitOptionType	Specifies the type of the transitOption.
KnownUpdateMode	Update Mode
KnownVersions	Supported API versions for the Microsoft.Mission resource provider.

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(MissionClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e: unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(MissionClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: MissionClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client: MissionClient

serializedState: string

sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>

options: RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor

@azure/arm-enclave package

Classes

Interfaces

Type Aliases

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Known values supported by the service

Enums

Functions

Variables

Function Details

isRestError(unknown)

Parameters

Returns

restorePoller<TResponse, TResult>(MissionClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Parameters

Returns

Variable Details

RestError

Type

Feedback