@azure/arm-apicenter package

Classes

AzureAPICenter

Interfaces

AzureAPICenterOptionalParams

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

ManagedServiceIdentity

Managed service identity (system assigned and/or user assigned identities)

Operation

Details of a REST API operation, returned from the Resource Provider Operations API

OperationDisplay

Localized display information for this particular operation.

OperationListResult

A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.

Operations

Interface representing a Operations.

OperationsListNextOptionalParams

Optional parameters.

OperationsListOptionalParams

Optional parameters.

Resource

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

Service

The service entity.

ServiceCollection

The response of a Service list operation.

ServiceUpdate

The service properties to be updated.

Services

Interface representing a Services.

ServicesCreateOrUpdateOptionalParams

Optional parameters.

ServicesDeleteOptionalParams

Optional parameters.

ServicesGetOptionalParams

Optional parameters.

ServicesListByResourceGroupNextOptionalParams

Optional parameters.

ServicesListByResourceGroupOptionalParams

Optional parameters.

ServicesListBySubscriptionNextOptionalParams

Optional parameters.

ServicesListBySubscriptionOptionalParams

Optional parameters.

ServicesUpdateOptionalParams

Optional parameters.

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'

UserAssignedIdentity

User assigned identity properties

Type Aliases

ActionType

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

Known values supported by the service

Internal

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

ManagedServiceIdentityType

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

Known values supported by the service

None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

OperationsListNextResponse

Contains response data for the listNext operation.

OperationsListResponse

Contains response data for the list operation.

Origin

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

Known values supported by the service

user
system
user,system

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

Succeeded
Failed
Canceled

ServicesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.

ServicesGetResponse

Contains response data for the get operation.

ServicesListByResourceGroupNextResponse

Contains response data for the listByResourceGroupNext operation.

ServicesListByResourceGroupResponse

Contains response data for the listByResourceGroup operation.

ServicesListBySubscriptionNextResponse

Contains response data for the listBySubscriptionNext operation.

ServicesListBySubscriptionResponse

Contains response data for the listBySubscription operation.

ServicesUpdateResponse

Contains response data for the update operation.

Enums

KnownActionType

Known values of ActionType that the service accepts.

KnownCreatedByType

Known values of CreatedByType that the service accepts.

KnownManagedServiceIdentityType

Known values of ManagedServiceIdentityType that the service accepts.

KnownOrigin

Known values of Origin that the service accepts.

KnownProvisioningState

Known values of ProvisioningState that the service accepts.

Functions

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

Function Details

getContinuationToken(unknown)

Given the last .value produced by the byPage iterator, returns a continuation token that can be used to begin paging from that point later.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

An object from accessing value on the IteratorResult from a byPage iterator.

Returns

string | undefined

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