@datafire/azure_azurestack_registration v4.0.0

@datafire/azure_azurestack_registration

Client library for Azure Stack Azure Bridge Client

Installation and Usage

npm install --save @datafire/azure_azurestack_registration

let azure_azurestack_registration = require('@datafire/azure_azurestack_registration').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

Registrations_List

Returns a list of all registrations.

azure_azurestack_registration.Registrations_List({
  "subscriptionId": "",
  "resourceGroup": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • resourceGroup required string: Name of the resource group.
  • api-version required string: Client API Version.

Output

• output RegistrationList

Registrations_Delete

Delete the requested Azure Stack registration.

azure_azurestack_registration.Registrations_Delete({
  "subscriptionId": "",
  "resourceGroup": "",
  "registrationName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • resourceGroup required string: Name of the resource group.
  • registrationName required string: Name of the Azure Stack registration.
  • api-version required string: Client API Version.

Output

Output schema unknown

Registrations_Get

Returns the properties of an Azure Stack registration.

azure_azurestack_registration.Registrations_Get({
  "subscriptionId": "",
  "resourceGroup": "",
  "registrationName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • resourceGroup required string: Name of the resource group.
  • registrationName required string: Name of the Azure Stack registration.
  • api-version required string: Client API Version.

Output

• output Registration

Registrations_Update

Patch an Azure Stack registration.

azure_azurestack_registration.Registrations_Update({
  "subscriptionId": "",
  "resourceGroup": "",
  "registrationName": "",
  "api-version": "",
  "token": {}
}, context)

Input

• input object
  • subscriptionId required string: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • resourceGroup required string: Name of the resource group.
  • registrationName required string: Name of the Azure Stack registration.
  • api-version required string: Client API Version.
  • token required RegistrationParameter

Output

• output Registration

Registrations_CreateOrUpdate

Create or update an Azure Stack registration.

azure_azurestack_registration.Registrations_CreateOrUpdate({
  "subscriptionId": "",
  "resourceGroup": "",
  "registrationName": "",
  "api-version": "",
  "token": {}
}, context)

Input

• input object
  • subscriptionId required string: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • resourceGroup required string: Name of the resource group.
  • registrationName required string: Name of the Azure Stack registration.
  • api-version required string: Client API Version.
  • token required RegistrationParameter

Output

• output Registration

Registrations_GetActivationKey

Returns Azure Stack Activation Key.

azure_azurestack_registration.Registrations_GetActivationKey({
  "subscriptionId": "",
  "resourceGroup": "",
  "registrationName": "",
  "api-version": ""
}, context)

Input

• input object
  • subscriptionId required string: Subscription credentials that uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
  • resourceGroup required string: Name of the resource group.
  • registrationName required string: Name of the Azure Stack registration.
  • api-version required string: Client API Version.

Output

• output ActivationKeyResult

Definitions

ActivationKeyResult

• ActivationKeyResult object: The resource containing the Azure Stack activation key.
  • activationKey string: Azure Stack activation key.

Registration

• Registration object: Registration information.
  • properties RegistrationProperties
  • etag string: The entity tag used for optimistic concurrency when modifying the resource.
  • id string: ID of the resource.
  • location required string (values: global): Location of the resource.
  • name string: Name of the resource.
  • tags object: Custom tags for the resource.
  • type string: Type of Resource.

RegistrationList

• RegistrationList object: Pageable list of registrations.
  • nextLink string: URI to the next page.
  • value array: List of Registrations
    • items Registration

RegistrationParameter

• RegistrationParameter object: Registration resource
  • location string (values: global): Location of the resource.
  • properties RegistrationParameterProperties

RegistrationParameterProperties

• RegistrationParameterProperties object: Properties of the Azure Stack registration resource
  • registrationToken required string: The token identifying registered Azure Stack

RegistrationProperties

• RegistrationProperties object: Properties portion of the registration resource.
  • billingModel string: Specifies the billing mode for the Azure Stack registration.
  • cloudId string: The identifier of the registered Azure Stack.
  • objectId string: The object identifier associated with the Azure Stack connecting to Azure.