Set-AzApiManagementSubscription
Define os detalhes da assinatura 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árias e secundárias de uma assinatura
$apimContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active"Esse comando define as chaves primárias e secundárias de uma assinatura e a ativa.
Parâmetros
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
| Tipo: | SwitchParameter |
| Aliases: | cf |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Context
Especifica um objeto PsApiManagementContext .
| Tipo: | PsApiManagementContext |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | 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 |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ExpiresOn
Especifica uma data de expiração da assinatura. O valor padrão desse parâmetro é $Null.
| Tipo: | Nullable<T>[DateTime] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-InputObject
Instância de PsApiManagementSubscription. Este parâmetro é obrigatório.
| Tipo: | PsApiManagementSubscription |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-Name
Especifica um nome de assinatura.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-PassThru
passagem
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-PrimaryKey
Especifica a chave primária da assinatura. Esse parâmetro é gerado automaticamente se não for especificado. Esse parâmetro deve ter de 1 a 300 caracteres.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-Scope
O Escopo da Assinatura, seja o Escopo da API /apis/{apiId} ou o Escopo do Produto /products/{productId} ou o Escopo Global da API /apis ou o Escopo Global /. Este parâmetro é obrigatório.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-SecondaryKey
Especifica a chave secundária da assinatura. Esse parâmetro é gerado automaticamente se não for especificado. Esse parâmetro deve ter de 1 a 300 caracteres.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-State
Especifica o estado da assinatura. O valor padrão desse parâmetro é $Null.
| Tipo: | Nullable<T>[PsApiManagementSubscriptionState] |
| Valores aceitos: | Suspended, Active, Expired, Submitted, Rejected, Cancelled |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-StateComment
Especifica o comentário do estado da assinatura. O valor padrão desse parâmetro é $Null.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-SubscriptionId
Especifica a ID da assinatura.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-UserId
O proprietário da assinatura. Esse parâmetro é opcional.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
| Tipo: | SwitchParameter |
| Aliases: | wi |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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]]
Nullable<T>[[System.DateTime, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]