Dela via


@azure/arm-apicenter package

Klasser

AzureAPICenter

Gränssnitt

Api

API-entitet.

ApiDefinition

API-definitionsentitet.

ApiDefinitionListResult

Svaret från en ApiDefinition-liståtgärd.

ApiDefinitionProperties

ENTitet för API-definitionsegenskaper.

ApiDefinitionPropertiesSpecification

API-specifikationsinformation.

ApiDefinitions

Gränssnitt som representerar ett ApiDefinitions.

ApiDefinitionsCreateOrUpdateHeaders

Definierar rubriker för ApiDefinitions_createOrUpdate åtgärd.

ApiDefinitionsCreateOrUpdateOptionalParams

Valfria parametrar.

ApiDefinitionsDeleteOptionalParams

Valfria parametrar.

ApiDefinitionsExportSpecificationHeaders

Definierar rubriker för ApiDefinitions_exportSpecification åtgärd.

ApiDefinitionsExportSpecificationOptionalParams

Valfria parametrar.

ApiDefinitionsGetHeaders

Definierar rubriker för ApiDefinitions_get åtgärd.

ApiDefinitionsGetOptionalParams

Valfria parametrar.

ApiDefinitionsHeadOptionalParams

Valfria parametrar.

ApiDefinitionsImportSpecificationHeaders

Definierar rubriker för ApiDefinitions_importSpecification åtgärd.

ApiDefinitionsImportSpecificationOptionalParams

Valfria parametrar.

ApiDefinitionsListNextOptionalParams

Valfria parametrar.

ApiDefinitionsListOptionalParams

Valfria parametrar.

ApiListResult

Svaret från en API-liståtgärd.

ApiProperties

API-egenskaper.

ApiSpecExportResult

Exportresultatet för API-specifikationen.

ApiSpecImportRequest

Api-specifikationens källentitetsegenskaper.

ApiSpecImportRequestSpecification

API-specifikationsinformation.

ApiVersion

API-versionsentitet.

ApiVersionListResult

Svaret från en ApiVersion-liståtgärd.

ApiVersionProperties

API-versionsegenskaper entitet.

ApiVersions

Gränssnitt som representerar en ApiVersions.

ApiVersionsCreateOrUpdateHeaders

Definierar rubriker för ApiVersions_createOrUpdate åtgärd.

ApiVersionsCreateOrUpdateOptionalParams

Valfria parametrar.

ApiVersionsDeleteOptionalParams

Valfria parametrar.

ApiVersionsGetHeaders

Definierar rubriker för ApiVersions_get åtgärd.

ApiVersionsGetOptionalParams

Valfria parametrar.

ApiVersionsHeadOptionalParams

Valfria parametrar.

ApiVersionsListNextOptionalParams

Valfria parametrar.

ApiVersionsListOptionalParams

Valfria parametrar.

Apis

Gränssnitt som representerar ett Apis.

ApisCreateOrUpdateHeaders

Definierar rubriker för Apis_createOrUpdate åtgärd.

ApisCreateOrUpdateOptionalParams

Valfria parametrar.

ApisDeleteOptionalParams

Valfria parametrar.

ApisGetHeaders

Definierar rubriker för Apis_get åtgärd.

ApisGetOptionalParams

Valfria parametrar.

ApisHeadOptionalParams

Valfria parametrar.

ApisListNextOptionalParams

Valfria parametrar.

ApisListOptionalParams

Valfria parametrar.

AzureAPICenterOptionalParams

Valfria parametrar.

Contact

Kontaktinformation

Deployment

ENTitet för API-distribution.

DeploymentListResult

Svaret från en distributionslista.

DeploymentProperties

Entitetsegenskaper för API-distribution.

DeploymentServer

Server

Deployments

Gränssnitt som representerar en distribution.

DeploymentsCreateOrUpdateHeaders

Definierar rubriker för Deployments_createOrUpdate åtgärd.

DeploymentsCreateOrUpdateOptionalParams

Valfria parametrar.

DeploymentsDeleteOptionalParams

Valfria parametrar.

DeploymentsGetHeaders

Definierar rubriker för Deployments_get åtgärd.

DeploymentsGetOptionalParams

Valfria parametrar.

DeploymentsHeadOptionalParams

Valfria parametrar.

DeploymentsListNextOptionalParams

Valfria parametrar.

DeploymentsListOptionalParams

Valfria parametrar.

Environment

Miljöentitet.

EnvironmentListResult

Svaret från en miljölisteåtgärd.

EnvironmentProperties

Entitet för miljöegenskaper.

EnvironmentServer

Serverinformation om miljön.

Environments

Gränssnitt som representerar en miljö.

EnvironmentsCreateOrUpdateHeaders

Definierar rubriker för Environments_createOrUpdate åtgärd.

EnvironmentsCreateOrUpdateOptionalParams

