Sdílet prostřednictvím


@azure/arm-apicenter package

Třídy

AzureAPICenter

Rozhraní

Api

Entita rozhraní API.

ApiDefinition

Entita definice rozhraní API.

ApiDefinitionListResult

Odpověď operace seznamu ApiDefinition.

ApiDefinitionProperties

Entita vlastností definice rozhraní API

ApiDefinitionPropertiesSpecification

Podrobnosti o specifikaci rozhraní API

ApiDefinitions

Rozhraní představující ApiDefinitions.

ApiDefinitionsCreateOrUpdateHeaders

Definuje hlavičky pro ApiDefinitions_createOrUpdate operaci.

ApiDefinitionsCreateOrUpdateOptionalParams

Volitelné parametry.

ApiDefinitionsDeleteOptionalParams

Volitelné parametry.

ApiDefinitionsExportSpecificationHeaders

Definuje hlavičky pro ApiDefinitions_exportSpecification operaci.

ApiDefinitionsExportSpecificationOptionalParams

Volitelné parametry.

ApiDefinitionsGetHeaders

Definuje hlavičky pro operaci ApiDefinitions_get.

ApiDefinitionsGetOptionalParams

Volitelné parametry.

ApiDefinitionsHeadOptionalParams

Volitelné parametry.

ApiDefinitionsImportSpecificationHeaders

Definuje hlavičky pro operaci ApiDefinitions_importSpecification.

ApiDefinitionsImportSpecificationOptionalParams

Volitelné parametry.

ApiDefinitionsListNextOptionalParams

Volitelné parametry.

ApiDefinitionsListOptionalParams

Volitelné parametry.

ApiListResult

Odpověď operace seznamu rozhraní API.

ApiProperties

Vlastnosti rozhraní API.

ApiSpecExportResult

Výsledek exportu specifikace rozhraní API

ApiSpecImportRequest

Vlastnosti zdrojové entity specifikace rozhraní API

ApiSpecImportRequestSpecification

Podrobnosti o specifikaci rozhraní API

ApiVersion

Entita verze rozhraní API.

ApiVersionListResult

Odpověď operace seznamu ApiVersion.

ApiVersionProperties

Entita vlastností verze rozhraní API

ApiVersions

Rozhraní představující ApiVersions.

ApiVersionsCreateOrUpdateHeaders

Definuje hlavičky pro operaci ApiVersions_createOrUpdate.

ApiVersionsCreateOrUpdateOptionalParams

Volitelné parametry.

ApiVersionsDeleteOptionalParams

Volitelné parametry.

ApiVersionsGetHeaders

Definuje hlavičky pro operaci ApiVersions_get.

ApiVersionsGetOptionalParams

Volitelné parametry.

ApiVersionsHeadOptionalParams

Volitelné parametry.

ApiVersionsListNextOptionalParams

Volitelné parametry.

ApiVersionsListOptionalParams

Volitelné parametry.

Apis

Rozhraní představující rozhraní API.

ApisCreateOrUpdateHeaders

Definuje hlavičky pro operaci Apis_createOrUpdate.

ApisCreateOrUpdateOptionalParams

Volitelné parametry.

ApisDeleteOptionalParams

Volitelné parametry.

ApisGetHeaders

Definuje hlavičky pro operaci Apis_get.

ApisGetOptionalParams

Volitelné parametry.

ApisHeadOptionalParams

Volitelné parametry.

ApisListNextOptionalParams

Volitelné parametry.

ApisListOptionalParams

Volitelné parametry.

AzureAPICenterOptionalParams

Volitelné parametry.

Contact

Kontaktní informace

Deployment

Entita nasazení rozhraní API

DeploymentListResult

Odpověď operace seznamu nasazení.

DeploymentProperties

Vlastnosti entity nasazení rozhraní API

DeploymentServer

Server

Deployments

Rozhraní představující nasazení.

DeploymentsCreateOrUpdateHeaders

Definuje hlavičky pro operaci Deployments_createOrUpdate.

DeploymentsCreateOrUpdateOptionalParams

Volitelné parametry.

DeploymentsDeleteOptionalParams

Volitelné parametry.

DeploymentsGetHeaders

