WebPubSub interface

Pacote:

@azure/arm-webpubsub

Interface que representa um WebPubSub.

Métodos

beginCreateOrUpdate(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)	Criar ou atualizar um recurso.
beginCreateOrUpdateAndWait(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)	Criar ou atualizar um recurso.
beginDelete(string, string, WebPubSubDeleteOptionalParams)	Operação para excluir um recurso.
beginDeleteAndWait(string, string, WebPubSubDeleteOptionalParams)	Operação para excluir um recurso.
beginRegenerateKey(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)	Regenerar a chave de acesso para o recurso. PrimaryKey e SecondaryKey não podem ser regenerados ao mesmo tempo.
beginRegenerateKeyAndWait(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)	Regenerar a chave de acesso para o recurso. PrimaryKey e SecondaryKey não podem ser regenerados ao mesmo tempo.
beginRestart(string, string, WebPubSubRestartOptionalParams)	Operação para reiniciar um recurso.
beginRestartAndWait(string, string, WebPubSubRestartOptionalParams)	Operação para reiniciar um recurso.
beginUpdate(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)	Operação para atualizar um recurso de saída.
beginUpdateAndWait(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)	Operação para atualizar um recurso de saída.
checkNameAvailability(string, NameAvailabilityParameters, WebPubSubCheckNameAvailabilityOptionalParams)	Verifica se o nome do recurso é válido e ainda não está em uso.
get(string, string, WebPubSubGetOptionalParams)	Obtenha o recurso e suas propriedades.
listByResourceGroup(string, WebPubSubListByResourceGroupOptionalParams)	Manipula solicitações para listar todos os recursos em um grupo de recursos.
listBySubscription(WebPubSubListBySubscriptionOptionalParams)	Manipula solicitações para listar todos os recursos em uma assinatura.
listKeys(string, string, WebPubSubListKeysOptionalParams)	Obtenha as chaves de acesso do recurso.
listReplicaSkus(string, string, string, WebPubSubListReplicaSkusOptionalParams)	Liste todos os skus disponíveis do recurso de réplica.
listSkus(string, string, WebPubSubListSkusOptionalParams)	Liste todos os skus disponíveis do recurso.

Detalhes do método

beginCreateOrUpdate(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)

Criar ou atualizar um recurso.

function beginCreateOrUpdate(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

parameters

WebPubSubResource

Parâmetros para a operação de criação ou atualização

options

WebPubSubCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<@azure/core-lro.SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>

beginCreateOrUpdateAndWait(string, string, WebPubSubResource, WebPubSubCreateOrUpdateOptionalParams)

Criar ou atualizar um recurso.

function beginCreateOrUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubCreateOrUpdateOptionalParams): Promise<WebPubSubResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

parameters

WebPubSubResource

Parâmetros para a operação de criação ou atualização

options

WebPubSubCreateOrUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<WebPubSubResource>

beginDelete(string, string, WebPubSubDeleteOptionalParams)

Operação para excluir um recurso.

function beginDelete(resourceGroupName: string, resourceName: string, options?: WebPubSubDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

options

WebPubSubDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, WebPubSubDeleteOptionalParams)

Operação para excluir um recurso.

function beginDeleteAndWait(resourceGroupName: string, resourceName: string, options?: WebPubSubDeleteOptionalParams): Promise<void>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

options

WebPubSubDeleteOptionalParams

Os parâmetros de opções.

Retornos

Promise<void>

beginRegenerateKey(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)

Regenerar a chave de acesso para o recurso. PrimaryKey e SecondaryKey não podem ser regenerados ao mesmo tempo.

