Partilhar via

Set-AzApiManagementSubscription

  • Referência
Módulo:
Az.ApiManagement

Define os detalhes da subscrição existente.

Sintaxe

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

O cmdlet Set-AzApiManagementSubscription define os detalhes da assinatura existente.

Exemplos

Exemplo 1: Definir o estado e as chaves primária e secundária de uma subscrição

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

Este comando define as chaves primária e secundária de uma subscrição e ativa-a.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

Tipo:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Context

Especifica um objeto PsApiManagementContext .

Tipo:PsApiManagementContext
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o azure.

Tipo:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ExpiresOn

Especifica uma data de expiração da assinatura. O valor padrão desse parâmetro é $Null.

Tipo:Nullable<T>[DateTime]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-InputObject

Instância de PsApiManagementSubscription. Este parâmetro é obrigatório.

Tipo:PsApiManagementSubscription
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Name

Especifica um nome de assinatura.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-PassThru

Passthru

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-PrimaryKey

Especifica a chave primária da assinatura. Este parâmetro é gerado automaticamente se não for especificado. Este parâmetro deve ter de 1 a 300 caracteres.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-Scope

O Escopo da Assinatura, seja Api Scope /apis/{apiId} ou Product Scope /products/{productId} ou Global API Scope /apis ou Global scope /. Este parâmetro é obrigatório.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-SecondaryKey

Especifica a chave secundária da assinatura. Este parâmetro é gerado automaticamente se não for especificado. Este parâmetro deve ter de 1 a 300 caracteres.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-State

Especifica o estado da assinatura. O valor padrão desse parâmetro é $Null.

Tipo:Nullable<T>[PsApiManagementSubscriptionState]
Valores aceites:Suspended, Active, Expired, Submitted, Rejected, Cancelled
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-StateComment

Especifica o comentário do estado da assinatura. O valor padrão desse parâmetro é $Null.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-SubscriptionId

Especifica a ID da assinatura.

Tipo:String
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-UserId

O proprietário da assinatura. Este parâmetro é opcional.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

Tipo:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

Entradas

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

Saídas

PsApiManagementSubscription