Definuje hlavičky pro operaci Deployments_get.

DeploymentsGetOptionalParams

Volitelné parametry.

DeploymentsHeadOptionalParams

Volitelné parametry.

DeploymentsListNextOptionalParams

Volitelné parametry.

DeploymentsListOptionalParams

Volitelné parametry.

Environment

Entita prostředí.

EnvironmentListResult

Odpověď operace seznamu prostředí.

EnvironmentProperties

Entita vlastností prostředí.

EnvironmentServer

Informace o serveru prostředí.

Environments

Rozhraní představující prostředí.

EnvironmentsCreateOrUpdateHeaders

Definuje hlavičky pro operaci Environments_createOrUpdate.

EnvironmentsCreateOrUpdateOptionalParams

Volitelné parametry.

EnvironmentsDeleteOptionalParams

Volitelné parametry.

EnvironmentsGetHeaders

Definuje hlavičky pro operaci Environments_get.

EnvironmentsGetOptionalParams

Volitelné parametry.

EnvironmentsHeadOptionalParams

Volitelné parametry.

EnvironmentsListNextOptionalParams

Volitelné parametry.

EnvironmentsListOptionalParams

Volitelné parametry.

ErrorAdditionalInfo

Další informace o chybě správy prostředků

ErrorDetail

Podrobnosti o chybě

ErrorResponse

Běžná chybová odpověď pro všechna rozhraní API azure Resource Manager, která vrací podrobnosti o chybě pro neúspěšné operace. (Tento formát také odpovídá formátu odpovědi na chybu OData.)

ExternalDocumentation

Další externí dokumentace k rozhraní API

License

Informace o licenci pro rozhraní API.

ManagedServiceIdentity

Identita spravované služby (identity přiřazené systémem nebo uživatelem)

MetadataAssignment

Metadata přiřazení

MetadataSchema

Entita schématu metadat. Slouží k definování metadat pro entity v katalogu rozhraní API.

MetadataSchemaExportRequest

Požadavek na export schématu metadat.

MetadataSchemaExportResult

Výsledek exportu schématu metadat

MetadataSchemaListResult

Odpověď operace seznamu MetadataSchema.

MetadataSchemaProperties

Vlastnosti schématu metadat.

MetadataSchemas

Rozhraní představující MetadataSchemas.

MetadataSchemasCreateOrUpdateHeaders

Definuje hlavičky pro operaci MetadataSchemas_createOrUpdate.

MetadataSchemasCreateOrUpdateOptionalParams

Volitelné parametry.

MetadataSchemasDeleteOptionalParams

Volitelné parametry.

MetadataSchemasGetHeaders

Definuje hlavičky pro operaci MetadataSchemas_get.

MetadataSchemasGetOptionalParams

Volitelné parametry.

MetadataSchemasHeadOptionalParams

Volitelné parametry.

MetadataSchemasListNextOptionalParams

Volitelné parametry.

MetadataSchemasListOptionalParams

Volitelné parametry.

Onboarding

Informace o onboardingu

Operation

Podrobnosti o operaci rozhraní REST API vrácené z rozhraní API pro operace poskytovatele prostředků

OperationDisplay

Lokalizované informace o zobrazení pro tuto konkrétní operaci

OperationListResult

Seznam operací rozhraní REST API podporovaných poskytovatelem prostředků Azure Obsahuje odkaz URL pro získání další sady výsledků.

Operations

Rozhraní představující operaci.

OperationsListNextOptionalParams

Volitelné parametry.

OperationsListOptionalParams

Volitelné parametry.

ProxyResource

Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manager. Nebude obsahovat značky a umístění.

Resource

Běžná pole vrácená v odpovědi pro všechny prostředky azure Resource Manager

Service

Entita služby.

ServiceListResult

Odpověď operace seznamu služeb.

ServiceProperties

Vlastnosti služby.

ServiceUpdate

Typ použitý pro operace aktualizace služby.

Services

Rozhraní představující služby.

ServicesCreateOrUpdateOptionalParams

Volitelné parametry.

ServicesDeleteOptionalParams

Volitelné parametry.

ServicesExportMetadataSchemaHeaders

