Delen via


@azure/arm-apicenter package

Klassen

AzureAPICenter

Interfaces

Api

API-entiteit.

ApiDefinition

API-definitie-entiteit.

ApiDefinitionListResult

Het antwoord van een ApiDefinition-lijstbewerking.

ApiDefinitionProperties

Entiteit api-definitie-eigenschappen.

ApiDefinitionPropertiesSpecification

Api-specificatiedetails.

ApiDefinitions

Interface die een ApiDefinitions vertegenwoordigt.

ApiDefinitionsCreateOrUpdateHeaders

Definieert headers voor ApiDefinitions_createOrUpdate bewerking.

ApiDefinitionsCreateOrUpdateOptionalParams

Optionele parameters.

ApiDefinitionsDeleteOptionalParams

Optionele parameters.

ApiDefinitionsExportSpecificationHeaders

Definieert headers voor ApiDefinitions_exportSpecification bewerking.

ApiDefinitionsExportSpecificationOptionalParams

Optionele parameters.

ApiDefinitionsGetHeaders

Definieert headers voor ApiDefinitions_get bewerking.

ApiDefinitionsGetOptionalParams

Optionele parameters.

ApiDefinitionsHeadOptionalParams

Optionele parameters.

ApiDefinitionsImportSpecificationHeaders

Definieert headers voor ApiDefinitions_importSpecification bewerking.

ApiDefinitionsImportSpecificationOptionalParams

Optionele parameters.

ApiDefinitionsListNextOptionalParams

Optionele parameters.

ApiDefinitionsListOptionalParams

Optionele parameters.

ApiListResult

Het antwoord van een API-lijstbewerking.

ApiProperties

API-eigenschappen.

ApiSpecExportResult

Het exportresultaat van de API-specificatie.

ApiSpecImportRequest

De eigenschappen van de bronentiteit van de API-specificatie.

ApiSpecImportRequestSpecification

Api-specificatiedetails.

ApiVersion

API-versie-entiteit.

ApiVersionListResult

Het antwoord van een ApiVersion-lijstbewerking.

ApiVersionProperties

Entiteit eigenschappen van API-versie.

ApiVersions

Interface die een ApiVersions vertegenwoordigt.

ApiVersionsCreateOrUpdateHeaders

Definieert headers voor ApiVersions_createOrUpdate bewerking.

ApiVersionsCreateOrUpdateOptionalParams

Optionele parameters.

ApiVersionsDeleteOptionalParams

Optionele parameters.

ApiVersionsGetHeaders

Definieert headers voor ApiVersions_get bewerking.

ApiVersionsGetOptionalParams

Optionele parameters.

ApiVersionsHeadOptionalParams

Optionele parameters.

ApiVersionsListNextOptionalParams

Optionele parameters.

ApiVersionsListOptionalParams

Optionele parameters.

Apis

Interface die een API's vertegenwoordigt.

ApisCreateOrUpdateHeaders

Definieert headers voor Apis_createOrUpdate bewerking.

ApisCreateOrUpdateOptionalParams

Optionele parameters.

ApisDeleteOptionalParams

Optionele parameters.

ApisGetHeaders

Definieert headers voor Apis_get bewerking.

ApisGetOptionalParams

Optionele parameters.

ApisHeadOptionalParams

Optionele parameters.

ApisListNextOptionalParams

Optionele parameters.

ApisListOptionalParams

Optionele parameters.

AzureAPICenterOptionalParams

Optionele parameters.

Contact

Contactgegevens

Deployment

API-implementatieentiteit.

DeploymentListResult

Het antwoord van een implementatielijstbewerking.

DeploymentProperties

Eigenschappen van API-implementatieentiteit.

DeploymentServer

Server

Deployments

Interface die een implementatie vertegenwoordigt.

DeploymentsCreateOrUpdateHeaders

Definieert headers voor Deployments_createOrUpdate bewerking.

DeploymentsCreateOrUpdateOptionalParams

Optionele parameters.

DeploymentsDeleteOptionalParams

Optionele parameters.

DeploymentsGetHeaders

Definieert headers voor Deployments_get bewerking.

