@azure/arm-apicenter package

Klasser

AzureAPICenter

Gränssnitt

Api	API-entitet.
ApiDefinition	API-definitionsentitet.
ApiDefinitionListResult	Svaret för en ApiDefinition-liståtgärd.
ApiDefinitionProperties	Entitet för API-definitionsegenskaper.
ApiDefinitionPropertiesSpecification	Information om API-specifikation.
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 för en API-liståtgärd.
ApiProperties	API-egenskaper.
ApiSpecExportResult	Exportresultatet för API-specifikationen.
ApiSpecImportRequest	Api-specifikationens källentitetsegenskaper.
ApiSpecImportRequestSpecification	Information om API-specifikation.
ApiVersion	ENTitet för API-version.
ApiVersionListResult	Svaret för en ApiVersion-liståtgärd.
ApiVersionProperties	Egenskapsentitet för API-version.
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 API.
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	API-distributionsentitet.
DeploymentListResult	Svaret för 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 för 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 OData-felsvarsformatet.).
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 ett MetadataSchemas.
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 resursproviderns operations-API
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 åtgärder.
OperationsListNextOptionalParams	Valfria parametrar.
OperationsListOptionalParams	Valfria parametrar.
ProxyResource	Resursmodelldefinitionen för en Azure Resource Manager proxyresurs. Den 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 för 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 tjänster.
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	Egenskaper för användartilldelad identitet
Workspace	Entitet för arbetsyta.
WorkspaceListResult	Svaret för 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 synonymt med ActionType. Den här uppräkningen innehåller 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 åtgärden listNext.
ApiDefinitionsListResponse	Innehåller svarsdata för liståtgärden.
ApiKind	Definierar värden för ApiKind. KnownApiKind kan användas synonymt med ApiKind. Den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten rest: Ett API för representationstillståndsöverföring graphql: Api för graph-frågespråk grpc: Ett gRPC Api soap: A SOAP API webhook: Web Hook websocket: Web Socket
ApiSpecExportResultFormat	Definierar värden för ApiSpecExportResultFormat. KnownApiSpecExportResultFormat kan användas synonymt med ApiSpecExportResultFormat. Den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten infogat: Det infogade innehållet i ett specifikationsdokument. link: 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 synonymt med ApiSpecImportSourceFormat. Den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten infogat: Det infogade 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 åtgärden listNext.
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 åtgärden listNext.
ApisListResponse	Innehåller svarsdata för liståtgärden.
CreatedByType	Definierar värden för CreatedByType. KnownCreatedByType kan användas synonymt med CreatedByType. Den här uppräkningen innehåller 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 synonymt med DeploymentState. Den här uppräkningen innehåller 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 åtgärden listNext.
DeploymentsListResponse	Innehåller svarsdata för liståtgärden.
EnvironmentKind	Definierar värden för EnvironmentKind. KnownEnvironmentKind kan användas synonymt med EnvironmentKind. Den här uppräkningen innehåller 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ö produktion: Produktionsmiljö
EnvironmentServerType	Definierar värden för EnvironmentServerType. KnownEnvironmentServerType kan användas synonymt med EnvironmentServerType. Den här uppräkningen innehåller 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-beräkningstjänst: Beräkningsserver 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 åtgärden listNext.
EnvironmentsListResponse	Innehåller svarsdata för liståtgärden.
LifecycleStage	Definierar värden för LifecycleStage. KnownLifecycleStage kan användas synonymt med LifecycleStage. Den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten design: designsteg utveckling: utvecklingsstadium testning: teststeg förhandsversion: I förhandsversion produktion: I produktion inaktuell: inaktuell fas retired: Tillbakadragen fas
ManagedServiceIdentityType	Definierar värden för ManagedServiceIdentityType. KnownManagedServiceIdentityType kan användas synonymt med ManagedServiceIdentityType. Den här uppräkningen innehåller 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 synonymt med MetadataAssignmentEntity, den här uppräkningen innehåller 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 synonymt med MetadataSchemaExportFormat. Den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten infogat: 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 åtgärden listNext.
MetadataSchemasListResponse	Innehåller svarsdata för liståtgärden.
OperationsListNextResponse	Innehåller svarsdata för åtgärden listNext.
OperationsListResponse	Innehåller svarsdata för liståtgärden.
Origin	Definierar värden för Ursprung. KnownOrigin kan användas synonymt med Origin. Den här uppräkningen innehåller de kända värden som tjänsten stöder. Kända värden som stöds av tjänsten användare system user,system
ProvisioningState	Definierar värden för ProvisioningState. KnownProvisioningState kan användas synonymt med ProvisioningState. Den här uppräkningen innehåller 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: Resursskapandet avbröts.
ServicesCreateOrUpdateResponse	Innehåller svarsdata för åtgärden createOrUpdate.
ServicesExportMetadataSchemaResponse	Innehåller svarsdata för åtgärden exportMetadataSchema.
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 åtgärden listBySubscription.
ServicesUpdateResponse	Innehåller svarsdata för uppdateringsåtgärden.
Versions	Definierar värden för Versioner. KnownVersions kan användas synonymt med versioner. Den här uppräkningen innehåller 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 åtgärden listNext.
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 LifecycleStage 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 Ursprung 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)

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

Funktionsinformation

getContinuationToken(unknown)

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

function getContinuationToken(page: unknown): string | undefined

Parametrar

page

unknown

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

Returer

string | undefined

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