Definuje hlavičky pro operaci Services_exportMetadataSchema.

ServicesExportMetadataSchemaOptionalParams

Volitelné parametry.

ServicesGetOptionalParams

Volitelné parametry.

ServicesListByResourceGroupNextOptionalParams

Volitelné parametry.

ServicesListByResourceGroupOptionalParams

Volitelné parametry.

ServicesListBySubscriptionNextOptionalParams

Volitelné parametry.

ServicesListBySubscriptionOptionalParams

Volitelné parametry.

ServicesUpdateOptionalParams

Volitelné parametry.

SystemData

Metadata týkající se vytvoření a poslední změny prostředku

TermsOfService

Podmínky služby pro rozhraní API

TrackedResource

Definice modelu prostředků pro azure Resource Manager sledovaný prostředek nejvyšší úrovně, který má značky a umístění.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

Workspace

Entita pracovního prostoru

WorkspaceListResult

Odpověď operace seznamu pracovních prostorů.

WorkspaceProperties

Vlastnosti pracovního prostoru.

Workspaces

Rozhraní představující pracovní prostory.

WorkspacesCreateOrUpdateHeaders

Definuje hlavičky pro operaci Workspaces_createOrUpdate.

WorkspacesCreateOrUpdateOptionalParams

Volitelné parametry.

WorkspacesDeleteOptionalParams

Volitelné parametry.

WorkspacesGetHeaders

Definuje hlavičky pro operaci Workspaces_get.

WorkspacesGetOptionalParams

Volitelné parametry.

WorkspacesHeadOptionalParams

Volitelné parametry.

WorkspacesListNextOptionalParams

Volitelné parametry.

WorkspacesListOptionalParams

Volitelné parametry.

Aliasy typu

ActionType

Definuje hodnoty pro ActionType.
KnownActionType lze použít zaměnitelně s ActionType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Interní

ApiDefinitionsCreateOrUpdateResponse

Obsahuje data odpovědi pro operaci createOrUpdate.

ApiDefinitionsExportSpecificationResponse

Obsahuje data odpovědi pro operaci exportSpecification.

ApiDefinitionsGetResponse

Obsahuje data odpovědi pro operaci get.

ApiDefinitionsHeadResponse

Obsahuje data odpovědi pro operaci hlavou.

ApiDefinitionsListNextResponse

Obsahuje data odpovědi pro operaci listNext.

ApiDefinitionsListResponse

Obsahuje data odpovědi pro operaci výpisu.

ApiKind

Definuje hodnoty pro ApiKind.
KnownApiKind se dá používat zaměnitelně s ApiKind, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

rest: Rozhraní API pro reprezentační přenos stavu
graphql: Rozhraní API dotazovacího jazyka Graph
grpc: Rozhraní API gRPC
soap: Rozhraní API protokolu SOAP
webhook: Webhook
websocket: Webový soket

ApiSpecExportResultFormat

Definuje hodnoty pro ApiSpecExportResultFormat.
KnownApiSpecExportResultFormat lze použít zaměnitelně s ApiSpecExportResultFormat, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

inline: Vložený obsah dokumentu specifikace.
link: Odkaz na výsledek operace exportu. Adresa URL je platná po dobu 5 minut.

ApiSpecImportSourceFormat

Definuje hodnoty pro ApiSpecImportSourceFormat.
KnownApiSpecImportSourceFormat lze použít zaměnitelně s ApiSpecImportSourceFormat, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

inline: Vložený obsah dokumentu specifikace.
link: Odkaz na dokument specifikace hostovaný na veřejně přístupné internetové adrese.

ApiVersionsCreateOrUpdateResponse

Obsahuje data odpovědi pro operaci createOrUpdate.

ApiVersionsGetResponse

Obsahuje data odpovědi pro operaci get.

ApiVersionsHeadResponse

Obsahuje data odpovědi pro operaci hlavou.

ApiVersionsListNextResponse

Obsahuje data odpovědi pro operaci listNext.

ApiVersionsListResponse

Obsahuje data odpovědi pro operaci výpisu.

ApisCreateOrUpdateResponse

Obsahuje data odpovědi pro operaci createOrUpdate.

ApisGetResponse

Obsahuje data odpovědi pro operaci get.

ApisHeadResponse

Obsahuje data odpovědi pro operaci hlavou.

ApisListNextResponse

Obsahuje data odpovědi pro operaci listNext.

ApisListResponse

Obsahuje data odpovědi pro operaci výpisu.

CreatedByType

Definuje hodnoty pro CreatedByType.
KnownCreatedByType lze použít zaměnitelně s CreatedByType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Uživatel
Aplikace
Spravovaná identita
Klíč

DeploymentState

Definuje hodnoty pro DeploymentState.
KnownDeploymentState lze použít zaměnitelně s DeploymentState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

aktivní: Aktivní stav
neaktivní: Neaktivní stav

DeploymentsCreateOrUpdateResponse

Obsahuje data odpovědi pro operaci createOrUpdate.

DeploymentsGetResponse

Obsahuje data odpovědi pro operaci get.

DeploymentsHeadResponse

Obsahuje data odpovědi pro operaci hlavou.

DeploymentsListNextResponse

Obsahuje data odpovědi pro operaci listNext.

DeploymentsListResponse

Obsahuje data odpovědi pro operaci výpisu.

EnvironmentKind

Definuje hodnoty pro EnvironmentKind.
Pole KnownEnvironmentKind lze použít zaměnitelně s EnvironmentKind, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

development: Vývojové prostředí
testování: Testovací prostředí
příprava: Přípravné prostředí
production: Produkční prostředí

EnvironmentServerType

Definuje hodnoty pro EnvironmentServerType.
Pole KnownEnvironmentServerType lze použít zaměnitelně s EnvironmentServerType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Azure API Management: Api Management Server
Výpočetní služba Azure: Výpočetní server
Apigee API Management: Server Apigee
AWS API Gateway: Server brány rozhraní API AWS
Brána rozhraní API Pro Kong: Server brány rozhraní API pro Kong
Kubernetes: Server Kubernetes
API Management MuleSoft: Server mulesoft API Management

EnvironmentsCreateOrUpdateResponse

Obsahuje data odpovědi pro operaci createOrUpdate.

EnvironmentsGetResponse

Obsahuje data odpovědi pro operaci get.

EnvironmentsHeadResponse

Obsahuje data odpovědi pro operaci hlavou.

EnvironmentsListNextResponse

Obsahuje data odpovědi pro operaci listNext.

EnvironmentsListResponse

Obsahuje data odpovědi pro operaci výpisu.

LifecycleStage

Definuje hodnoty pro LifecycleStage.
KnownLifecycleStage je možné používat zaměnitelně s LifecycleStage, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

design: fáze návrhu
vývoj: fáze vývoje
testování: fáze testování
preview: Ve verzi Preview
production: V produkčním prostředí
deprecated: zastaralá fáze
vyřazeno: Vyřazená fáze

ManagedServiceIdentityType

Definuje hodnoty pro ManagedServiceIdentityType.
Pole KnownManagedServiceIdentityType lze použít zaměnitelně s ManagedServiceIdentityType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Žádný
SystemAssigned
Přiřazeno uživatelem
SystemAssigned,UserAssigned

MetadataAssignmentEntity

Definuje hodnoty pro MetadataAssignmentEntity.
KnownMetadataAssignmentEntity lze použít zaměnitelně s MetadataAssignmentEntity, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

api: Přiřazeno k rozhraní API
prostředí: Přiřazeno k prostředí
nasazení: Přiřazeno k nasazení

MetadataSchemaExportFormat

Definuje hodnoty pro MetadataSchemaExportFormat.
Pole KnownMetadataSchemaExportFormat lze použít zaměnitelně s MetadataSchemaExportFormat, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

vložený: Vložený obsah dokumentu schématu.
link: Odkaz na dokument schématu. Adresa URL je platná 5 minut.

MetadataSchemasCreateOrUpdateResponse

Obsahuje data odpovědi pro operaci createOrUpdate.

MetadataSchemasGetResponse

Obsahuje data odpovědi pro operaci get.

MetadataSchemasHeadResponse

Obsahuje data odezvy pro hlavní operaci.

MetadataSchemasListNextResponse