DeploymentsGetOptionalParams

Optionele parameters.

DeploymentsHeadOptionalParams

Optionele parameters.

DeploymentsListNextOptionalParams

Optionele parameters.

DeploymentsListOptionalParams

Optionele parameters.

Environment

Omgevingsentiteit.

EnvironmentListResult

Het antwoord van een omgevingslijstbewerking.

EnvironmentProperties

Entiteit Omgevingseigenschappen.

EnvironmentServer

Servergegevens van de omgeving.

Environments

Interface die een omgeving vertegenwoordigt.

EnvironmentsCreateOrUpdateHeaders

Definieert headers voor Environments_createOrUpdate bewerking.

EnvironmentsCreateOrUpdateOptionalParams

Optionele parameters.

EnvironmentsDeleteOptionalParams

Optionele parameters.

EnvironmentsGetHeaders

Definieert headers voor Environments_get bewerking.

EnvironmentsGetOptionalParams

Optionele parameters.

EnvironmentsHeadOptionalParams

Optionele parameters.

EnvironmentsListNextOptionalParams

Optionele parameters.

EnvironmentsListOptionalParams

Optionele parameters.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

De foutdetails.

ErrorResponse

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

ExternalDocumentation

Aanvullende, externe documentatie voor de API.

License

De licentiegegevens voor de API.

ManagedServiceIdentity

Beheerde service-identiteit (door het systeem toegewezen en/of door de gebruiker toegewezen identiteiten)

MetadataAssignment

Metagegevens van toewijzing

MetadataSchema

Entiteit metagegevensschema. Wordt gebruikt voor het definiƫren van metagegevens voor de entiteiten in de API-catalogus.

MetadataSchemaExportRequest

De exportaanvraag voor het metagegevensschema.

MetadataSchemaExportResult

Het exportresultaat van het metagegevensschema.

MetadataSchemaListResult

Het antwoord van een metadataschema-lijstbewerking.

MetadataSchemaProperties

Eigenschappen van metagegevensschema's.

MetadataSchemas

Interface die een MetadataSchemas vertegenwoordigt.

MetadataSchemasCreateOrUpdateHeaders

Definieert headers voor MetadataSchemas_createOrUpdate bewerking.

MetadataSchemasCreateOrUpdateOptionalParams

Optionele parameters.

MetadataSchemasDeleteOptionalParams

Optionele parameters.

MetadataSchemasGetHeaders

Definieert headers voor MetadataSchemas_get bewerking.

MetadataSchemasGetOptionalParams

Optionele parameters.

MetadataSchemasHeadOptionalParams

Optionele parameters.

MetadataSchemasListNextOptionalParams

Optionele parameters.

MetadataSchemasListOptionalParams

Optionele parameters.

Onboarding

Informatie over onboarding

Operation

Details van een REST API-bewerking, geretourneerd door de Resource Provider Operations-API

OperationDisplay

Gelokaliseerde weergavegegevens voor deze specifieke bewerking.

OperationListResult

Een lijst met REST API-bewerkingen die worden ondersteund door een Azure-resourceprovider. Deze bevat een URL-koppeling om de volgende set resultaten op te halen.

Operations

Interface die een bewerking vertegenwoordigt.

OperationsListNextOptionalParams

Optionele parameters.

OperationsListOptionalParams

Optionele parameters.

ProxyResource

De definitie van het resourcemodel voor een Azure Resource Manager-proxyresource. Het heeft geen tags en een locatie

Resource

Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources

Service

De service-entiteit.

ServiceListResult

Het antwoord van een servicelijstbewerking.

ServiceProperties

De eigenschappen van de service.

ServiceUpdate

Het type dat wordt gebruikt voor updatebewerkingen van de service.

Services

Interface die een Services vertegenwoordigt.

ServicesCreateOrUpdateOptionalParams

Optionele parameters.

ServicesDeleteOptionalParams

Optionele parameters.

ServicesExportMetadataSchemaHeaders

Definieert headers voor Services_exportMetadataSchema bewerking.

ServicesExportMetadataSchemaOptionalParams

Optionele parameters.

ServicesGetOptionalParams