Valfria parametrar.

EnvironmentsDeleteOptionalParams

Valfria parametrar.

EnvironmentsGetHeaders

Definierar rubriker för Environments_get åtgärd.

EnvironmentsGetOptionalParams

Valfria parametrar.

EnvironmentsHeadOptionalParams

Valfria parametrar.

EnvironmentsListNextOptionalParams

Valfria parametrar.

EnvironmentsListOptionalParams

Valfria parametrar.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

ExternalDocumentation

Ytterligare extern dokumentation för API:et.

License

Licensinformationen för API:et.

ManagedServiceIdentity

Hanterad tjänstidentitet (systemtilldelade och/eller användartilldelade identiteter)

MetadataAssignment

Tilldelningsmetadata

MetadataSchema

Entitet för metadataschema. Används för att definiera metadata för entiteterna i API-katalogen.

MetadataSchemaExportRequest

Begäran om export av metadataschema.

MetadataSchemaExportResult

Resultatet av metadataschemaexporten.

MetadataSchemaListResult

Svaret från en MetadataSchema-liståtgärd.

MetadataSchemaProperties

Egenskaper för metadataschema.

MetadataSchemas

Gränssnitt som representerar metadatascheman.

MetadataSchemasCreateOrUpdateHeaders

Definierar rubriker för MetadataSchemas_createOrUpdate åtgärd.

MetadataSchemasCreateOrUpdateOptionalParams

Valfria parametrar.

MetadataSchemasDeleteOptionalParams

Valfria parametrar.

MetadataSchemasGetHeaders

Definierar rubriker för MetadataSchemas_get åtgärd.

MetadataSchemasGetOptionalParams

Valfria parametrar.

MetadataSchemasHeadOptionalParams

Valfria parametrar.

MetadataSchemasListNextOptionalParams

Valfria parametrar.

MetadataSchemasListOptionalParams

Valfria parametrar.

Onboarding

Registreringsinformation

Operation

Information om en REST API-åtgärd som returneras från API:et för resursprovideråtgärder

OperationDisplay

Lokaliserad visningsinformation för den här åtgärden.

OperationListResult

En lista över REST API-åtgärder som stöds av en Azure-resursprovider. Den innehåller en URL-länk för att hämta nästa uppsättning resultat.

Operations

Gränssnitt som representerar en operation.

OperationsListNextOptionalParams

Valfria parametrar.

OperationsListOptionalParams

Valfria parametrar.

ProxyResource

Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats

Resource

Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser

Service

Tjänstentiteten.

ServiceListResult

Svaret från en tjänstlisteåtgärd.

ServiceProperties

Egenskaperna för tjänsten.

ServiceUpdate

Den typ som används för uppdateringsåtgärder för tjänsten.

Services

Gränssnitt som representerar en tjänst.

ServicesCreateOrUpdateOptionalParams

Valfria parametrar.

ServicesDeleteOptionalParams

Valfria parametrar.

ServicesExportMetadataSchemaHeaders

Definierar rubriker för Services_exportMetadataSchema åtgärd.

ServicesExportMetadataSchemaOptionalParams

Valfria parametrar.

ServicesGetOptionalParams

Valfria parametrar.

ServicesListByResourceGroupNextOptionalParams

Valfria parametrar.

ServicesListByResourceGroupOptionalParams

Valfria parametrar.

ServicesListBySubscriptionNextOptionalParams

Valfria parametrar.

ServicesListBySubscriptionOptionalParams

Valfria parametrar.

ServicesUpdateOptionalParams

Valfria parametrar.

SystemData

Metadata som rör skapande och senaste ändring av resursen.

TermsOfService

Användningsvillkor för API:et.

TrackedResource

Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"

UserAssignedIdentity

Användartilldelade identitetsegenskaper

Workspace

Entitet för arbetsyta.

WorkspaceListResult

Svaret från en liståtgärd för arbetsytor.

WorkspaceProperties

Egenskaper för arbetsyta.

Workspaces

Gränssnitt som representerar en arbetsyta.

WorkspacesCreateOrUpdateHeaders

Definierar rubriker för Workspaces_createOrUpdate åtgärd.

WorkspacesCreateOrUpdateOptionalParams

Valfria parametrar.

WorkspacesDeleteOptionalParams

Valfria parametrar.

WorkspacesGetHeaders

Definierar rubriker för Workspaces_get åtgärd.

WorkspacesGetOptionalParams

Valfria parametrar.

WorkspacesHeadOptionalParams

Valfria parametrar.

WorkspacesListNextOptionalParams

Valfria parametrar.

WorkspacesListOptionalParams

Valfria parametrar.

Typalias

ActionType

Definierar värden för ActionType.
KnownActionType- kan användas utbytbart med ActionType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Intern

ApiDefinitionsCreateOrUpdateResponse

