@azure/arm-powerplatform package

Classes

PowerPlatformClient

Interfaces

Account	Definition of the account.
AccountProperties	The properties that define configuration for the account.
AccountsCreateOrUpdateOptionalParams	Optional parameters.
AccountsDeleteOptionalParams	Optional parameters.
AccountsGetOptionalParams	Optional parameters.
AccountsListByResourceGroupOptionalParams	Optional parameters.
AccountsListBySubscriptionOptionalParams	Optional parameters.
AccountsOperations	Interface representing a Accounts operations.
AccountsUpdateOptionalParams	Optional parameters.
EnterprisePoliciesCreateOrUpdateOptionalParams	Optional parameters.
EnterprisePoliciesDeleteOptionalParams	Optional parameters.
EnterprisePoliciesGetOptionalParams	Optional parameters.
EnterprisePoliciesListByResourceGroupOptionalParams	Optional parameters.
EnterprisePoliciesListBySubscriptionOptionalParams	Optional parameters.
EnterprisePoliciesOperations	Interface representing a EnterprisePolicies operations.
EnterprisePoliciesUpdateOptionalParams	Optional parameters.
EnterprisePolicy	Definition of the EnterprisePolicy.
EnterprisePolicyIdentity	The identity of the EnterprisePolicy.
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.
KeyProperties	Url and version of the KeyVault Secret
KeyVaultProperties	Settings concerning key vault encryption for a configuration store.
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.
PatchAccount	Definition of the account.
PatchEnterprisePolicy	Definition of the EnterprisePolicy.
PatchTrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
PowerPlatformClientOptionalParams	Optional parameters for the client.
PrivateEndpoint	The private endpoint resource.
PrivateEndpointConnection	A private endpoint connection
PrivateEndpointConnectionProperties	Properties of the private endpoint connection.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Optional parameters.
PrivateEndpointConnectionsDeleteOptionalParams	Optional parameters.
PrivateEndpointConnectionsGetOptionalParams	Optional parameters.
PrivateEndpointConnectionsListByEnterprisePolicyOptionalParams	Optional parameters.
PrivateEndpointConnectionsOperations	Interface representing a PrivateEndpointConnections operations.
PrivateLinkResource	A private link resource
PrivateLinkResourceProperties	Properties of a private link resource.
PrivateLinkResourcesGetOptionalParams	Optional parameters.
PrivateLinkResourcesListByEnterprisePolicyOptionalParams	Optional parameters.
PrivateLinkResourcesOperations	Interface representing a PrivateLinkResources operations.
PrivateLinkServiceConnectionState	A collection of information about the state of the connection between service consumer and provider.
Properties	The properties that define configuration for the enterprise policy.
PropertiesEncryption	The encryption settings for a configuration store.
PropertiesLockbox	Settings concerning lockbox.
PropertiesNetworkInjection	Settings concerning network injection.
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
SubnetProperties	Properties of a subnet.
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'
VirtualNetworkProperties	Settings concerning the virtual network.

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.
EnterprisePolicyKind	The Kind (type) of Enterprise Policy KnownEnterprisePolicyKind can be used interchangeably with EnterprisePolicyKind, this enum contains the known values that the service supports. Known values supported by the service Lockbox: Lockbox PrivateEndpoint: PrivateEndpoint Encryption: Encryption NetworkInjection: NetworkInjection Identity: Identity
HealthStatus	The health status of the resource. KnownHealthStatus can be used interchangeably with HealthStatus, this enum contains the known values that the service supports. Known values supported by the service Undetermined: Undetermined Healthy: Healthy Warning: Warning Unhealthy: Unhealthy
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.
PrivateEndpointConnectionProvisioningState	The current provisioning state. KnownPrivateEndpointConnectionProvisioningState can be used interchangeably with PrivateEndpointConnectionProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Connection has been provisioned Creating: Connection is being created Deleting: Connection is being deleted Failed: Connection provisioning has failed
PrivateEndpointServiceConnectionStatus	The private endpoint connection status. KnownPrivateEndpointServiceConnectionStatus can be used interchangeably with PrivateEndpointServiceConnectionStatus, this enum contains the known values that the service supports. Known values supported by the service Pending: Connection waiting for approval or rejection Approved: Connection approved Rejected: Connection Rejected
ResourceIdentityType	The type of identity used for the EnterprisePolicy. Currently, the only supported type is 'SystemAssigned', which implicitly creates an identity.
State	The state of onboarding, which only appears in the response. KnownState can be used interchangeably with State, this enum contains the known values that the service supports. Known values supported by the service Enabled: Enabled Disabled: Disabled NotConfigured: NotConfigured

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.
KnownEnterprisePolicyKind	The Kind (type) of Enterprise Policy
KnownHealthStatus	The health status of 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"
KnownPrivateEndpointConnectionProvisioningState	The current provisioning state.
KnownPrivateEndpointServiceConnectionStatus	The private endpoint connection status.
KnownState	The state of onboarding, which only appears in the response.
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

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