Set-AzApiManagementSubscription
Nastaví podrobnosti o existujícím předplatném.
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>]
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>]
Description
Rutina Set-AzApiManagementSubscription nastaví podrobnosti o existujícím předplatném.
Příklady
Příklad 1: Nastavení stavu a primárního a sekundárního klíče pro předplatné
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active"
Tento příkaz nastaví primární a sekundární klíče pro předplatné a aktivuje ho.
Parametry
-Confirm
Před spuštěním rutiny zobrazí výzvu k potvrzení.
Typ: | SwitchParameter |
Aliases: | cf |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Context
Určuje PsApiManagementContext objektu.
Typ: | PsApiManagementContext |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
Přihlašovací údaje, účet, tenant a předplatné používané ke komunikaci s Azure.
Typ: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ExpiresOn
Určuje datum vypršení platnosti předplatného. Výchozí hodnota tohoto parametru je $Null.
Typ: | Nullable<T>[DateTime] |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InputObject
Instance of PsApiManagementSubscription. Tento parametr je povinný.
Typ: | PsApiManagementSubscription |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Určuje název předplatného.
Typ: | String |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PassThru
passthru
Typ: | SwitchParameter |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-PrimaryKey
Určuje primární klíč předplatného. Tento parametr se vygeneruje automaticky, pokud není zadaný. Tento parametr musí mít délku 1 až 300 znaků.
Typ: | String |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Scope
Rozsah předplatného, ať už se jedná o obor rozhraní API /apis/{apiId} nebo rozsah produktu /products/{productId} nebo globální obor rozhraní API /apis nebo globální obor /. Tento parametr je povinný.
Typ: | String |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SecondaryKey
Určuje sekundární klíč předplatného. Tento parametr se vygeneruje automaticky, pokud není zadaný. Tento parametr musí mít délku 1 až 300 znaků.
Typ: | String |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-State
Určuje stav předplatného. Výchozí hodnota tohoto parametru je $Null.
Typ: | Nullable<T>[PsApiManagementSubscriptionState] |
přijímané hodnoty: | Suspended, Active, Expired, Submitted, Rejected, Cancelled |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-StateComment
Určuje komentář stavu předplatného. Výchozí hodnota tohoto parametru je $Null.
Typ: | String |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-SubscriptionId
Určuje ID předplatného.
Typ: | String |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-UserId
Vlastník předplatného. Tento parametr je volitelný.
Typ: | String |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-WhatIf
Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.
Typ: | SwitchParameter |
Aliases: | wi |
Position: | Named |
výchozí hodnota: | None |
Vyžadováno: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Vstupy
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]
Výstupy
Související odkazy
Azure PowerShell
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro