ApiPortals interface
Interface représentant une ApiPortals.
Méthodes
| begin |
Créez le portail d’API par défaut ou mettez à jour le portail d’API existant. |
| begin |
Créez le portail d’API par défaut ou mettez à jour le portail d’API existant. |
| begin |
Supprimez le portail d’API par défaut. |
| begin |
Supprimez le portail d’API par défaut. |
| get(string, string, string, Api |
Obtenez le portail d’API et ses propriétés. |
| list(string, string, Api |
Gère les demandes pour répertorier toutes les ressources d’un service. |
| validate |
Vérifiez que les domaines sont valides et non utilisés. |
Détails de la méthode
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Créez le portail d’API par défaut ou mettez à jour le portail d’API existant.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
- serviceName
-
string
Nom de la ressource de service.
- apiPortalName
-
string
Nom du portail d’API.
- apiPortalResource
- ApiPortalResource
Portail d’API pour l’opération de création ou de mise à jour
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Créez le portail d’API par défaut ou mettez à jour le portail d’API existant.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
- serviceName
-
string
Nom de la ressource de service.
- apiPortalName
-
string
Nom du portail d’API.
- apiPortalResource
- ApiPortalResource
Portail d’API pour l’opération de création ou de mise à jour
Paramètres d’options.
Retours
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
Supprimez le portail d’API par défaut.
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
- serviceName
-
string
Nom de la ressource de service.
- apiPortalName
-
string
Nom du portail d’API.
- options
- ApiPortalsDeleteOptionalParams
Paramètres d’options.
Retours
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
Supprimez le portail d’API par défaut.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
- serviceName
-
string
Nom de la ressource de service.
- apiPortalName
-
string
Nom du portail d’API.
- options
- ApiPortalsDeleteOptionalParams
Paramètres d’options.
Retours
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
Obtenez le portail d’API et ses propriétés.
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
- serviceName
-
string
Nom de la ressource de service.
- apiPortalName
-
string
Nom du portail d’API.
- options
- ApiPortalsGetOptionalParams
Paramètres d’options.
Retours
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
Gère les demandes pour répertorier toutes les ressources d’un service.
function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
- serviceName
-
string
Nom de la ressource de service.
- options
- ApiPortalsListOptionalParams
Paramètres d’options.
Retours
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
Vérifiez que les domaines sont valides et non utilisés.
function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>Paramètres
- resourceGroupName
-
string
Nom du groupe de ressources qui contient la ressource. Vous pouvez obtenir cette valeur à partir de l’API Azure Resource Manager ou du portail.
- serviceName
-
string
Nom de la ressource de service.
- apiPortalName
-
string
Nom du portail d’API.
- validatePayload
- CustomDomainValidatePayload
Charge utile de domaine personnalisée à valider
Paramètres d’options.
Retours
Promise<CustomDomainValidateResult>