Optionele parameters.

ServicesListByResourceGroupNextOptionalParams

Optionele parameters.

ServicesListByResourceGroupOptionalParams

Optionele parameters.

ServicesListBySubscriptionNextOptionalParams

Optionele parameters.

ServicesListBySubscriptionOptionalParams

Optionele parameters.

ServicesUpdateOptionalParams

Optionele parameters.

SystemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

TermsOfService

Servicevoorwaarden voor de API.

TrackedResource

De definitie van het resourcemodel voor een azure Resource Manager heeft een resource op het hoogste niveau bijgehouden met tags en een locatie

UserAssignedIdentity

Door de gebruiker toegewezen identiteitseigenschappen

Workspace

Werkruimte-entiteit.

WorkspaceListResult

Het antwoord van een werkruimtelijstbewerking.

WorkspaceProperties

Werkruimte-eigenschappen.

Workspaces

Interface die een werkruimte vertegenwoordigt.

WorkspacesCreateOrUpdateHeaders

Definieert headers voor Workspaces_createOrUpdate bewerking.

WorkspacesCreateOrUpdateOptionalParams

Optionele parameters.

WorkspacesDeleteOptionalParams

Optionele parameters.

WorkspacesGetHeaders

Definieert headers voor Workspaces_get bewerking.

WorkspacesGetOptionalParams

Optionele parameters.

WorkspacesHeadOptionalParams

Optionele parameters.

WorkspacesListNextOptionalParams

Optionele parameters.

WorkspacesListOptionalParams

Optionele parameters.

Type-aliassen

ActionType

Definieert waarden voor ActionType.
KnownActionType kan door elkaar worden gebruikt met ActionType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

interne

ApiDefinitionsCreateOrUpdateResponse

Bevat antwoordgegevens voor de createOrUpdate-bewerking.

ApiDefinitionsExportSpecificationResponse

Bevat antwoordgegevens voor de exportSpecification-bewerking.

ApiDefinitionsGetResponse

Bevat antwoordgegevens voor de get-bewerking.

ApiDefinitionsHeadResponse

Bevat antwoordgegevens voor de hoofdbewerking.

ApiDefinitionsListNextResponse

Bevat antwoordgegevens voor de listNext-bewerking.

ApiDefinitionsListResponse

Bevat antwoordgegevens voor de lijstbewerking.

ApiKind

Definieert waarden voor ApiKind.
KnownApiKind kan door elkaar worden gebruikt met ApiKind, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

rest: A Representational State Transfer API
graphql-: Een Graph-querytaal-API
grpc-: een gRPC-API
soap-: een SOAP-API
webhook: Webhook
websocket: Webaansluiting

ApiSpecExportResultFormat

Definieert waarden voor ApiSpecExportResultFormat.
KnownApiSpecExportResultFormat kan door elkaar worden gebruikt met ApiSpecExportResultFormat, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

inline-: de inline inhoud van een specificatiedocument.
koppeling: de koppeling naar het resultaat van de exportbewerking. De URL is vijf minuten geldig.

ApiSpecImportSourceFormat

Definieert waarden voor ApiSpecImportSourceFormat.
KnownApiSpecImportSourceFormat kan door elkaar worden gebruikt met ApiSpecImportSourceFormat, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

inline-: de inline inhoud van een specificatiedocument.
koppeling: de koppeling naar een specificatiedocument dat wordt gehost op een openbaar toegankelijk internetadres.

ApiVersionsCreateOrUpdateResponse

Bevat antwoordgegevens voor de createOrUpdate-bewerking.

ApiVersionsGetResponse

Bevat antwoordgegevens voor de get-bewerking.

ApiVersionsHeadResponse

Bevat antwoordgegevens voor de hoofdbewerking.

ApiVersionsListNextResponse

Bevat antwoordgegevens voor de listNext-bewerking.

ApiVersionsListResponse

Bevat antwoordgegevens voor de lijstbewerking.

ApisCreateOrUpdateResponse

Bevat antwoordgegevens voor de createOrUpdate-bewerking.

ApisGetResponse

Bevat antwoordgegevens voor de get-bewerking.

