@azure/arm-apicenter package

Classes

AzureAPICenter

Interfaces

Api	Entité d’API.
ApiDefinition	Entité de définition d’API.
ApiDefinitionListResult	Réponse d’une opération de liste ApiDefinition.
ApiDefinitionProperties	Entité de propriétés de définition d’API.
ApiDefinitionPropertiesSpecification	Détails de la spécification de l’API.
ApiDefinitions	Interface représentant une ApiDefinitions.
ApiDefinitionsCreateOrUpdateHeaders	Définit des en-têtes pour l’opération de ApiDefinitions_createOrUpdate.
ApiDefinitionsCreateOrUpdateOptionalParams	Paramètres facultatifs.
ApiDefinitionsDeleteOptionalParams	Paramètres facultatifs.
ApiDefinitionsExportSpecificationHeaders	Définit des en-têtes pour l’opération de ApiDefinitions_exportSpecification.
ApiDefinitionsExportSpecificationOptionalParams	Paramètres facultatifs.
ApiDefinitionsGetHeaders	Définit les en-têtes pour l’opération de ApiDefinitions_get.
ApiDefinitionsGetOptionalParams	Paramètres facultatifs.
ApiDefinitionsHeadOptionalParams	Paramètres facultatifs.
ApiDefinitionsImportSpecificationHeaders	Définit des en-têtes pour l’opération de ApiDefinitions_importSpecification.
ApiDefinitionsImportSpecificationOptionalParams	Paramètres facultatifs.
ApiDefinitionsListNextOptionalParams	Paramètres facultatifs.
ApiDefinitionsListOptionalParams	Paramètres facultatifs.
ApiListResult	Réponse d’une opération de liste d’API.
ApiProperties	Propriétés de l’API.
ApiSpecExportResult	Résultat de l’exportation de la spécification de l’API.
ApiSpecImportRequest	Propriétés de l’entité source de la spécification de l’API.
ApiSpecImportRequestSpecification	Détails de la spécification de l’API.
ApiVersion	Entité de version de l’API.
ApiVersionListResult	Réponse d’une opération de liste ApiVersion.
ApiVersionProperties	Entité de propriétés de version de l’API.
ApiVersions	Interface représentant une ApiVersions.
ApiVersionsCreateOrUpdateHeaders	Définit des en-têtes pour l’opération ApiVersions_createOrUpdate.
ApiVersionsCreateOrUpdateOptionalParams	Paramètres facultatifs.
ApiVersionsDeleteOptionalParams	Paramètres facultatifs.
ApiVersionsGetHeaders	Définit des en-têtes pour l’opération de ApiVersions_get.
ApiVersionsGetOptionalParams	Paramètres facultatifs.
ApiVersionsHeadOptionalParams	Paramètres facultatifs.
ApiVersionsListNextOptionalParams	Paramètres facultatifs.
ApiVersionsListOptionalParams	Paramètres facultatifs.
Apis	Interface représentant une API.
ApisCreateOrUpdateHeaders	Définit des en-têtes pour l’opération Apis_createOrUpdate.
ApisCreateOrUpdateOptionalParams	Paramètres facultatifs.
ApisDeleteOptionalParams	Paramètres facultatifs.
ApisGetHeaders	Définit des en-têtes pour l’opération de Apis_get.
ApisGetOptionalParams	Paramètres facultatifs.
ApisHeadOptionalParams	Paramètres facultatifs.
ApisListNextOptionalParams	Paramètres facultatifs.
ApisListOptionalParams	Paramètres facultatifs.
AzureAPICenterOptionalParams	Paramètres facultatifs.
Contact	Informations de contact
Deployment	Entité de déploiement d’API.
DeploymentListResult	Réponse d’une opération de liste de déploiement.
DeploymentProperties	Propriétés d’entité de déploiement d’API.
DeploymentServer	Serveur
Deployments	Interface représentant un déploiement.
DeploymentsCreateOrUpdateHeaders	Définit des en-têtes pour l’opération de Deployments_createOrUpdate.
DeploymentsCreateOrUpdateOptionalParams	Paramètres facultatifs.
DeploymentsDeleteOptionalParams	Paramètres facultatifs.
DeploymentsGetHeaders	Définit des en-têtes pour l’opération de Deployments_get.
DeploymentsGetOptionalParams	Paramètres facultatifs.
DeploymentsHeadOptionalParams	Paramètres facultatifs.
DeploymentsListNextOptionalParams	Paramètres facultatifs.
DeploymentsListOptionalParams	Paramètres facultatifs.
Environment	Entité d’environnement.
EnvironmentListResult	Réponse d’une opération de liste d’environnement.
EnvironmentProperties	Entité des propriétés d’environnement.
EnvironmentServer	Informations sur le serveur de l’environnement.
Environments	Interface représentant un environnement.
EnvironmentsCreateOrUpdateHeaders	Définit des en-têtes pour l’opération Environments_createOrUpdate.
EnvironmentsCreateOrUpdateOptionalParams	Paramètres facultatifs.
EnvironmentsDeleteOptionalParams	Paramètres facultatifs.
EnvironmentsGetHeaders	Définit des en-têtes pour l’opération de Environments_get.
EnvironmentsGetOptionalParams	Paramètres facultatifs.
EnvironmentsHeadOptionalParams	Paramètres facultatifs.
EnvironmentsListNextOptionalParams	Paramètres facultatifs.
EnvironmentsListOptionalParams	Paramètres facultatifs.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
ExternalDocumentation	Documentation externe supplémentaire pour l’API.
License	Informations de licence pour l’API.
ManagedServiceIdentity	Identité de service managée (identités affectées par le système et/ou identités affectées par l’utilisateur)
MetadataAssignment	Métadonnées d’affectation
MetadataSchema	Entité de schéma de métadonnées. Permet de définir des métadonnées pour les entités dans le catalogue d’API.
MetadataSchemaExportRequest	Demande d’exportation de schéma de métadonnées.
MetadataSchemaExportResult	Résultat de l’exportation du schéma de métadonnées.
MetadataSchemaListResult	Réponse d’une opération de liste MetadataSchema.
MetadataSchemaProperties	Propriétés du schéma de métadonnées.
MetadataSchemas	Interface représentant un MetadataSchemas.
MetadataSchemasCreateOrUpdateHeaders	Définit des en-têtes pour l’opération MetadataSchemas_createOrUpdate.
MetadataSchemasCreateOrUpdateOptionalParams	Paramètres facultatifs.
MetadataSchemasDeleteOptionalParams	Paramètres facultatifs.
MetadataSchemasGetHeaders	Définit des en-têtes pour l’opération MetadataSchemas_get.
MetadataSchemasGetOptionalParams	Paramètres facultatifs.
MetadataSchemasHeadOptionalParams	Paramètres facultatifs.
MetadataSchemasListNextOptionalParams	Paramètres facultatifs.
MetadataSchemasListOptionalParams	Paramètres facultatifs.
Onboarding	Informations d’intégration
Operation	Détails d’une opération d’API REST, retournée par l’API d’opérations du fournisseur de ressources
OperationDisplay	Informations d’affichage localisées pour cette opération particulière.
OperationListResult	Liste des opérations d’API REST prises en charge par un fournisseur de ressources Azure. Il contient un lien d’URL pour obtenir le jeu de résultats suivant.
Operations	Interface représentant une opération.
OperationsListNextOptionalParams	Paramètres facultatifs.
OperationsListOptionalParams	Paramètres facultatifs.
ProxyResource	Définition du modèle de ressource pour une ressource proxy Azure Resource Manager. Il n’aura pas de balises et un emplacement
Resource	Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager
Service	Entité de service.
ServiceListResult	Réponse d’une opération de liste de services.
ServiceProperties	Propriétés du service.
ServiceUpdate	Type utilisé pour les opérations de mise à jour du service.
Services	Interface représentant un service.
ServicesCreateOrUpdateOptionalParams	Paramètres facultatifs.
ServicesDeleteOptionalParams	Paramètres facultatifs.
ServicesExportMetadataSchemaHeaders	Définit des en-têtes pour l’opération de Services_exportMetadataSchema.
ServicesExportMetadataSchemaOptionalParams	Paramètres facultatifs.
ServicesGetOptionalParams	Paramètres facultatifs.
ServicesListByResourceGroupNextOptionalParams	Paramètres facultatifs.
ServicesListByResourceGroupOptionalParams	Paramètres facultatifs.
ServicesListBySubscriptionNextOptionalParams	Paramètres facultatifs.
ServicesListBySubscriptionOptionalParams	Paramètres facultatifs.
ServicesUpdateOptionalParams	Paramètres facultatifs.
SystemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TermsOfService	Conditions d’utilisation de l’API.
TrackedResource	Définition du modèle de ressource pour une ressource de niveau supérieur suivi d’Azure Resource Manager qui a des « balises » et un « emplacement »
UserAssignedIdentity	Propriétés d’identité attribuées par l’utilisateur
Workspace	Entité d’espace de travail.
WorkspaceListResult	Réponse d’une opération de liste d’espaces de travail.
WorkspaceProperties	Propriétés de l’espace de travail.
Workspaces	Interface représentant un espace de travail.
WorkspacesCreateOrUpdateHeaders	Définit des en-têtes pour l’opération de Workspaces_createOrUpdate.
WorkspacesCreateOrUpdateOptionalParams	Paramètres facultatifs.
WorkspacesDeleteOptionalParams	Paramètres facultatifs.
WorkspacesGetHeaders	Définit des en-têtes pour l’opération Workspaces_get.
WorkspacesGetOptionalParams	Paramètres facultatifs.
WorkspacesHeadOptionalParams	Paramètres facultatifs.
WorkspacesListNextOptionalParams	Paramètres facultatifs.
WorkspacesListOptionalParams	Paramètres facultatifs.

