Delen via

New-AzApiManagementSubscription

  • Referentie
Module:
Az.ApiManagement

Hiermee maakt u een abonnement.

Syntaxis

New-AzApiManagementSubscription
   -Context <PsApiManagementContext>
   [-SubscriptionId <String>]
   -Name <String>
   -UserId <String>
   -ProductId <String>
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-AllowTracing]
   [-State <PsApiManagementSubscriptionState>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]
New-AzApiManagementSubscription
   -Context <PsApiManagementContext>
   [-SubscriptionId <String>]
   -Name <String>
   [-UserId <String>]
   -Scope <String>
   [-PrimaryKey <String>]
   [-SecondaryKey <String>]
   [-AllowTracing]
   [-State <PsApiManagementSubscriptionState>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

Met de cmdlet New-AzApiManagementSubscription maakt u een abonnement.

Voorbeelden

Voorbeeld 1: Een gebruiker abonneren op een product

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999"

Met deze opdracht wordt een bestaande gebruiker geabonneerd op een product.

Voorbeeld 2: Een abonnement maken voor alle API-bereiken

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/apis" -Name "GlobalApiScope"

Voorbeeld 3: Een abonnement maken voor productbereik

$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/products/starter" -Name "UnlimitedProductSub"

Parameters

-AllowTracing

Vlag die bepaalt of tracering kan worden ingeschakeld op abonnementsniveau. Dit is een optionele parameter en de standaardwaarde is $null.

Type:SwitchParameter
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:True
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

-Name

Hiermee geeft u de abonnementsnaam op.

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

-PrimaryKey

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

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

-ProductId

Hiermee geeft u de id op van het product waarop u zich wilt abonneren.

Type:String
Position:Named
Default value:None
Vereist:True
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:True
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 256 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 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

-SubscriptionId

Hiermee geeft u de abonnements-id op. Deze parameter wordt gegenereerd als deze niet is opgegeven.

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

-UserId

Hiermee geeft u de abonnee-id.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
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]]

Uitvoerwaarden

PsApiManagementSubscription