Remove-AzApiManagementApi
Syntaxe
Default (Par défaut)
Remove-AzApiManagementApi
-Context <PsApiManagementContext>
-ApiId <String>
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet de commande Remove-AzApiManagementApi supprime une API existante.
Exemples
Exemple 1 : Supprimer une API
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Remove-AzApiManagementApi -Context $apimContext -ApiId "0123456789"
Cette commande supprime l’API avec l’ID spécifié.
Paramètres
-ApiId
Spécifie l’ID de l’API supprimée.
Propriétés du paramètre
Type: String
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: cf
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Context
Spécifie un objet PsApiManagementContext .
Propriétés du paramètre
Type: PsApiManagementContext
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.
Propriétés du paramètre
Type: IAzureContextContainer
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: AzContext, AzureRmContext, AzureCredential
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-PassThru
passthru
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute.
L’applet de commande ne s’exécute pas.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: False Prend en charge les caractères génériques: False DontShow: False Alias: Wi
Jeux de paramètres
(All)
Position: Named Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters .
Sorties