Alias de type

ActionType	Définit des valeurs pour ActionType. KnownActionType peut être utilisé de manière interchangeable avec ActionType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service interne
ApiDefinitionsCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
ApiDefinitionsExportSpecificationResponse	Contient des données de réponse pour l’opération exportSpecification.
ApiDefinitionsGetResponse	Contient des données de réponse pour l’opération d’obtention.
ApiDefinitionsHeadResponse	Contient des données de réponse pour l’opération de tête.
ApiDefinitionsListNextResponse	Contient des données de réponse pour l’opération listNext.
ApiDefinitionsListResponse	Contient des données de réponse pour l’opération de liste.
ApiKind	Définit des valeurs pour ApiKind. KnownApiKind peut être utilisé de manière interchangeable avec ApiKind, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service repos : API de transfert d’état de représentation graphql : API de langage de requête Graph grpc: API gRPC soap: Api SOAP webhook : Crochet Web websocket : Socket Web
ApiSpecExportResultFormat	Définit des valeurs pour ApiSpecExportResultFormat. KnownApiSpecExportResultFormat pouvez être utilisé de manière interchangeable avec ApiSpecExportResultFormat, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service inline : contenu inline d’un document de spécification. lien: lien vers le résultat de l’opération d’exportation. L’URL est valide pendant 5 minutes.
ApiSpecImportSourceFormat	Définit des valeurs pour ApiSpecImportSourceFormat. KnownApiSpecImportSourceFormat pouvez être utilisé de manière interchangeable avec ApiSpecImportSourceFormat, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service inline : contenu inline d’un document de spécification. lien: lien vers un document de spécification hébergé sur une adresse Internet accessible publiquement.
ApiVersionsCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
ApiVersionsGetResponse	Contient des données de réponse pour l’opération d’obtention.
ApiVersionsHeadResponse	Contient des données de réponse pour l’opération de tête.
ApiVersionsListNextResponse	Contient des données de réponse pour l’opération listNext.
ApiVersionsListResponse	Contient des données de réponse pour l’opération de liste.
ApisCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
ApisGetResponse	Contient des données de réponse pour l’opération d’obtention.
ApisHeadResponse	Contient des données de réponse pour l’opération de tête.
ApisListNextResponse	Contient des données de réponse pour l’opération listNext.
ApisListResponse	Contient des données de réponse pour l’opération de liste.
CreatedByType	Définit des valeurs pour CreatedByType. KnownCreatedByType peut être utilisé de manière interchangeable avec CreatedByType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service utilisateur application managedIdentity clé
DeploymentState	Définit des valeurs pour DeploymentState. KnownDeploymentState peut être utilisé de manière interchangeable avec DeploymentState, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service actif : état actif inactif : état inactif
DeploymentsCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
DeploymentsGetResponse	Contient des données de réponse pour l’opération d’obtention.
DeploymentsHeadResponse	Contient des données de réponse pour l’opération de tête.
DeploymentsListNextResponse	Contient des données de réponse pour l’opération listNext.
DeploymentsListResponse	Contient des données de réponse pour l’opération de liste.
EnvironmentKind	Définit des valeurs pour EnvironmentKind. KnownEnvironmentKind peut être utilisé de manière interchangeable avec EnvironmentKind, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service de développement : environnement de développement de test : environnement de test intermédiaire : environnement intermédiaire de production : environnement de production
EnvironmentServerType	Définit des valeurs pour EnvironmentServerType. KnownEnvironmentServerType peut être utilisé de manière interchangeable avec EnvironmentServerType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Gestion des API Azure : Serveur gestion des API du service de calcul Azure : serveur de calcul Apigee API Management: serveur Apigee de passerelle d’API AWS : serveur API Gateway AWS -Kong API Gateway: serveur de passerelle d’API Kong Kubernetes : serveur Kubernetes MuleSoft API Management: serveur Mulesoft Api Management
EnvironmentsCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
EnvironmentsGetResponse	Contient des données de réponse pour l’opération d’obtention.
EnvironmentsHeadResponse	Contient des données de réponse pour l’opération de tête.
EnvironmentsListNextResponse	Contient des données de réponse pour l’opération listNext.
EnvironmentsListResponse	Contient des données de réponse pour l’opération de liste.
LifecycleStage	Définit des valeurs pour LifecycleStage. KnownLifecycleStage peut être utilisé de manière interchangeable avec LifecycleStage, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service de conception : phase de conception de développement : phase de développement de test : phase de test d’aperçu : en préversion de production : en production déconseillée : phase déconseillée mis hors service : étape retirée
ManagedServiceIdentityType	Définit des valeurs pour ManagedServiceIdentityType. KnownManagedServiceIdentityType pouvez être utilisé de manière interchangeable avec ManagedServiceIdentityType, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service Aucun SystemAssigned UserAssigned SystemAssigned,UserAssigned
MetadataAssignmentEntity	Définit des valeurs pour MetadataAssignmentEntity. KnownMetadataAssignmentEntity peut être utilisé de manière interchangeable avec MetadataAssignmentEntity, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service api: affecté à l’API d’environnement : affecté à l’environnement de déploiement : affecté au déploiement
MetadataSchemaExportFormat	Définit des valeurs pour MetadataSchemaExportFormat. KnownMetadataSchemaExportFormat pouvez être utilisé de manière interchangeable avec MetadataSchemaExportFormat, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service inline : contenu inline d’un document de schéma. lien: lien vers un document de schéma. L’URL est valide pendant 5 minutes.
MetadataSchemasCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
MetadataSchemasGetResponse	Contient des données de réponse pour l’opération d’obtention.
MetadataSchemasHeadResponse	Contient des données de réponse pour l’opération de tête.
MetadataSchemasListNextResponse	Contient des données de réponse pour l’opération listNext.
MetadataSchemasListResponse	Contient des données de réponse pour l’opération de liste.
OperationsListNextResponse	Contient des données de réponse pour l’opération listNext.
OperationsListResponse	Contient des données de réponse pour l’opération de liste.
Origin	Définit des valeurs pour Origin. KnownOrigin peut être utilisé de manière interchangeable avec Origin, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service utilisateur système utilisateur,système
ProvisioningState	Définit des valeurs pour ProvisioningState. KnownProvisioningState peut être utilisé de manière interchangeable avec ProvisioningState, cette énumération contient les valeurs connues que le service prend en charge. Valeurs connues prises en charge par le service réussi: la ressource a été créée. échec: échec de la création de ressources. annulé : la création de ressources a été annulée.
ServicesCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
ServicesExportMetadataSchemaResponse	Contient des données de réponse pour l’opération exportMetadataSchema.
ServicesGetResponse	Contient des données de réponse pour l’opération d’obtention.
ServicesListByResourceGroupNextResponse	Contient des données de réponse pour l’opération listByResourceGroupNext.
ServicesListByResourceGroupResponse	Contient des données de réponse pour l’opération listByResourceGroup.
ServicesListBySubscriptionNextResponse	Contient des données de réponse pour l’opération listBySubscriptionNext.
ServicesListBySubscriptionResponse	Contient des données de réponse pour l’opération listBySubscription.
ServicesUpdateResponse	Contient des données de réponse pour l’opération de mise à jour.
Versions	Définit les valeurs des versions. KnownVersions peuvent être utilisés de manière interchangeable avec les versions, cette énumération contient les valeurs connues prises en charge par le service. Valeurs connues prises en charge par le service 2024-03-01: version initiale du service
WorkspacesCreateOrUpdateResponse	Contient des données de réponse pour l’opération createOrUpdate.
WorkspacesGetResponse	Contient des données de réponse pour l’opération d’obtention.
WorkspacesHeadResponse	Contient des données de réponse pour l’opération de tête.
WorkspacesListNextResponse	Contient des données de réponse pour l’opération listNext.
WorkspacesListResponse	Contient des données de réponse pour l’opération de liste.