Innehåller svarsdata för åtgärden createOrUpdate.

ApiDefinitionsExportSpecificationResponse

Innehåller svarsdata för exportSpecification-åtgärden.

ApiDefinitionsGetResponse

Innehåller svarsdata för get-åtgärden.

ApiDefinitionsHeadResponse

Innehåller svarsdata för huvudåtgärden.

ApiDefinitionsListNextResponse

Innehåller svarsdata för listNästa åtgärden.

ApiDefinitionsListResponse

Innehåller svarsdata för liståtgärden.

ApiKind

Definierar värden för ApiKind.
KnownApiKind- kan användas omväxlande med ApiKind innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

rest: Ett representationstillståndsöverförings-API
graphql: Api för ett graph-frågespråk
grpc: Ett gRPC Api
soap: A SOAP API
webhook: Webkrok
websocket: Webbsocket

ApiSpecExportResultFormat

Definierar värden för ApiSpecExportResultFormat.
KnownApiSpecExportResultFormat kan användas omväxlande med ApiSpecExportResultFormat innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

infogad: Det inlindade innehållet i ett specifikationsdokument.
länk: Länken till resultatet av exportåtgärden. URL:en är giltig i 5 minuter.

ApiSpecImportSourceFormat

Definierar värden för ApiSpecImportSourceFormat.
KnownApiSpecImportSourceFormat kan användas utbytbart med ApiSpecImportSourceFormat innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

infogad: Det inlindade innehållet i ett specifikationsdokument.
länk: Länken till ett specifikationsdokument som finns på en offentligt tillgänglig Internetadress.

ApiVersionsCreateOrUpdateResponse

Innehåller svarsdata för åtgärden createOrUpdate.

ApiVersionsGetResponse

Innehåller svarsdata för get-åtgärden.

ApiVersionsHeadResponse

Innehåller svarsdata för huvudåtgärden.

ApiVersionsListNextResponse

Innehåller svarsdata för listNästa åtgärden.

ApiVersionsListResponse

Innehåller svarsdata för liståtgärden.

ApisCreateOrUpdateResponse

Innehåller svarsdata för åtgärden createOrUpdate.

ApisGetResponse

Innehåller svarsdata för get-åtgärden.

ApisHeadResponse

Innehåller svarsdata för huvudåtgärden.

ApisListNextResponse

Innehåller svarsdata för listNästa åtgärden.

ApisListResponse

Innehåller svarsdata för liståtgärden.

CreatedByType

Definierar värden för CreatedByType.
KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

användare
Program
ManagedIdentity
nyckel

DeploymentState

Definierar värden för DeploymentState.
KnownDeploymentState kan användas utbytbart med DeploymentState innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

aktiv: Aktivt tillstånd
inaktiv: Inaktivt tillstånd

DeploymentsCreateOrUpdateResponse

Innehåller svarsdata för åtgärden createOrUpdate.

DeploymentsGetResponse

Innehåller svarsdata för get-åtgärden.

DeploymentsHeadResponse

Innehåller svarsdata för huvudåtgärden.

DeploymentsListNextResponse

Innehåller svarsdata för listNästa åtgärden.

DeploymentsListResponse

Innehåller svarsdata för liståtgärden.

EnvironmentKind

Definierar värden för EnvironmentKind.
KnownEnvironmentKind kan användas utbytbart med EnvironmentKind innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

utveckling: Utvecklingsmiljö
testning: Testmiljö
mellanlagring: Mellanlagringsmiljö
produktionsmiljö: Produktionsmiljö

EnvironmentServerType

Definierar värden för EnvironmentServerType.
KnownEnvironmentServerType kan användas utbytbart med EnvironmentServerType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

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

Innehåller svarsdata för åtgärden createOrUpdate.

EnvironmentsGetResponse

Innehåller svarsdata för get-åtgärden.

EnvironmentsHeadResponse

Innehåller svarsdata för huvudåtgärden.

EnvironmentsListNextResponse

Innehåller svarsdata för listNästa åtgärden.

EnvironmentsListResponse

Innehåller svarsdata för liståtgärden.

LifecycleStage

Definierar värden för LivscykelStage.
KnownLifecycleStage- kan användas omväxlande med LifecycleStage innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

design: designsteg
utveckling: utvecklingsfas
testning: teststeg
förhandsversion: I förhandsversion
produktion: I produktion
inaktuell: inaktuell fas
tillbakadragen: Tillbakadragen fas

ManagedServiceIdentityType

Definierar värden för ManagedServiceIdentityType.
KnownManagedServiceIdentityType kan användas utbytbart med ManagedServiceIdentityType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Ingen
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MetadataAssignmentEntity

Definierar värden för MetadataAssignmentEntity.
KnownMetadataAssignmentEntity kan användas omväxlande med MetadataAssignmentEntity innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

