Update-AzApiManagementGateway
Konfiguriert ein API-Verwaltungsgateway.
Syntax
Update-AzApiManagementGateway
-Context <PsApiManagementContext>
-GatewayId <String>
[-Description <String>]
[-LocationData <PsApiManagementResourceLocation>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzApiManagementGateway
-InputObject <PsApiManagementGateway>
[-Description <String>]
[-LocationData <PsApiManagementResourceLocation>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Update-AzApiManagementGateway
-ResourceId <String>
[-Description <String>]
[-LocationData <PsApiManagementResourceLocation>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Beschreibung
Das cmdlet Update-AzApiManagementGateway konfiguriert ein API-Verwaltungsgateway.
Beispiele
Beispiel 1: Konfigurieren einer Verwaltungsgruppe
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Update-AzApiManagementGateway -Context $apimContext -GatewayId "0001" -Description "Updated Gateway"
Mit diesem Befehl wird ein Gateway konfiguriert.
Parameter
-Confirm
Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.
Typ: | SwitchParameter |
Aliase: | cf |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-Context
Instanz von PsApiManagementContext. Dieser Parameter ist erforderlich.
Typ: | PsApiManagementContext |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-DefaultProfile
Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.
Typ: | IAzureContextContainer |
Aliase: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
-Description
Gatewaybeschreibung. Dieser Parameter ist optional.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-GatewayId
Bezeichner des vorhandenen Gateways. Dieser Parameter ist erforderlich.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-InputObject
Instanz von PsApiManagementGateway. Dieser Parameter ist erforderlich.
Typ: | PsApiManagementGateway |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-LocationData
Gatewayspeicherort. Dieser Parameter ist optional.
Typ: | PsApiManagementResourceLocation |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-PassThru
Wenn angegeben, wird die Instanz von Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGateway-Typ angegeben, der das geänderte Gateway darstellt.
Typ: | SwitchParameter |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-ResourceId
Arm ResourceId des Gateways. Dieser Parameter ist erforderlich.
Typ: | String |
Position: | Named |
Standardwert: | None |
Erforderlich: | True |
Pipelineeingabe akzeptieren: | True |
Platzhalterzeichen akzeptieren: | False |
-WhatIf
Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
Typ: | SwitchParameter |
Aliase: | wi |
Position: | Named |
Standardwert: | None |
Erforderlich: | False |
Pipelineeingabe akzeptieren: | False |
Platzhalterzeichen akzeptieren: | False |
Eingaben
PsApiManagementResourceLocation
Ausgaben
Azure PowerShell