function beginRegenerateKey(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: WebPubSubRegenerateKeyOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubKeys>, WebPubSubKeys>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

parameters

RegenerateKeyParameters

Parâmetro que descreve a operação regenerar chave.

options

WebPubSubRegenerateKeyOptionalParams

Os parâmetros de opções.

Retornos

Promise<@azure/core-lro.SimplePollerLike<OperationState<WebPubSubKeys>, WebPubSubKeys>>

beginRegenerateKeyAndWait(string, string, RegenerateKeyParameters, WebPubSubRegenerateKeyOptionalParams)

Regenerar a chave de acesso para o recurso. PrimaryKey e SecondaryKey não podem ser regenerados ao mesmo tempo.

function beginRegenerateKeyAndWait(resourceGroupName: string, resourceName: string, parameters: RegenerateKeyParameters, options?: WebPubSubRegenerateKeyOptionalParams): Promise<WebPubSubKeys>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

parameters

RegenerateKeyParameters

Parâmetro que descreve a operação regenerar chave.

options

WebPubSubRegenerateKeyOptionalParams

Os parâmetros de opções.

Retornos

Promise<WebPubSubKeys>

beginRestart(string, string, WebPubSubRestartOptionalParams)

Operação para reiniciar um recurso.

function beginRestart(resourceGroupName: string, resourceName: string, options?: WebPubSubRestartOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubRestartHeaders>, WebPubSubRestartHeaders>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

options

WebPubSubRestartOptionalParams

Os parâmetros de opções.

Retornos

Promise<@azure/core-lro.SimplePollerLike<OperationState<WebPubSubRestartHeaders>, WebPubSubRestartHeaders>>

beginRestartAndWait(string, string, WebPubSubRestartOptionalParams)

Operação para reiniciar um recurso.

function beginRestartAndWait(resourceGroupName: string, resourceName: string, options?: WebPubSubRestartOptionalParams): Promise<WebPubSubRestartHeaders>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

options

WebPubSubRestartOptionalParams

Os parâmetros de opções.

Retornos

Promise<WebPubSubRestartHeaders>

beginUpdate(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)

Operação para atualizar um recurso de saída.

function beginUpdate(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

parameters

WebPubSubResource

Parâmetros para a operação de atualização

options

WebPubSubUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<@azure/core-lro.SimplePollerLike<OperationState<WebPubSubResource>, WebPubSubResource>>

beginUpdateAndWait(string, string, WebPubSubResource, WebPubSubUpdateOptionalParams)

Operação para atualizar um recurso de saída.

function beginUpdateAndWait(resourceGroupName: string, resourceName: string, parameters: WebPubSubResource, options?: WebPubSubUpdateOptionalParams): Promise<WebPubSubResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

parameters

WebPubSubResource

Parâmetros para a operação de atualização

options

WebPubSubUpdateOptionalParams

Os parâmetros de opções.

Retornos

Promise<WebPubSubResource>

checkNameAvailability(string, NameAvailabilityParameters, WebPubSubCheckNameAvailabilityOptionalParams)

Verifica se o nome do recurso é válido e ainda não está em uso.

function checkNameAvailability(location: string, parameters: NameAvailabilityParameters, options?: WebPubSubCheckNameAvailabilityOptionalParams): Promise<NameAvailability>

Parâmetros

location

string

a região

parameters

NameAvailabilityParameters

Parâmetros fornecidos para a operação.

options

WebPubSubCheckNameAvailabilityOptionalParams

Os parâmetros de opções.

Retornos

Promise<NameAvailability>

get(string, string, WebPubSubGetOptionalParams)

Obtenha o recurso e suas propriedades.

function get(resourceGroupName: string, resourceName: string, options?: WebPubSubGetOptionalParams): Promise<WebPubSubResource>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

options

WebPubSubGetOptionalParams

Os parâmetros de opções.

Retornos

Promise<WebPubSubResource>

listByResourceGroup(string, WebPubSubListByResourceGroupOptionalParams)

Manipula solicitações para listar todos os recursos em um grupo de recursos.

function listByResourceGroup(resourceGroupName: string, options?: WebPubSubListByResourceGroupOptionalParams): PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

options

WebPubSubListByResourceGroupOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>

listBySubscription(WebPubSubListBySubscriptionOptionalParams)

Manipula solicitações para listar todos os recursos em uma assinatura.

function listBySubscription(options?: WebPubSubListBySubscriptionOptionalParams): PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>

Parâmetros

options

WebPubSubListBySubscriptionOptionalParams

Os parâmetros de opções.

Retornos

PagedAsyncIterableIterator<WebPubSubResource, WebPubSubResource[], PageSettings>

listKeys(string, string, WebPubSubListKeysOptionalParams)

Obtenha as chaves de acesso do recurso.

function listKeys(resourceGroupName: string, resourceName: string, options?: WebPubSubListKeysOptionalParams): Promise<WebPubSubKeys>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

options

WebPubSubListKeysOptionalParams

Os parâmetros de opções.

Retornos

Promise<WebPubSubKeys>

listReplicaSkus(string, string, string, WebPubSubListReplicaSkusOptionalParams)

Liste todos os skus disponíveis do recurso de réplica.

function listReplicaSkus(resourceGroupName: string, resourceName: string, replicaName: string, options?: WebPubSubListReplicaSkusOptionalParams): Promise<SkuList>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

replicaName

string

O nome da réplica.

options

WebPubSubListReplicaSkusOptionalParams

Os parâmetros de opções.

Retornos

Promise<SkuList>

listSkus(string, string, WebPubSubListSkusOptionalParams)

Liste todos os skus disponíveis do recurso.

function listSkus(resourceGroupName: string, resourceName: string, options?: WebPubSubListSkusOptionalParams): Promise<SkuList>

Parâmetros

resourceGroupName

string

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

resourceName

string

O nome do recurso.

options

WebPubSubListSkusOptionalParams

Os parâmetros de opções.

Retornos

Promise<SkuList>