Delen via

Set-AzApiManagementSubscription

  • Referentie
Module:
Az.ApiManagement

Hiermee stelt u bestaande abonnementsgegevens in.

Syntaxis

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

Met de cmdlet Set-AzApiManagementSubscription worden bestaande abonnementsgegevens ingesteld.

Voorbeelden

Voorbeeld 1: De status en primaire en secundaire sleutels voor een abonnement instellen

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active"

Met deze opdracht worden de primaire en secundaire sleutels voor een abonnement ingesteld en geactiveerd.

Parameters

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

Type:SwitchParameter
Aliassen:cf
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Context

Hiermee geeft u een PsApiManagementContext-object .

Type:PsApiManagementContext
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-DefaultProfile

De referenties, het account, de tenant en het abonnement die worden gebruikt voor communicatie met Azure.

Type:IAzureContextContainer
Aliassen:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ExpiresOn

Hiermee geeft u een vervaldatum voor het abonnement op. De standaardwaarde van deze parameter is $Null.

Type:Nullable<T>[DateTime]
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-InputObject

Exemplaar van PsApiManagementSubscription. Deze parameter is vereist.

Type:PsApiManagementSubscription
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Name

Hiermee geeft u een abonnementsnaam op.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-PassThru

passthru

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-PrimaryKey

Hiermee geeft u de primaire sleutel van het abonnement op. Deze parameter wordt automatisch gegenereerd als deze niet is opgegeven. Deze parameter moet 1 tot 300 tekens lang zijn.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Scope

Het bereik van het abonnement, ongeacht of het api-bereik /apis/{apiId} of productbereik /products/{productId} of global API Scope /apis of global scope /is. Deze parameter is vereist.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SecondaryKey

Hiermee geeft u de secundaire abonnementssleutel op. Deze parameter wordt automatisch gegenereerd als deze niet is opgegeven. Deze parameter moet 1 tot 300 tekens lang zijn.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-State

Hiermee geeft u de abonnementsstatus op. De standaardwaarde van deze parameter is $Null.

Type:Nullable<T>[PsApiManagementSubscriptionState]
Geaccepteerde waarden:Suspended, Active, Expired, Submitted, Rejected, Cancelled
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-StateComment

Hiermee geeft u de opmerking van de abonnementsstatus op. De standaardwaarde van deze parameter is $Null.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-SubscriptionId

Hiermee geeft u de abonnements-id op.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-UserId

De eigenaar van het abonnement. Deze parameter is optioneel.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

Type:SwitchParameter
Aliassen:wi
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

PsApiManagementContext

String

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]]

SwitchParameter

Uitvoerwaarden

PsApiManagementSubscription