Organizations interface

Package:

@azure/arm-astro

Interface representing a Organizations.

Methods

beginCreateOrUpdate(string, string, OrganizationResource, OrganizationsCreateOrUpdateOptionalParams)	Create a OrganizationResource
beginCreateOrUpdateAndWait(string, string, OrganizationResource, OrganizationsCreateOrUpdateOptionalParams)	Create a OrganizationResource
beginDelete(string, string, OrganizationsDeleteOptionalParams)	Delete a OrganizationResource
beginDeleteAndWait(string, string, OrganizationsDeleteOptionalParams)	Delete a OrganizationResource
beginUpdate(string, string, OrganizationResourceUpdate, OrganizationsUpdateOptionalParams)	Update a OrganizationResource
beginUpdateAndWait(string, string, OrganizationResourceUpdate, OrganizationsUpdateOptionalParams)	Update a OrganizationResource
get(string, string, OrganizationsGetOptionalParams)	Get a OrganizationResource
listByResourceGroup(string, OrganizationsListByResourceGroupOptionalParams)	List OrganizationResource resources by resource group
listBySubscription(OrganizationsListBySubscriptionOptionalParams)	List OrganizationResource resources by subscription ID

Method Details

beginCreateOrUpdate(string, string, OrganizationResource, OrganizationsCreateOrUpdateOptionalParams)

Create a OrganizationResource

function beginCreateOrUpdate(resourceGroupName: string, organizationName: string, resource: OrganizationResource, options?: OrganizationsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Name of the Organizations resource

resource

OrganizationResource

Resource create parameters.

options

OrganizationsCreateOrUpdateOptionalParams

The options parameters.

Returns

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

beginCreateOrUpdateAndWait(string, string, OrganizationResource, OrganizationsCreateOrUpdateOptionalParams)

Create a OrganizationResource

function beginCreateOrUpdateAndWait(resourceGroupName: string, organizationName: string, resource: OrganizationResource, options?: OrganizationsCreateOrUpdateOptionalParams): Promise<OrganizationResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Name of the Organizations resource

resource

OrganizationResource

Resource create parameters.

options

OrganizationsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<OrganizationResource>

beginDelete(string, string, OrganizationsDeleteOptionalParams)

Delete a OrganizationResource

function beginDelete(resourceGroupName: string, organizationName: string, options?: OrganizationsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationsDeleteHeaders>, OrganizationsDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Name of the Organizations resource

options

OrganizationsDeleteOptionalParams

The options parameters.

Returns

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

beginDeleteAndWait(string, string, OrganizationsDeleteOptionalParams)

Delete a OrganizationResource

function beginDeleteAndWait(resourceGroupName: string, organizationName: string, options?: OrganizationsDeleteOptionalParams): Promise<OrganizationsDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Name of the Organizations resource

options

OrganizationsDeleteOptionalParams

The options parameters.

Returns

Promise<OrganizationsDeleteHeaders>

beginUpdate(string, string, OrganizationResourceUpdate, OrganizationsUpdateOptionalParams)

Update a OrganizationResource

function beginUpdate(resourceGroupName: string, organizationName: string, properties: OrganizationResourceUpdate, options?: OrganizationsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<OrganizationResource>, OrganizationResource>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Name of the Organizations resource

properties

OrganizationResourceUpdate

The resource properties to be updated.

options

OrganizationsUpdateOptionalParams

The options parameters.

Returns

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

beginUpdateAndWait(string, string, OrganizationResourceUpdate, OrganizationsUpdateOptionalParams)

Update a OrganizationResource

function beginUpdateAndWait(resourceGroupName: string, organizationName: string, properties: OrganizationResourceUpdate, options?: OrganizationsUpdateOptionalParams): Promise<OrganizationResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Name of the Organizations resource

properties

OrganizationResourceUpdate

The resource properties to be updated.

options

OrganizationsUpdateOptionalParams

The options parameters.

Returns

Promise<OrganizationResource>

get(string, string, OrganizationsGetOptionalParams)

Get a OrganizationResource

function get(resourceGroupName: string, organizationName: string, options?: OrganizationsGetOptionalParams): Promise<OrganizationResource>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

organizationName

string

Name of the Organizations resource

options

OrganizationsGetOptionalParams

The options parameters.

Returns

Promise<OrganizationResource>

listByResourceGroup(string, OrganizationsListByResourceGroupOptionalParams)

List OrganizationResource resources by resource group

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

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

OrganizationsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

listBySubscription(OrganizationsListBySubscriptionOptionalParams)

List OrganizationResource resources by subscription ID

function listBySubscription(options?: OrganizationsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>

Parameters

options

OrganizationsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<OrganizationResource, OrganizationResource[], PageSettings>