api: Tilldelad till API
miljö: Tilldelad till miljö
distribution: Tilldelad till distribution

MetadataSchemaExportFormat

Definierar värden för MetadataSchemaExportFormat.
KnownMetadataSchemaExportFormat kan användas utbytbart med MetadataSchemaExportFormat innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

infogad: Det infogade innehållet i ett schemadokument.
länk: Länken till ett schemadokument. URL:en är giltig i 5 minuter.

MetadataSchemasCreateOrUpdateResponse

Innehåller svarsdata för åtgärden createOrUpdate.

MetadataSchemasGetResponse

Innehåller svarsdata för get-åtgärden.

MetadataSchemasHeadResponse

Innehåller svarsdata för huvudåtgärden.

MetadataSchemasListNextResponse

Innehåller svarsdata för listNästa åtgärden.

MetadataSchemasListResponse

Innehåller svarsdata för liståtgärden.

OperationsListNextResponse

Innehåller svarsdata för listNästa åtgärden.

OperationsListResponse

Innehåller svarsdata för liståtgärden.

Origin

Definierar värden för Ursprung.
KnownOrigin- kan användas omväxlande med Origin innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

användare
system
användare, system

ProvisioningState

Definierar värden för ProvisioningState.
KnownProvisioningState kan användas omväxlande med ProvisioningState innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

lyckades: Resursen har skapats.
Misslyckades: Det gick inte att skapa resursen.
Avbröts: Resursskapande avbröts.

ServicesCreateOrUpdateResponse

Innehåller svarsdata för åtgärden createOrUpdate.

ServicesExportMetadataSchemaResponse

Innehåller svarsdata för exportMetadataSchema-åtgärden.

ServicesGetResponse

Innehåller svarsdata för get-åtgärden.

ServicesListByResourceGroupNextResponse

Innehåller svarsdata för åtgärden listByResourceGroupNext.

ServicesListByResourceGroupResponse

Innehåller svarsdata för åtgärden listByResourceGroup.

ServicesListBySubscriptionNextResponse

Innehåller svarsdata för åtgärden listBySubscriptionNext.

ServicesListBySubscriptionResponse

Innehåller svarsdata för listBySubscription-åtgärden.

ServicesUpdateResponse

Innehåller svarsdata för uppdateringsåtgärden.

Versions

Definierar värden för versioner.
KnownVersions kan användas utbytbart med versioner innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

2024-03-01: Den första tjänstversionen

WorkspacesCreateOrUpdateResponse

Innehåller svarsdata för åtgärden createOrUpdate.

WorkspacesGetResponse

Innehåller svarsdata för get-åtgärden.

WorkspacesHeadResponse

Innehåller svarsdata för huvudåtgärden.

WorkspacesListNextResponse

Innehåller svarsdata för listNästa åtgärden.

WorkspacesListResponse

Innehåller svarsdata för liståtgärden.

Uppräkningar

KnownActionType

Kända värden för ActionType- som tjänsten accepterar.

KnownApiKind

Kända värden för ApiKind- som tjänsten accepterar.

KnownApiSpecExportResultFormat

Kända värden för ApiSpecExportResultFormat som tjänsten accepterar.

KnownApiSpecImportSourceFormat

Kända värden för ApiSpecImportSourceFormat som tjänsten accepterar.

KnownCreatedByType

Kända värden för CreatedByType- som tjänsten accepterar.

KnownDeploymentState

Kända värden för DeploymentState som tjänsten accepterar.

KnownEnvironmentKind

Kända värden för EnvironmentKind som tjänsten accepterar.

KnownEnvironmentServerType

Kända värden för EnvironmentServerType som tjänsten accepterar.

KnownLifecycleStage

Kända värden för LivscykelStage- som tjänsten accepterar.

KnownManagedServiceIdentityType

Kända värden för ManagedServiceIdentityType som tjänsten accepterar.

KnownMetadataAssignmentEntity

Kända värden för MetadataAssignmentEntity som tjänsten accepterar.

KnownMetadataSchemaExportFormat

Kända värden för MetadataSchemaExportFormat som tjänsten accepterar.

KnownOrigin

Kända värden för Origin som tjänsten accepterar.

KnownProvisioningState

Kända värden för ProvisioningState som tjänsten accepterar.

KnownVersions

Kända värden för versioner som tjänsten accepterar.

Funktioner

getContinuationToken(unknown)

Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.

Funktionsinformation

getContinuationToken(unknown)

Med tanke på den senaste .value som skapades av iteratorn byPage returnerar en fortsättningstoken som kan användas för att börja söka från den punkten senare.

function getContinuationToken(page: unknown): string | undefined

Parametrar

page

unknown

Ett objekt från att komma åt value på IteratorResult från en byPage iterator.

Returer

string | undefined

Fortsättningstoken som kan skickas till byPage() under framtida anrop.