ApisHeadResponse

Bevat antwoordgegevens voor de hoofdbewerking.

ApisListNextResponse

Bevat antwoordgegevens voor de listNext-bewerking.

ApisListResponse

Bevat antwoordgegevens voor de lijstbewerking.

CreatedByType

Definieert waarden voor CreatedByType.
KnownCreatedByType kan door elkaar worden gebruikt met CreatedByType, bevat deze enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

gebruikers
toepassings-
ManagedIdentity-
Sleutel

DeploymentState

Definieert waarden voor DeploymentState.
KnownDeploymentState kan door elkaar worden gebruikt met DeploymentState, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

actieve: Actieve status
inactieve: Inactieve status

DeploymentsCreateOrUpdateResponse

Bevat antwoordgegevens voor de createOrUpdate-bewerking.

DeploymentsGetResponse

Bevat antwoordgegevens voor de get-bewerking.

DeploymentsHeadResponse

Bevat antwoordgegevens voor de hoofdbewerking.

DeploymentsListNextResponse

Bevat antwoordgegevens voor de listNext-bewerking.

DeploymentsListResponse

Bevat antwoordgegevens voor de lijstbewerking.

EnvironmentKind

Definieert waarden voor EnvironmentKind.
KnownEnvironmentKind kan door elkaar worden gebruikt met EnvironmentKind, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

ontwikkeling: ontwikkelomgeving
testen: testomgeving
faseringsomgeving: faseringsomgeving
productie-: Productieomgeving

EnvironmentServerType

Definieert waarden voor EnvironmentServerType.
KnownEnvironmentServerType kan door elkaar worden gebruikt met EnvironmentServerType, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

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

Bevat antwoordgegevens voor de createOrUpdate-bewerking.

EnvironmentsGetResponse

Bevat antwoordgegevens voor de get-bewerking.

EnvironmentsHeadResponse

Bevat antwoordgegevens voor de hoofdbewerking.

EnvironmentsListNextResponse

Bevat antwoordgegevens voor de listNext-bewerking.

EnvironmentsListResponse

Bevat antwoordgegevens voor de lijstbewerking.

LifecycleStage

Definieert waarden voor LifecycleStage.
KnownLifecycleStage kan door elkaar worden gebruikt met LifecycleStage, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

ontwerp: ontwerpfase
ontwikkeling: ontwikkelingsfase
testen: testfase
preview-: in preview
productie: In productie
afgeschafte: afgeschafte fase
buiten gebruik gesteld: buiten gebruik gestelde fase

ManagedServiceIdentityType

Definieert waarden voor ManagedServiceIdentityType.
KnownManagedServiceIdentityType kan door elkaar worden gebruikt met ManagedServiceIdentityType, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Geen
SystemAssigned
UserAssigned
SystemAssigned, UserAssigned

MetadataAssignmentEntity

Definieert waarden voor MetadataAssignmentEntity.
KnownMetadataAssignmentEntity kan door elkaar worden gebruikt met MetadataAssignmentEntity, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

API-: Toegewezen aan API
omgeving: Toegewezen aan omgeving
implementatie: Toegewezen aan implementatie

MetadataSchemaExportFormat

Definieert waarden voor MetadataSchemaExportFormat.
KnownMetadataSchemaExportFormat kan door elkaar worden gebruikt met MetadataSchemaExportFormat, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

inline-: de inline-inhoud van een schemadocument.
koppeling: de koppeling naar een schemadocument. De URL is vijf minuten geldig.

MetadataSchemasCreateOrUpdateResponse

Bevat antwoordgegevens voor de createOrUpdate-bewerking.

MetadataSchemasGetResponse

Bevat antwoordgegevens voor de get-bewerking.

MetadataSchemasHeadResponse

Bevat antwoordgegevens voor de hoofdbewerking.

MetadataSchemasListNextResponse

Bevat antwoordgegevens voor de listNext-bewerking.

MetadataSchemasListResponse

Bevat antwoordgegevens voor de lijstbewerking.

OperationsListNextResponse

Bevat antwoordgegevens voor de listNext-bewerking.

OperationsListResponse

