Share via

@azure/arm-apicenter package

Classes

AzureAPICenter

Interfaces

Api

API entity.
ApiDefinition

API definition entity.
ApiDefinitionListResult

The response of a ApiDefinition list operation.
ApiDefinitionProperties

API definition properties entity.
ApiDefinitionPropertiesSpecification

API specification details.
ApiDefinitions

Interface representing a ApiDefinitions.
ApiDefinitionsCreateOrUpdateHeaders

Defines headers for ApiDefinitions_createOrUpdate operation.
ApiDefinitionsCreateOrUpdateOptionalParams

Optional parameters.
ApiDefinitionsDeleteOptionalParams

Optional parameters.
ApiDefinitionsExportSpecificationHeaders

Defines headers for ApiDefinitions_exportSpecification operation.
ApiDefinitionsExportSpecificationOptionalParams

Optional parameters.
ApiDefinitionsGetHeaders

Defines headers for ApiDefinitions_get operation.
ApiDefinitionsGetOptionalParams

Optional parameters.
ApiDefinitionsHeadOptionalParams

Optional parameters.
ApiDefinitionsImportSpecificationHeaders

Defines headers for ApiDefinitions_importSpecification operation.
ApiDefinitionsImportSpecificationOptionalParams

Optional parameters.
ApiDefinitionsListNextOptionalParams

Optional parameters.
ApiDefinitionsListOptionalParams

Optional parameters.
ApiListResult

The response of a Api list operation.
ApiProperties

API properties.
ApiSpecExportResult

The API specification export result.
ApiSpecImportRequest

The API specification source entity properties.
ApiSpecImportRequestSpecification

API specification details.
ApiVersion

API version entity.
ApiVersionListResult

The response of a ApiVersion list operation.
ApiVersionProperties

API version properties entity.
ApiVersions

Interface representing a ApiVersions.
ApiVersionsCreateOrUpdateHeaders

Defines headers for ApiVersions_createOrUpdate operation.
ApiVersionsCreateOrUpdateOptionalParams

Optional parameters.
ApiVersionsDeleteOptionalParams

Optional parameters.
ApiVersionsGetHeaders

Defines headers for ApiVersions_get operation.
ApiVersionsGetOptionalParams

Optional parameters.
ApiVersionsHeadOptionalParams

Optional parameters.
ApiVersionsListNextOptionalParams

Optional parameters.
ApiVersionsListOptionalParams

Optional parameters.
Apis

Interface representing a Apis.
ApisCreateOrUpdateHeaders

Defines headers for Apis_createOrUpdate operation.
ApisCreateOrUpdateOptionalParams

Optional parameters.
ApisDeleteOptionalParams

Optional parameters.
ApisGetHeaders

Defines headers for Apis_get operation.
ApisGetOptionalParams

Optional parameters.
ApisHeadOptionalParams

Optional parameters.
ApisListNextOptionalParams

Optional parameters.
ApisListOptionalParams

Optional parameters.
AzureAPICenterOptionalParams

Optional parameters.
Contact

Contact information
Deployment

API deployment entity.
DeploymentListResult

The response of a Deployment list operation.
DeploymentProperties

API deployment entity properties.
DeploymentServer

Server
Deployments

Interface representing a Deployments.
DeploymentsCreateOrUpdateHeaders

Defines headers for Deployments_createOrUpdate operation.
DeploymentsCreateOrUpdateOptionalParams

Optional parameters.
DeploymentsDeleteOptionalParams

Optional parameters.
DeploymentsGetHeaders

Defines headers for Deployments_get operation.
DeploymentsGetOptionalParams

Optional parameters.
DeploymentsHeadOptionalParams

Optional parameters.
DeploymentsListNextOptionalParams

Optional parameters.
DeploymentsListOptionalParams

Optional parameters.
Environment

Environment entity.
EnvironmentListResult

The response of a Environment list operation.
EnvironmentProperties

Environment properties entity.
EnvironmentServer

Server information of the environment.
Environments

Interface representing a Environments.
EnvironmentsCreateOrUpdateHeaders

