Set-AzApiManagementSubscription
Legt vorhandene Abonnementdetails fest.
Syntax
Set-AzApiManagementSubscription
-InputObject <PsApiManagementSubscription>
[-Scope <String>]
[-UserId <String>]
[-Name <String>]
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-State <PsApiManagementSubscriptionState>]
[-ExpiresOn <DateTime>]
[-StateComment <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ExpandedParameter
Set-AzApiManagementSubscription
-Context <PsApiManagementContext>
-SubscriptionId <String>
[-Scope <String>]
[-UserId <String>]
[-Name <String>]
[-PrimaryKey <String>]
[-SecondaryKey <String>]
[-State <PsApiManagementSubscriptionState>]
[-ExpiresOn <DateTime>]
[-StateComment <String>]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Beschreibung
Das Cmdlet Set-AzApiManagementSubscription legt vorhandene Abonnementdetails fest.
Beispiele
Beispiel 1: Festlegen des Status und der primären und sekundären Schlüssel für ein Abonnement
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active"
Mit diesem Befehl werden die primären und sekundären Schlüssel für ein Abonnement festgelegt und aktiviert.
Parameter
-Confirm
Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: Cf
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Context
Gibt ein PsApiManagementContext -Objekt an.
Parametereigenschaften
Parametersätze
ExpandedParameter
Position: Named Obligatorisch: True Wert aus Pipeline: True Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-DefaultProfile
Die Anmeldeinformationen, Konten, Mandanten und Abonnements, die für die Kommunikation mit Azure verwendet werden.
Parametereigenschaften
Typ: IAzureContextContainer
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: AzContext, AzureRmContext, AzureCredential
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-ExpiresOn
Gibt ein Ablaufdatum für Abonnements an.
Der Standardwert dieses Parameters ist $Null.
Parametereigenschaften
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
Instanz von PsApiManagementSubscription. Dieser Parameter ist erforderlich.
ByInputObject
Position: Named Obligatorisch: True Wert aus Pipeline: True Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
-Name
Gibt einen Abonnementnamen an.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-PassThru
Passthru
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-PrimaryKey
Gibt den Primärschlüssel des Abonnements an.
Dieser Parameter wird automatisch generiert, wenn er nicht angegeben wird.
Dieser Parameter muss 1 bis 300 Zeichen lang sein.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-Scope
Der Bereich des Abonnements, unabhängig davon, ob es sich um den API-Bereich /apis/{apiId} oder den Produktbereich /products/{productId} oder den globalen API-Bereich /apis oder den globalen Bereich /apis handelt. Dieser Parameter ist erforderlich.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-SecondaryKey
Gibt den sekundären Abonnementschlüssel an.
Dieser Parameter wird automatisch generiert, wenn er nicht angegeben wird.
Dieser Parameter muss 1 bis 300 Zeichen lang sein.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-State
Gibt den Abonnementstatus an.
Der Standardwert dieses Parameters ist $Null.
Parametereigenschaften
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
Gibt den Kommentar zum Abonnementstatus an.
Der Standardwert dieses Parameters ist $Null.
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-SubscriptionId
Gibt die Abonnement-ID an.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
ExpandedParameter
Position: Named Obligatorisch: True Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-UserId
Der Besitzer des Abonnements. Dieser Parameter ist optional.
Parametereigenschaften
Typ: String
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: True Wert aus verbleibenden Argumenten: False
-WhatIf
Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
Parametereigenschaften
Typ: SwitchParameter
Standardwert: None Unterstützt Platzhalter: False Nicht anzeigen: False Aliase: Wi
Parametersätze
(All)
Position: Named Obligatorisch: False Wert aus Pipeline: False Wert aus Pipeline nach dem Eigenschaftsnamen: False Wert aus verbleibenden Argumenten: False
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters .
Ausgaben
