WorkspaceSubscription interface
Interface que representa um WorkspaceSubscription.
Métodos
Detalhes de Método
createOrUpdate(string, string, string, string, SubscriptionCreateParameters, WorkspaceSubscriptionCreateOrUpdateOptionalParams)
Cria ou atualiza a assinatura do usuário especificado para o produto especificado.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, parameters: SubscriptionCreateParameters, options?: WorkspaceSubscriptionCreateOrUpdateOptionalParams): Promise<WorkspaceSubscriptionCreateOrUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- sid
-
string
Identificador da entidade de subscrição. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.
- parameters
- SubscriptionCreateParameters
Crie parâmetros.
Os parâmetros de opções.
Devoluções
delete(string, string, string, string, string, WorkspaceSubscriptionDeleteOptionalParams)
Exclui a assinatura especificada.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, options?: WorkspaceSubscriptionDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- sid
-
string
Identificador da entidade de subscrição. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, string, WorkspaceSubscriptionGetOptionalParams)
Obtém a entidade Subscription especificada.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetOptionalParams): Promise<WorkspaceSubscriptionGetResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- sid
-
string
Identificador da entidade de subscrição. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceSubscriptionGetResponse>
getEntityTag(string, string, string, string, WorkspaceSubscriptionGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) da assinatura apimanagement especificada por seu identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionGetEntityTagOptionalParams): Promise<WorkspaceSubscriptionGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- sid
-
string
Identificador da entidade de subscrição. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.
Os parâmetros de opções.
Devoluções
list(string, string, string, WorkspaceSubscriptionListOptionalParams)
Lista todas as assinaturas do espaço de trabalho em uma instância de serviço de Gerenciamento de API.
function list(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceSubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
Os parâmetros de opções.
Devoluções
listSecrets(string, string, string, string, WorkspaceSubscriptionListSecretsOptionalParams)
Obtém as chaves de Assinatura especificadas.
function listSecrets(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionListSecretsOptionalParams): Promise<WorkspaceSubscriptionListSecretsResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- sid
-
string
Identificador da entidade de subscrição. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.
Os parâmetros de opções.
Devoluções
regeneratePrimaryKey(string, string, string, string, WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams)
Regenera a chave primária da assinatura existente do espaço de trabalho em uma instância de serviço de Gerenciamento de API.
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- sid
-
string
Identificador da entidade de subscrição. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.
Os parâmetros de opções.
Devoluções
Promise<void>
regenerateSecondaryKey(string, string, string, string, WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams)
Regenera a chave secundária da assinatura existente do espaço de trabalho em uma instância de serviço de Gerenciamento de API.
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, options?: WorkspaceSubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- sid
-
string
Identificador da entidade de subscrição. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.
Os parâmetros de opções.
Devoluções
Promise<void>
update(string, string, string, string, string, SubscriptionUpdateParameters, WorkspaceSubscriptionUpdateOptionalParams)
Atualiza os detalhes de uma assinatura especificada por seu identificador.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: WorkspaceSubscriptionUpdateOptionalParams): Promise<WorkspaceSubscriptionUpdateResponse>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- workspaceId
-
string
Identificador do espaço de trabalho. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
- sid
-
string
Identificador da entidade de subscrição. A entidade representa a associação entre um usuário e um produto no Gerenciamento de API.
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.
- parameters
- SubscriptionUpdateParameters
Atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<WorkspaceSubscriptionUpdateResponse>