Defines headers for Environments_createOrUpdate operation.
EnvironmentsCreateOrUpdateOptionalParams

Optional parameters.
EnvironmentsDeleteOptionalParams

Optional parameters.
EnvironmentsGetHeaders

Defines headers for Environments_get operation.
EnvironmentsGetOptionalParams

Optional parameters.
EnvironmentsHeadOptionalParams

Optional parameters.
EnvironmentsListNextOptionalParams

Optional parameters.
EnvironmentsListOptionalParams

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

Additional, external documentation for the API.
License

The license information for the API.
ManagedServiceIdentity

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

Assignment metadata
MetadataSchema

Metadata schema entity. Used to define metadata for the entities in API catalog.
MetadataSchemaExportRequest

The metadata schema export request.
MetadataSchemaExportResult

The metadata schema export result.
MetadataSchemaListResult

The response of a MetadataSchema list operation.
MetadataSchemaProperties

Metadata schema properties.
MetadataSchemas

Interface representing a MetadataSchemas.
MetadataSchemasCreateOrUpdateHeaders

Defines headers for MetadataSchemas_createOrUpdate operation.
MetadataSchemasCreateOrUpdateOptionalParams

Optional parameters.
MetadataSchemasDeleteOptionalParams

Optional parameters.
MetadataSchemasGetHeaders

Defines headers for MetadataSchemas_get operation.
MetadataSchemasGetOptionalParams

Optional parameters.
MetadataSchemasHeadOptionalParams

Optional parameters.
MetadataSchemasListNextOptionalParams

Optional parameters.
MetadataSchemasListOptionalParams

Optional parameters.
Onboarding

Onboarding information
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.
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
Service

The service entity.
ServiceListResult

The response of a Service list operation.
ServiceProperties

The properties of the service.
ServiceUpdate

The type used for update operations of the Service.
Services

Interface representing a Services.
ServicesCreateOrUpdateOptionalParams

Optional parameters.
ServicesDeleteOptionalParams

Optional parameters.
ServicesExportMetadataSchemaHeaders

Defines headers for Services_exportMetadataSchema operation.
ServicesExportMetadataSchemaOptionalParams

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

Terms of service for the API.
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
Workspace

Workspace entity.
WorkspaceListResult

The response of a Workspace list operation.
WorkspaceProperties

Workspace properties.
Workspaces

Interface representing a Workspaces.
WorkspacesCreateOrUpdateHeaders

Defines headers for Workspaces_createOrUpdate operation.
WorkspacesCreateOrUpdateOptionalParams

Optional parameters.
WorkspacesDeleteOptionalParams

Optional parameters.
WorkspacesGetHeaders

Defines headers for Workspaces_get operation.
WorkspacesGetOptionalParams

Optional parameters.
WorkspacesHeadOptionalParams

Optional parameters.
WorkspacesListNextOptionalParams

Optional parameters.
WorkspacesListOptionalParams

Optional parameters.

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
ApiDefinitionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
ApiDefinitionsExportSpecificationResponse

Contains response data for the exportSpecification operation.
ApiDefinitionsGetResponse

Contains response data for the get operation.
ApiDefinitionsHeadResponse

Contains response data for the head operation.
ApiDefinitionsListNextResponse

Contains response data for the listNext operation.
ApiDefinitionsListResponse

Contains response data for the list operation.
ApiKind

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

Known values supported by the service

rest: A Representational State Transfer Api
graphql: A Graph query language Api
grpc: A gRPC Api
soap: A SOAP Api
webhook: Web Hook
websocket: Web Socket
ApiSpecExportResultFormat

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

Known values supported by the service

inline: The inlined content of a specification document.
link: The link to the result of the export operation. The URL is valid for 5 minutes.
ApiSpecImportSourceFormat

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

Known values supported by the service

inline: The inlined content of a specification document.
link: The link to a specification document hosted on a publicly accessible internet address.
ApiVersionsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
ApiVersionsGetResponse

Contains response data for the get operation.
ApiVersionsHeadResponse

Contains response data for the head operation.
ApiVersionsListNextResponse