Énumérations

KnownActionType	Valeurs connues de ActionType que le service accepte.
KnownApiKind	Valeurs connues de ApiKind que le service accepte.
KnownApiSpecExportResultFormat	Valeurs connues de ApiSpecExportResultFormat que le service accepte.
KnownApiSpecImportSourceFormat	Valeurs connues de ApiSpecImportSourceFormat que le service accepte.
KnownCreatedByType	Valeurs connues de CreatedByType que le service accepte.
KnownDeploymentState	Valeurs connues de DeploymentState que le service accepte.
KnownEnvironmentKind	Valeurs connues de EnvironmentKind que le service accepte.
KnownEnvironmentServerType	Valeurs connues de EnvironmentServerType que le service accepte.
KnownLifecycleStage	Valeurs connues de LifecycleStage que le service accepte.
KnownManagedServiceIdentityType	Valeurs connues de ManagedServiceIdentityType que le service accepte.
KnownMetadataAssignmentEntity	Valeurs connues de MetadataAssignmentEntity que le service accepte.
KnownMetadataSchemaExportFormat	Valeurs connues de MetadataSchemaExportFormat que le service accepte.
KnownOrigin	Valeurs connues de Origin que le service accepte.
KnownProvisioningState	Valeurs connues de ProvisioningState que le service accepte.
KnownVersions	Valeurs connues de Versions que le service accepte.

Functions

getContinuationToken(unknown)

Étant donné la dernière .value produite par l’itérateur byPage, retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

Informations relatives à la fonction

getContinuationToken(unknown)

Étant donné la dernière .value produite par l’itérateur byPage, retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

function getContinuationToken(page: unknown): string | undefined

Paramètres

page

unknown

Objet qui accède à value sur IteratorResult à partir d’un itérateur byPage.

Retours

string | undefined

Jeton de continuation qui peut être transmis à byPage() pendant les appels futurs.