Views | @azure/arm-customerinsights

Class representing a Views.

Hierarchy

Views

Index

Constructors

constructor

Methods

Constructors

constructor

new Views(client: CustomerInsightsManagementClientContext): Views

- Defined in operations/views.ts:19
Create a Views.

Parameters
- client: CustomerInsightsManagementClientContext
  
  Reference to the service client.
Returns Views

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, hubName: string, viewName: string, parameters: ViewResourceFormat, options?: msRest.RequestOptionsBase): Promise<Models.ViewsCreateOrUpdateResponse>
createOrUpdate(resourceGroupName: string, hubName: string, viewName: string, parameters: ViewResourceFormat, callback: msRest.ServiceCallback<ViewResourceFormat>): void
createOrUpdate(resourceGroupName: string, hubName: string, viewName: string, parameters: ViewResourceFormat, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ViewResourceFormat>): void

- Defined in operations/views.ts:74
Creates a view or updates an exisiting view in the hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- viewName: string
  
  The name of the view.
- parameters: ViewResourceFormat
  
  Parameters supplied to the CreateOrUpdate View operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ViewsCreateOrUpdateResponse>

Promise<Models.ViewsCreateOrUpdateResponse>
- Defined in operations/views.ts:82
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- viewName: string
  
  The name of the view.
- parameters: ViewResourceFormat
  
  Parameters supplied to the CreateOrUpdate View operation.
- callback: msRest.ServiceCallback<ViewResourceFormat>
  
  The callback
Returns void
- Defined in operations/views.ts:91
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- viewName: string
  
  The name of the view.
- parameters: ViewResourceFormat
  
  Parameters supplied to the CreateOrUpdate View operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ViewResourceFormat>
  
  The callback
Returns void

deleteMethod

deleteMethod(resourceGroupName: string, hubName: string, viewName: string, userId: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
deleteMethod(resourceGroupName: string, hubName: string, viewName: string, userId: string, callback: msRest.ServiceCallback<void>): void
deleteMethod(resourceGroupName: string, hubName: string, viewName: string, userId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

- Defined in operations/views.ts:154
Deletes a view in the specified hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- viewName: string
  
  The name of the view.
- userId: string
  
  The user ID. Use * to retreive hub level view.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>
- Defined in operations/views.ts:162
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- viewName: string
  
  The name of the view.
- userId: string
  
  The user ID. Use * to retreive hub level view.
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void
- Defined in operations/views.ts:171
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- viewName: string
  
  The name of the view.
- userId: string
  
  The user ID. Use * to retreive hub level view.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<void>
  
  The callback
Returns void

get

get(resourceGroupName: string, hubName: string, viewName: string, userId: string, options?: msRest.RequestOptionsBase): Promise<Models.ViewsGetResponse>
get(resourceGroupName: string, hubName: string, viewName: string, userId: string, callback: msRest.ServiceCallback<ViewResourceFormat>): void
get(resourceGroupName: string, hubName: string, viewName: string, userId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ViewResourceFormat>): void

- Defined in operations/views.ts:114
Gets a view in the hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- viewName: string
  
  The name of the view.
- userId: string
  
  The user ID. Use * to retreive hub level view.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ViewsGetResponse>

Promise<Models.ViewsGetResponse>
- Defined in operations/views.ts:122
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- viewName: string
  
  The name of the view.
- userId: string
  
  The user ID. Use * to retreive hub level view.
- callback: msRest.ServiceCallback<ViewResourceFormat>
  
  The callback
Returns void
- Defined in operations/views.ts:131
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- viewName: string
  
  The name of the view.
- userId: string
  
  The user ID. Use * to retreive hub level view.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ViewResourceFormat>
  
  The callback
Returns void

listByHub

listByHub(resourceGroupName: string, hubName: string, userId: string, options?: msRest.RequestOptionsBase): Promise<Models.ViewsListByHubResponse>
listByHub(resourceGroupName: string, hubName: string, userId: string, callback: msRest.ServiceCallback<ViewListResult>): void
listByHub(resourceGroupName: string, hubName: string, userId: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ViewListResult>): void

- Defined in operations/views.ts:37
Gets all available views for given user in the specified hub.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- userId: string
  
  The user ID. Use * to retreive hub level views.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ViewsListByHubResponse>

Promise<Models.ViewsListByHubResponse>
- Defined in operations/views.ts:44
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- userId: string
  
  The user ID. Use * to retreive hub level views.
- callback: msRest.ServiceCallback<ViewListResult>
  
  The callback
Returns void
- Defined in operations/views.ts:52
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- hubName: string
  
  The name of the hub.
- userId: string
  
  The user ID. Use * to retreive hub level views.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ViewListResult>
  
  The callback
Returns void

listByHubNext

listByHubNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.ViewsListByHubNextResponse>
listByHubNext(nextPageLink: string, callback: msRest.ServiceCallback<ViewListResult>): void
listByHubNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ViewListResult>): void

- Defined in operations/views.ts:191
Gets all available views for given user in the specified hub.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.ViewsListByHubNextResponse>

Promise<Models.ViewsListByHubNextResponse>
- Defined in operations/views.ts:196
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<ViewListResult>
  
  The callback
Returns void
- Defined in operations/views.ts:202
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<ViewListResult>
  
  The callback
Returns void

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: CustomerInsightsManagementClientContext

Returns Views

Methods

createOrUpdate

Parameters

resourceGroupName: string

hubName: string

viewName: string

parameters: ViewResourceFormat

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.ViewsCreateOrUpdateResponse>

Parameters

resourceGroupName: string

hubName: string

viewName: string

parameters: ViewResourceFormat

callback: msRest.ServiceCallback<ViewResourceFormat>

Returns void

Parameters

resourceGroupName: string

hubName: string

viewName: string

parameters: ViewResourceFormat

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<ViewResourceFormat>

Returns void

deleteMethod

Parameters

resourceGroupName: string

hubName: string

viewName: string

userId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

Parameters

resourceGroupName: string

hubName: string

viewName: string

userId: string

callback: msRest.ServiceCallback<void>

Returns void

Parameters

resourceGroupName: string

hubName: string

viewName: string

userId: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<void>

Returns void

get

Parameters

resourceGroupName: string

hubName: string

viewName: string

userId: string

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.ViewsGetResponse>

Parameters

resourceGroupName: string

hubName: string

viewName: string

userId: string

callback: msRest.ServiceCallback<ViewResourceFormat>

Returns void

Parameters

resourceGroupName: string

hubName: string

viewName: string

userId: string

options: msRest.RequestOptionsBase

callback: msRest.ServiceCallback<ViewResourceFormat>

Returns void

listByHub