Obsahuje data odpovědi pro operaci listNext.

MetadataSchemasListResponse

Obsahuje data odpovědi pro operaci seznamu.

OperationsListNextResponse

Obsahuje data odpovědi pro operaci listNext.

OperationsListResponse

Obsahuje data odpovědi pro operaci seznamu.

Origin

Definuje hodnoty pro Origin.
Pole KnownOrigin lze použít zaměnitelně s Origin, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Uživatel
systém
user, system

ProvisioningState

Definuje hodnoty pro ProvisioningState.
Pole KnownProvisioningState lze použít zaměnitelně s ProvisioningState. Tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Úspěch: Prostředek byl vytvořen.
Selhání: Vytvoření prostředku se nezdařilo.
Zrušeno: Vytváření prostředků se zrušilo.

ServicesCreateOrUpdateResponse

Obsahuje data odpovědi pro operaci createOrUpdate.

ServicesExportMetadataSchemaResponse

Obsahuje data odpovědi pro operaci exportMetadataSchema.

ServicesGetResponse

Obsahuje data odpovědi pro operaci get.

ServicesListByResourceGroupNextResponse

Obsahuje data odpovědi pro operaci listByResourceGroupNext.

ServicesListByResourceGroupResponse

Obsahuje data odpovědi pro operaci listByResourceGroup.

ServicesListBySubscriptionNextResponse

Obsahuje data odpovědi pro operaci listBySubscriptionNext.

ServicesListBySubscriptionResponse

Obsahuje data odpovědi pro operaci listBySubscription.

ServicesUpdateResponse

Obsahuje data odpovědi pro operaci aktualizace.

Versions

Definuje hodnoty pro verze.
KnownVersions lze používat zaměnitelně s verzemi. Tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

2024-03-01: Počáteční verze služby

WorkspacesCreateOrUpdateResponse

Obsahuje data odpovědi pro operaci createOrUpdate.

WorkspacesGetResponse

Obsahuje data odpovědi pro operaci get.

WorkspacesHeadResponse

Obsahuje data odezvy pro hlavní operaci.

WorkspacesListNextResponse

Obsahuje data odpovědi pro operaci listNext.

WorkspacesListResponse

Obsahuje data odpovědi pro operaci seznamu.

Výčty

KnownActionType

Známé hodnoty ActionType , které služba přijímá.

KnownApiKind

Známé hodnoty ApiKind , které služba přijímá.

KnownApiSpecExportResultFormat

Známé hodnoty ApiSpecExportResultFormat , které služba přijímá.

KnownApiSpecImportSourceFormat

Známé hodnoty ApiSpecImportSourceFormat , které služba přijímá.

KnownCreatedByType

Známé hodnoty CreatedByType , které služba přijímá.

KnownDeploymentState

Známé hodnoty DeploymentState , které služba přijímá.

KnownEnvironmentKind

Známé hodnoty EnvironmentKind , které služba přijímá.

KnownEnvironmentServerType

Známé hodnoty EnvironmentServerType , které služba přijímá.

KnownLifecycleStage

Známé hodnoty LifecycleStage , které služba přijímá.

KnownManagedServiceIdentityType

Známé hodnoty ManagedServiceIdentityType , které služba přijímá.

KnownMetadataAssignmentEntity

Známé hodnoty MetadataAssignmentEntity , které služba přijímá.

KnownMetadataSchemaExportFormat

Známé hodnoty MetadataSchemaExportFormat , které služba přijímá.

KnownOrigin

Známé hodnoty originu , které služba přijímá.

KnownProvisioningState

Známé hodnoty ProvisioningState , které služba přijímá.

KnownVersions

Známé hodnoty verzí , které služba přijímá.

Funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému byPage iterátorem vrátí token pokračování, který lze použít k zahájení stránkování od tohoto bodu později.

Podrobnosti funkce

getContinuationToken(unknown)

Vzhledem k poslednímu .value vytvořenému byPage iterátorem vrátí token pokračování, který lze použít k zahájení stránkování od tohoto bodu později.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

Objekt z přístupu value na IteratorResult z iterátoru byPage .

Návraty

string | undefined

Token pokračování, který může být předán do byPage() během budoucích volání.