Condividi tramite

Set-AzApiManagementSubscription

  • Riferimento
Modulo:
Az.ApiManagement

Imposta i dettagli della sottoscrizione esistente.

Sintassi

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

Descrizione

Il cmdlet Set-AzApiManagementSubscription imposta i dettagli della sottoscrizione esistenti.

Esempio

Esempio 1: Impostare lo stato e le chiavi primarie e secondarie per una sottoscrizione

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

Questo comando imposta le chiavi primarie e secondarie per una sottoscrizione e la attiva.

Parametri

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Alias:cf
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Context

Specifica un oggetto PsApiManagementContext .

Tipo:PsApiManagementContext
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-DefaultProfile

Credenziali, account, tenant e sottoscrizione usati per la comunicazione con Azure.

Tipo:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-ExpiresOn

Specifica una data di scadenza della sottoscrizione. Il valore predefinito di questo parametro è $Null.

Tipo:Nullable<T>[DateTime]
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-InputObject

Istanza di PsApiManagementSubscription. Questo parametro è obbligatorio.

Tipo:PsApiManagementSubscription
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Name

Specifica un nome di sottoscrizione.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-PassThru

passthru

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-PrimaryKey

Specifica la chiave primaria della sottoscrizione. Questo parametro viene generato automaticamente se non specificato. Questo parametro deve essere lungo da 1 a 300 caratteri.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Scope

Ambito della sottoscrizione, ovvero ambito API /apis/{apiId} o Ambito prodotto /products/{productId} o Ambito API globale /apis o ambito globale /. Questo parametro è obbligatorio.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-SecondaryKey

Specifica la chiave secondaria della sottoscrizione. Questo parametro viene generato automaticamente se non specificato. Questo parametro deve essere lungo da 1 a 300 caratteri.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-State

Specifica lo stato della sottoscrizione. Il valore predefinito di questo parametro è $Null.

Tipo:Nullable<T>[PsApiManagementSubscriptionState]
Valori accettati:Suspended, Active, Expired, Submitted, Rejected, Cancelled
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-StateComment

Specifica il commento sullo stato della sottoscrizione. Il valore predefinito di questo parametro è $Null.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-SubscriptionId

Specifica l'ID sottoscrizione.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-UserId

Proprietario della sottoscrizione. Questo parametro è facoltativo.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-WhatIf

Mostra cosa accadrebbe se il cmdlet viene eseguito. Il cmdlet non viene eseguito.

Tipo:SwitchParameter
Alias:wi
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

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

Output

PsApiManagementSubscription