Dela via

New-AzApiManagementSubscription

  • Referens
Modul:
Az.ApiManagement

Skapar en prenumeration.

Syntax

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

Cmdleten New-AzApiManagementSubscription skapar en prenumeration.

Exempel

Exempel 1: Prenumerera en användare på en produkt

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

Det här kommandot prenumererar en befintlig användare på en produkt.

Exempel 2: Skapa en prenumeration för alla API-omfång

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

Exempel 3: Skapa en prenumeration för produktomfattning

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

Parametrar

-AllowTracing

Flagga som avgör om spårning kan aktiveras på prenumerationsnivå. Det här är valfri parameter och standardvärdet är $null.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Context

Anger ett PsApiManagementContext- objekt.

Typ:PsApiManagementContext
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Name

Anger prenumerationsnamnet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-PrimaryKey

Anger prenumerationens primära nyckel. Om den här parametern inte anges genereras nyckeln automatiskt. Den här parametern måste vara mellan 1 och 256 tecken lång.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ProductId

Anger ID för den produkt som du vill prenumerera på.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Scope

Prenumerationens omfång, oavsett om det är Api Scope /apis/{apiId} eller Product Scope /products/{productId} eller Global API Scope /apis eller Global scope /. Den här parametern krävs.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SecondaryKey

Anger den sekundära prenumerationsnyckeln. Den här parametern genereras automatiskt om den inte anges. Den här parametern måste vara mellan 1 och 256 tecken lång.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-State

Anger prenumerationstillståndet. Standardvärdet är $Null.

Typ:Nullable<T>[PsApiManagementSubscriptionState]
Godkända värden:Suspended, Active, Expired, Submitted, Rejected, Cancelled
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SubscriptionId

Anger prenumerations-ID:t. Den här parametern genereras om den inte anges.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-UserId

Anger prenumerant-ID:t.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

Indata

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

Utdata

PsApiManagementSubscription