Bevat antwoordgegevens voor de lijstbewerking.

Origin

Definieert waarden voor Origin.
KnownOrigin- kan door elkaar worden gebruikt met Origin, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

gebruiker
systeem
gebruiker, systeem

ProvisioningState

Definieert waarden voor ProvisioningState.
KnownProvisioningState kan door elkaar worden gebruikt met ProvisioningState, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

geslaagde: resource is gemaakt.
mislukt: het maken van resources is mislukt.
Geannuleerd: het maken van resources is geannuleerd.

ServicesCreateOrUpdateResponse

Bevat antwoordgegevens voor de createOrUpdate-bewerking.

ServicesExportMetadataSchemaResponse

Bevat antwoordgegevens voor de exportMetadataSchema-bewerking.

ServicesGetResponse

Bevat antwoordgegevens voor de get-bewerking.

ServicesListByResourceGroupNextResponse

Bevat antwoordgegevens voor de bewerking listByResourceGroupNext.

ServicesListByResourceGroupResponse

Bevat antwoordgegevens voor de bewerking listByResourceGroup.

ServicesListBySubscriptionNextResponse

Bevat antwoordgegevens voor de bewerking listBySubscriptionNext.

ServicesListBySubscriptionResponse

Bevat antwoordgegevens voor de listBySubscription-bewerking.

ServicesUpdateResponse

Bevat antwoordgegevens voor de updatebewerking.

Versions

Definieert waarden voor versies.
KnownVersions kunnen door elkaar worden gebruikt met versies, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

2024-03-01: de eerste serviceversie

WorkspacesCreateOrUpdateResponse

Bevat antwoordgegevens voor de createOrUpdate-bewerking.

WorkspacesGetResponse

Bevat antwoordgegevens voor de get-bewerking.

WorkspacesHeadResponse

Bevat antwoordgegevens voor de hoofdbewerking.

WorkspacesListNextResponse

Bevat antwoordgegevens voor de listNext-bewerking.

WorkspacesListResponse

Bevat antwoordgegevens voor de lijstbewerking.

Enums

KnownActionType

Bekende waarden van ActionType die de service accepteert.

KnownApiKind

Bekende waarden van ApiKind die de service accepteert.

KnownApiSpecExportResultFormat

Bekende waarden van ApiSpecExportResultFormat die de service accepteert.

KnownApiSpecImportSourceFormat

Bekende waarden van ApiSpecImportSourceFormat die de service accepteert.

KnownCreatedByType

Bekende waarden van CreatedByType die de service accepteert.

KnownDeploymentState

Bekende waarden van DeploymentState die de service accepteert.

KnownEnvironmentKind

Bekende waarden van EnvironmentKind die de service accepteert.

KnownEnvironmentServerType

Bekende waarden van EnvironmentServerType die de service accepteert.

KnownLifecycleStage

Bekende waarden van LifecycleStage die de service accepteert.

KnownManagedServiceIdentityType

Bekende waarden van ManagedServiceIdentityType die de service accepteert.

KnownMetadataAssignmentEntity

Bekende waarden van MetadataAssignmentEntity die de service accepteert.

KnownMetadataSchemaExportFormat

Bekende waarden van MetadataSchemaExportFormat die de service accepteert.

KnownOrigin

Bekende waarden van Origin die de service accepteert.

KnownProvisioningState

Bekende waarden van ProvisioningState die de service accepteert.

KnownVersions

Bekende waarden van Versies die de service accepteert.

Functies

getContinuationToken(unknown)

Gezien de laatste .value geproduceerd door de byPage iterator, retourneert u een vervolgtoken dat kan worden gebruikt om later met paging te beginnen.

Functiedetails

getContinuationToken(unknown)

Gezien de laatste .value geproduceerd door de byPage iterator, retourneert u een vervolgtoken dat kan worden gebruikt om later met paging te beginnen.

function getContinuationToken(page: unknown): string | undefined

Parameters

page

unknown

Een object opent value op iteratorResult vanuit een byPage iterator.

Retouren

string | undefined

Het vervolgtoken dat kan worden doorgegeven aan ByPage() tijdens toekomstige aanroepen.