Subscription interface
Interface que representa uma Assinatura.
Métodos
Detalhes do método
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
Cria ou atualiza a assinatura do usuário especificado para o produto especificado.
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- sid
-
string
Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto em Gerenciamento de API.
- parameters
- SubscriptionCreateParameters
Criar parâmetros.
Os parâmetros de opções.
Retornos
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
Exclui uma assinatura especificada.
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- sid
-
string
Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto em Gerenciamento de API.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- options
- SubscriptionDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
Obtém a entidade subscription especificada.
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- sid
-
string
Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto em Gerenciamento de API.
- options
- SubscriptionGetOptionalParams
Os parâmetros de opções.
Retornos
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) da assinatura apimanagement especificada por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- sid
-
string
Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto em Gerenciamento de API.
Os parâmetros de opções.
Retornos
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
Lista todas as assinaturas da instância do serviço de Gerenciamento de API.
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- options
- SubscriptionListOptionalParams
Os parâmetros de opções.
Retornos
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
Obtém as chaves de assinatura especificadas.
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- sid
-
string
Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto em Gerenciamento de API.
Os parâmetros de opções.
Retornos
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
Regenera a chave primária da assinatura existente da instância do serviço de Gerenciamento de API.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- sid
-
string
Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto em Gerenciamento de API.
Os parâmetros de opções.
Retornos
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
Regenera a chave secundária da assinatura existente da instância do serviço de Gerenciamento de API.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- sid
-
string
Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto em Gerenciamento de API.
Os parâmetros de opções.
Retornos
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
Atualizações os detalhes de uma assinatura especificada por seu identificador.
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- sid
-
string
Identificador de entidade de assinatura. A entidade representa a associação entre um usuário e um produto em Gerenciamento de API.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- SubscriptionUpdateParameters
Atualizar parâmetros.
- options
- SubscriptionUpdateOptionalParams
Os parâmetros de opções.
Retornos
Promise<SubscriptionUpdateResponse>