Contains response data for the listNext operation.
ApiVersionsListResponse

Contains response data for the list operation.
ApisCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
ApisGetResponse

Contains response data for the get operation.
ApisHeadResponse

Contains response data for the head operation.
ApisListNextResponse

Contains response data for the listNext operation.
ApisListResponse

Contains response data for the list operation.
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
DeploymentState

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

Known values supported by the service

active: Active State
inactive: Inactive State
DeploymentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
DeploymentsGetResponse

Contains response data for the get operation.
DeploymentsHeadResponse

Contains response data for the head operation.
DeploymentsListNextResponse

Contains response data for the listNext operation.
DeploymentsListResponse

Contains response data for the list operation.
EnvironmentKind

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

Known values supported by the service

development: Development environment
testing: Testing environment
staging: Staging environment
production: Production environment
EnvironmentServerType

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

Known values supported by the service

Azure API Management: Api Management Server
Azure compute service: Compute server
Apigee API Management: Apigee server
AWS API Gateway: AWS Api Gateway server
Kong API Gateway: Kong API Gateway server
Kubernetes: Kubernetes server
MuleSoft API Management: Mulesoft Api Management server
EnvironmentsCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
EnvironmentsGetResponse

Contains response data for the get operation.
EnvironmentsHeadResponse

Contains response data for the head operation.
EnvironmentsListNextResponse

Contains response data for the listNext operation.
EnvironmentsListResponse

Contains response data for the list operation.
LifecycleStage

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

Known values supported by the service

design: design stage
development: development stage
testing: testing stage
preview: In preview
production: In production
deprecated: deprecated stage
retired: Retired stage
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
MetadataAssignmentEntity

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

Known values supported by the service

api: Assigned to API
environment: Assigned to Environment
deployment: Assigned to Deployment
MetadataSchemaExportFormat

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

Known values supported by the service

inline: The inlined content of a schema document.
link: The link to a schema document. The URL is valid for 5 minutes.
MetadataSchemasCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
MetadataSchemasGetResponse

Contains response data for the get operation.
MetadataSchemasHeadResponse

Contains response data for the head operation.
MetadataSchemasListNextResponse

Contains response data for the listNext operation.
MetadataSchemasListResponse

Contains response data for the list operation.
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: Resource has been created.
Failed: Resource creation failed.
Canceled: Resource creation was canceled.
ServicesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
ServicesExportMetadataSchemaResponse

Contains response data for the exportMetadataSchema 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.
Versions

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

Known values supported by the service

2024-03-01: The initial service version
WorkspacesCreateOrUpdateResponse

Contains response data for the createOrUpdate operation.
WorkspacesGetResponse

Contains response data for the get operation.
WorkspacesHeadResponse

Contains response data for the head operation.
WorkspacesListNextResponse

Contains response data for the listNext operation.
WorkspacesListResponse

Contains response data for the list operation.

Enums

KnownActionType

Known values of ActionType that the service accepts.
KnownApiKind

Known values of ApiKind that the service accepts.
KnownApiSpecExportResultFormat

Known values of ApiSpecExportResultFormat that the service accepts.
KnownApiSpecImportSourceFormat

Known values of ApiSpecImportSourceFormat that the service accepts.
KnownCreatedByType

Known values of CreatedByType that the service accepts.
KnownDeploymentState

Known values of DeploymentState that the service accepts.
KnownEnvironmentKind

Known values of EnvironmentKind that the service accepts.
KnownEnvironmentServerType

Known values of EnvironmentServerType that the service accepts.
KnownLifecycleStage

Known values of LifecycleStage that the service accepts.
KnownManagedServiceIdentityType

Known values of ManagedServiceIdentityType that the service accepts.
KnownMetadataAssignmentEntity

Known values of MetadataAssignmentEntity that the service accepts.
KnownMetadataSchemaExportFormat

Known values of MetadataSchemaExportFormat that the service accepts.
KnownOrigin

Known values of Origin that the service accepts.
KnownProvisioningState

Known values of ProvisioningState that the service accepts.
KnownVersions

Known values of Versions 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.