Share via

Registrations interface

  • Reference
Package:
@azure/arm-azurestack

Interface representing a Registrations.

Methods

createOrUpdate(string, string, RegistrationParameter, RegistrationsCreateOrUpdateOptionalParams)

Create or update an Azure Stack registration.
delete(string, string, RegistrationsDeleteOptionalParams)

Delete the requested Azure Stack registration.
enableRemoteManagement(string, string, RegistrationsEnableRemoteManagementOptionalParams)

Enables remote management for device under the Azure Stack registration.
get(string, string, RegistrationsGetOptionalParams)

Returns the properties of an Azure Stack registration.
getActivationKey(string, string, RegistrationsGetActivationKeyOptionalParams)

Returns Azure Stack Activation Key.
list(string, RegistrationsListOptionalParams)

Returns a list of all registrations.
listBySubscription(RegistrationsListBySubscriptionOptionalParams)

Returns a list of all registrations under current subscription.
update(string, string, RegistrationParameter, RegistrationsUpdateOptionalParams)

Patch an Azure Stack registration.

Method Details

createOrUpdate(string, string, RegistrationParameter, RegistrationsCreateOrUpdateOptionalParams)

Create or update an Azure Stack registration.

function createOrUpdate(resourceGroup: string, registrationName: string, token: RegistrationParameter, options?: RegistrationsCreateOrUpdateOptionalParams): Promise<Registration>

Parameters

resourceGroup

string

Name of the resource group.

registrationName

string

Name of the Azure Stack registration.

token
RegistrationParameter

Registration token

options
RegistrationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Registration>

delete(string, string, RegistrationsDeleteOptionalParams)

Delete the requested Azure Stack registration.

function delete(resourceGroup: string, registrationName: string, options?: RegistrationsDeleteOptionalParams): Promise<void>

Parameters

resourceGroup

string

Name of the resource group.

registrationName

string

Name of the Azure Stack registration.

options
RegistrationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

enableRemoteManagement(string, string, RegistrationsEnableRemoteManagementOptionalParams)

Enables remote management for device under the Azure Stack registration.

function enableRemoteManagement(resourceGroup: string, registrationName: string, options?: RegistrationsEnableRemoteManagementOptionalParams): Promise<void>

Parameters

resourceGroup

string

Name of the resource group.

registrationName

string

Name of the Azure Stack registration.

options
RegistrationsEnableRemoteManagementOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, RegistrationsGetOptionalParams)

Returns the properties of an Azure Stack registration.

function get(resourceGroup: string, registrationName: string, options?: RegistrationsGetOptionalParams): Promise<Registration>

Parameters

resourceGroup

string

Name of the resource group.

registrationName

string

Name of the Azure Stack registration.

options
RegistrationsGetOptionalParams

The options parameters.

Returns

Promise<Registration>

getActivationKey(string, string, RegistrationsGetActivationKeyOptionalParams)

Returns Azure Stack Activation Key.

function getActivationKey(resourceGroup: string, registrationName: string, options?: RegistrationsGetActivationKeyOptionalParams): Promise<ActivationKeyResult>

Parameters

resourceGroup

string

Name of the resource group.

registrationName

string

Name of the Azure Stack registration.

options
RegistrationsGetActivationKeyOptionalParams

The options parameters.

Returns

Promise<ActivationKeyResult>

list(string, RegistrationsListOptionalParams)

Returns a list of all registrations.

function list(resourceGroup: string, options?: RegistrationsListOptionalParams): PagedAsyncIterableIterator<Registration, Registration[], PageSettings>

Parameters

resourceGroup

string

Name of the resource group.

options
RegistrationsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Registration, Registration[], PageSettings>

listBySubscription(RegistrationsListBySubscriptionOptionalParams)

Returns a list of all registrations under current subscription.

function listBySubscription(options?: RegistrationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Registration, Registration[], PageSettings>

Parameters

options
RegistrationsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Registration, Registration[], PageSettings>

update(string, string, RegistrationParameter, RegistrationsUpdateOptionalParams)

Patch an Azure Stack registration.

function update(resourceGroup: string, registrationName: string, token: RegistrationParameter, options?: RegistrationsUpdateOptionalParams): Promise<Registration>

Parameters

resourceGroup

string

Name of the resource group.

registrationName

string

Name of the Azure Stack registration.

token
RegistrationParameter

Registration token

options
RegistrationsUpdateOptionalParams

The options parameters.

Returns

Promise<Registration>