New-AzApiManagementSubscription
Crea una suscripción.
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
El cmdlet New-AzApiManagementSubscription crea una suscripción.
Ejemplos
Ejemplo 1: Suscribir un usuario a un producto
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999"Este comando suscribe un usuario existente a un producto.
Ejemplo 2: Creación de una suscripción para todo el ámbito de api
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/apis" -Name "GlobalApiScope"Ejemplo 3: Crear una suscripción para el ámbito del producto
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementSubscription -Context $apimContext -Scope "/products/starter" -Name "UnlimitedProductSub"Parámetros
-AllowTracing
Marca que determina si el seguimiento se puede habilitar en el nivel de suscripción. Este es el parámetro opcional y el valor predeterminado es $null.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Context
Especifica un objeto PsApiManagementContext .
| Type: | PsApiManagementContext |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DefaultProfile
Las credenciales, la cuenta, el inquilino y la suscripción que se usan para la comunicación con Azure.
| Type: | IAzureContextContainer |
| Aliases: | AzContext, AzureRmContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Especifica el nombre de la suscripción.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-PrimaryKey
Especifica la clave principal de la suscripción. Si no se especifica este parámetro, la clave se genera automáticamente. Este parámetro debe tener entre 1 y 256 caracteres.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ProductId
Especifica el identificador del producto al que se va a suscribir.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Scope
El ámbito de la suscripción, ya sea ámbito de api /apis/{apiId} o ámbito de producto /products/{productId} o ámbito de API global /apis o ámbito global /. Este parámetro es obligatorio.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SecondaryKey
Especifica la clave secundaria de la suscripción. Este parámetro se genera automáticamente si no se especifica. Este parámetro debe tener entre 1 y 256 caracteres.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-State
Especifica el estado de la suscripción. El valor predeterminado es $Null.
| Type: | Nullable<T>[PsApiManagementSubscriptionState] |
| Accepted values: | Suspended, Active, Expired, Submitted, Rejected, Cancelled |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SubscriptionId
Especifica el identificador de suscripción. Este parámetro se genera si no se especifica.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-UserId
Especifica el identificador de suscriptor.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Entradas
Nullable<T>[[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscriptionState, Microsoft.Azure.PowerShell.Cmdlets.ApiManagement.ServiceManagement, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]