@azure-rest/arm-servicefabric package

Interfaces

ApplicationDeltaHealthPolicy	Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.
ApplicationDeltaHealthPolicyOutput	Defines a delta health policy used to evaluate the health of an application or one of its child entities when upgrading the cluster.
ApplicationHealthPolicy	Defines a health policy used to evaluate the health of an application or one of its children entities.
ApplicationHealthPolicyOutput	Defines a health policy used to evaluate the health of an application or one of its children entities.
ApplicationMetricDescription	Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.
ApplicationMetricDescriptionOutput	Describes capacity information for a custom resource balancing metric. This can be used to limit the total consumption of this metric by the services of this application.
ApplicationResource	The application resource.
ApplicationResourceListOutput	The list of application resources.
ApplicationResourceOutput	The application resource.
ApplicationResourceProperties	The application resource properties.
ApplicationResourcePropertiesOutput	The application resource properties.
ApplicationResourceUpdate	The application resource for patch operations.
ApplicationResourceUpdateOutput	The application resource for patch operations.
ApplicationResourceUpdateProperties	The application resource properties for patch operations.
ApplicationResourceUpdatePropertiesOutput	The application resource properties for patch operations.
ApplicationTypeResource	The application type name resource
ApplicationTypeResourceListOutput	The list of application type names.
ApplicationTypeResourceOutput	The application type name resource
ApplicationTypeResourceProperties	The application type name properties
ApplicationTypeResourcePropertiesOutput	The application type name properties
ApplicationTypeVersionResource	An application type version resource for the specified application type name resource.
ApplicationTypeVersionResourceListOutput	The list of application type version resources for the specified application type name resource.
ApplicationTypeVersionResourceOutput	An application type version resource for the specified application type name resource.
ApplicationTypeVersionResourceProperties	The properties of the application type version resource.
ApplicationTypeVersionResourcePropertiesOutput	The properties of the application type version resource.
ApplicationTypeVersionsCleanupPolicy
ApplicationTypeVersionsCleanupPolicyOutput
ApplicationTypeVersionsCreateOrUpdate202Response	Create or update a Service Fabric application type version resource with the specified name.
ApplicationTypeVersionsCreateOrUpdateBodyParam
ApplicationTypeVersionsCreateOrUpdateDefaultResponse	Create or update a Service Fabric application type version resource with the specified name.
ApplicationTypeVersionsCreateOrUpdateMediaTypesParam
ApplicationTypeVersionsDelete202Response	Delete a Service Fabric application type version resource with the specified name.
ApplicationTypeVersionsDelete204Response	Delete a Service Fabric application type version resource with the specified name.
ApplicationTypeVersionsDeleteDefaultResponse	Delete a Service Fabric application type version resource with the specified name.
ApplicationTypeVersionsGet
ApplicationTypeVersionsGet200Response	Get a Service Fabric application type version resource created or in the process of being created in the Service Fabric application type name resource.
ApplicationTypeVersionsGetDefaultResponse	Get a Service Fabric application type version resource created or in the process of being created in the Service Fabric application type name resource.
ApplicationTypeVersionsList
ApplicationTypeVersionsList200Response	Gets all application type version resources created or in the process of being created in the Service Fabric application type name resource.
ApplicationTypeVersionsListDefaultResponse	Gets all application type version resources created or in the process of being created in the Service Fabric application type name resource.
ApplicationTypesCreateOrUpdate200Response	Create or update a Service Fabric application type name resource with the specified name.
ApplicationTypesCreateOrUpdateBodyParam
ApplicationTypesCreateOrUpdateDefaultResponse	Create or update a Service Fabric application type name resource with the specified name.
ApplicationTypesCreateOrUpdateMediaTypesParam
ApplicationTypesDelete202Response	Delete a Service Fabric application type name resource with the specified name.
ApplicationTypesDelete204Response	Delete a Service Fabric application type name resource with the specified name.
ApplicationTypesDeleteDefaultResponse	Delete a Service Fabric application type name resource with the specified name.
ApplicationTypesGet
ApplicationTypesGet200Response	Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric cluster resource.
ApplicationTypesGetDefaultResponse	Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric cluster resource.
ApplicationTypesList
ApplicationTypesList200Response	Gets all application type name resources created or in the process of being created in the Service Fabric cluster resource.
ApplicationTypesListDefaultResponse	Gets all application type name resources created or in the process of being created in the Service Fabric cluster resource.
ApplicationUpgradePolicy	Describes the policy for a monitored application upgrade.
ApplicationUpgradePolicyOutput	Describes the policy for a monitored application upgrade.
ApplicationUserAssignedIdentity
ApplicationUserAssignedIdentityOutput
ApplicationsCreateOrUpdate202Response	Create or update a Service Fabric application resource with the specified name.
ApplicationsCreateOrUpdateBodyParam
ApplicationsCreateOrUpdateDefaultResponse	Create or update a Service Fabric application resource with the specified name.
ApplicationsCreateOrUpdateMediaTypesParam
ApplicationsDelete202Response	Delete a Service Fabric application resource with the specified name.
ApplicationsDelete204Response	Delete a Service Fabric application resource with the specified name.
ApplicationsDeleteDefaultResponse	Delete a Service Fabric application resource with the specified name.
ApplicationsGet
ApplicationsGet200Response	Get a Service Fabric application resource created or in the process of being created in the Service Fabric cluster resource.
ApplicationsGetDefaultResponse	Get a Service Fabric application resource created or in the process of being created in the Service Fabric cluster resource.
ApplicationsList
ApplicationsList200Response	Gets all application resources created or in the process of being created in the Service Fabric cluster resource.
ApplicationsListDefaultResponse	Gets all application resources created or in the process of being created in the Service Fabric cluster resource.
ApplicationsUpdate202Response	Update a Service Fabric application resource with the specified name.
ApplicationsUpdateBodyParam
ApplicationsUpdateDefaultResponse	Update a Service Fabric application resource with the specified name.
ApplicationsUpdateMediaTypesParam
ArmApplicationHealthPolicy	Defines a health policy used to evaluate the health of an application or one of its children entities.
ArmApplicationHealthPolicyOutput	Defines a health policy used to evaluate the health of an application or one of its children entities.
ArmRollingUpgradeMonitoringPolicy	The policy used for monitoring the application upgrade
ArmRollingUpgradeMonitoringPolicyOutput	The policy used for monitoring the application upgrade
ArmServiceTypeHealthPolicy	Represents the health policy used to evaluate the health of services belonging to a service type.
ArmServiceTypeHealthPolicyOutput	Represents the health policy used to evaluate the health of services belonging to a service type.
AvailableOperationDisplayOutput	Operation supported by the Service Fabric resource provider
AzureActiveDirectory	The settings to enable AAD authentication on the cluster.
AzureActiveDirectoryOutput	The settings to enable AAD authentication on the cluster.
CertificateDescription	Describes the certificate details.
CertificateDescriptionOutput	Describes the certificate details.
ClientCertificateCommonName	Describes the client certificate details using common name.
ClientCertificateCommonNameOutput	Describes the client certificate details using common name.
ClientCertificateThumbprint	Describes the client certificate details using thumbprint.
ClientCertificateThumbprintOutput	Describes the client certificate details using thumbprint.
Cluster	The cluster resource
ClusterCodeVersionsListResultOutput	The list results of the Service Fabric runtime versions.
ClusterCodeVersionsResultOutput	The result of the Service Fabric runtime versions
ClusterHealthPolicy	Defines a health policy used to evaluate the health of the cluster or of a cluster node.
ClusterHealthPolicyOutput	Defines a health policy used to evaluate the health of the cluster or of a cluster node.
ClusterListResultOutput	Cluster list results
ClusterOutput	The cluster resource
ClusterProperties	Describes the cluster resource properties.
ClusterPropertiesOutput	Describes the cluster resource properties.
ClusterPropertiesUpdateParameters	Describes the cluster resource properties that can be updated during PATCH operation.
ClusterUpdateParameters	Cluster update request
ClusterUpgradeDeltaHealthPolicy	Describes the delta health policies for the cluster upgrade.
ClusterUpgradeDeltaHealthPolicyOutput	Describes the delta health policies for the cluster upgrade.
ClusterUpgradePolicy	Describes the policy used when upgrading the cluster.
ClusterUpgradePolicyOutput	Describes the policy used when upgrading the cluster.
ClusterVersionDetails	The detail of the Service Fabric runtime version result
ClusterVersionDetailsOutput	The detail of the Service Fabric runtime version result
ClusterVersionsGet
ClusterVersionsGet200Response	Gets information about an available Service Fabric cluster code version.
ClusterVersionsGetByEnvironment
ClusterVersionsGetByEnvironment200Response	Gets information about an available Service Fabric cluster code version by environment.
ClusterVersionsGetByEnvironmentDefaultResponse	Gets information about an available Service Fabric cluster code version by environment.
ClusterVersionsGetDefaultResponse	Gets information about an available Service Fabric cluster code version.
ClusterVersionsList
ClusterVersionsList200Response	Gets all available code versions for Service Fabric cluster resources by location.
ClusterVersionsListByEnvironment
ClusterVersionsListByEnvironment200Response	Gets all available code versions for Service Fabric cluster resources by environment.
ClusterVersionsListByEnvironmentDefaultResponse	Gets all available code versions for Service Fabric cluster resources by environment.
ClusterVersionsListDefaultResponse	Gets all available code versions for Service Fabric cluster resources by location.
ClustersCreateOrUpdate200Response	Create or update a Service Fabric cluster resource with the specified name.
ClustersCreateOrUpdate202Response	Create or update a Service Fabric cluster resource with the specified name.
ClustersCreateOrUpdateBodyParam
ClustersCreateOrUpdateDefaultResponse	Create or update a Service Fabric cluster resource with the specified name.
ClustersCreateOrUpdateMediaTypesParam
ClustersDelete200Response	Delete a Service Fabric cluster resource with the specified name.
ClustersDelete204Response	Delete a Service Fabric cluster resource with the specified name.
ClustersDeleteDefaultResponse	Delete a Service Fabric cluster resource with the specified name.
ClustersGet
ClustersGet200Response	Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.
ClustersGetDefaultResponse	Get a Service Fabric cluster resource created or in the process of being created in the specified resource group.
ClustersList
ClustersList200Response	Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
ClustersListByResourceGroup
ClustersListByResourceGroup200Response	Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
ClustersListByResourceGroupDefaultResponse	Gets all Service Fabric cluster resources created or in the process of being created in the resource group.
ClustersListDefaultResponse	Gets all Service Fabric cluster resources created or in the process of being created in the subscription.
ClustersListUpgradableVersions
ClustersListUpgradableVersions200Response	If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.
ClustersListUpgradableVersionsBodyParam
ClustersListUpgradableVersionsDefaultResponse	If a target is not provided, it will get the minimum and maximum versions available from the current cluster version. If a target is given, it will provide the required path to get from the current cluster version to the target version.
ClustersListUpgradableVersionsMediaTypesParam
ClustersUpdate200Response	Update the configuration of a Service Fabric cluster resource with the specified name.
ClustersUpdate202Response	Update the configuration of a Service Fabric cluster resource with the specified name.
ClustersUpdateBodyParam
ClustersUpdateDefaultResponse	Update the configuration of a Service Fabric cluster resource with the specified name.
ClustersUpdateMediaTypesParam
DiagnosticsStorageAccountConfig	The storage account information for storing Service Fabric diagnostic logs.
DiagnosticsStorageAccountConfigOutput	The storage account information for storing Service Fabric diagnostic logs.
EndpointRangeDescription	Port range details
EndpointRangeDescriptionOutput	Port range details
ErrorModelErrorOutput	The error details.
ErrorModelOutput	The structure of the error.
ManagedIdentity	Describes the managed identities for an Azure resource.
ManagedIdentityOutput	Describes the managed identities for an Azure resource.
NamedPartitionSchemeDescription	Describes the named partition scheme of the service.
NamedPartitionSchemeDescriptionOutput	Describes the named partition scheme of the service.
NodeTypeDescription	Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.
NodeTypeDescriptionOutput	Describes a node type in the cluster, each node type represents sub set of nodes in the cluster.
Notification	Describes the notification channel for cluster events.
NotificationOutput	Describes the notification channel for cluster events.
NotificationTarget	Describes the notification target properties.
NotificationTargetOutput	Describes the notification target properties.
OperationListResultOutput	Describes the result of the request to list Service Fabric resource provider operations.
OperationResultOutput	Available operation list result
OperationsList
OperationsList200Response	Get the list of available Service Fabric resource provider API operations.
OperationsListDefaultResponse	Get the list of available Service Fabric resource provider API operations.
PageSettings	An interface that tracks the settings for paged iteration
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PagingOptions	Options for the paging helper
PartitionSchemeDescriptionOutputParent	Describes how the service is partitioned.
PartitionSchemeDescriptionParent	Describes how the service is partitioned.
ProxyResource	The resource model definition for proxy-only resource.
ProxyResourceOutput	The resource model definition for proxy-only resource.
Resource	The resource model definition.
ResourceOutput	The resource model definition.
Routes
ServerCertificateCommonName	Describes the server certificate details using common name.
ServerCertificateCommonNameOutput	Describes the server certificate details using common name.
ServerCertificateCommonNames	Describes a list of server certificates referenced by common name that are used to secure the cluster.
ServerCertificateCommonNamesOutput	Describes a list of server certificates referenced by common name that are used to secure the cluster.
ServiceCorrelationDescription	Creates a particular correlation between services.
ServiceCorrelationDescriptionOutput	Creates a particular correlation between services.
ServiceFabricClientOptions	The optional parameters for the client
ServiceLoadMetricDescription	Specifies a metric to load balance a service during runtime.
ServiceLoadMetricDescriptionOutput	Specifies a metric to load balance a service during runtime.
ServicePlacementPolicyDescription	Describes the policy to be used for placement of a Service Fabric service.
ServicePlacementPolicyDescriptionOutput	Describes the policy to be used for placement of a Service Fabric service.
ServiceResource	The service resource.
ServiceResourceListOutput	The list of service resources.
ServiceResourceOutput	The service resource.
ServiceResourcePropertiesBase	The common service resource properties.
ServiceResourcePropertiesBaseOutput	The common service resource properties.
ServiceResourcePropertiesOutputParent	The service resource properties.
ServiceResourcePropertiesParent	The service resource properties.
ServiceResourceUpdate	The service resource for patch operations.
ServiceResourceUpdateOutput	The service resource for patch operations.
ServiceResourceUpdatePropertiesOutputParent	The service resource properties for patch operations.
ServiceResourceUpdatePropertiesParent	The service resource properties for patch operations.
ServiceTypeDeltaHealthPolicy	Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.
ServiceTypeDeltaHealthPolicyOutput	Represents the delta health policy used to evaluate the health of services belonging to a service type when upgrading the cluster.
ServiceTypeHealthPolicy	Represents the health policy used to evaluate the health of services belonging to a service type.
ServiceTypeHealthPolicyOutput	Represents the health policy used to evaluate the health of services belonging to a service type.
ServicesCreateOrUpdate202Response	Create or update a Service Fabric service resource with the specified name.
ServicesCreateOrUpdateBodyParam
ServicesCreateOrUpdateDefaultResponse	Create or update a Service Fabric service resource with the specified name.
ServicesCreateOrUpdateMediaTypesParam
ServicesDelete202Response	Delete a Service Fabric service resource with the specified name.
ServicesDelete204Response	Delete a Service Fabric service resource with the specified name.
ServicesDeleteDefaultResponse	Delete a Service Fabric service resource with the specified name.
ServicesGet
ServicesGet200Response	Get a Service Fabric service resource created or in the process of being created in the Service Fabric application resource.
ServicesGetDefaultResponse	Get a Service Fabric service resource created or in the process of being created in the Service Fabric application resource.
ServicesList
ServicesList200Response	Gets all service resources created or in the process of being created in the Service Fabric application resource.
ServicesListDefaultResponse	Gets all service resources created or in the process of being created in the Service Fabric application resource.
ServicesUpdate202Response	Update a Service Fabric service resource with the specified name.
ServicesUpdateBodyParam
ServicesUpdateDefaultResponse	Update a Service Fabric service resource with the specified name.
ServicesUpdateMediaTypesParam
SettingsParameterDescription	Describes a parameter in fabric settings of the cluster.
SettingsParameterDescriptionOutput	Describes a parameter in fabric settings of the cluster.
SettingsSectionDescription	Describes a section in the fabric settings of the cluster.
SettingsSectionDescriptionOutput	Describes a section in the fabric settings of the cluster.
SimplePollerLike	A simple poller that can be used to poll a long running operation.
SingletonPartitionSchemeDescription	SingletonPartitionSchemeDescription
SingletonPartitionSchemeDescriptionOutput	SingletonPartitionSchemeDescription
StatefulServiceProperties	The properties of a stateful service resource.
StatefulServicePropertiesOutput	The properties of a stateful service resource.
StatefulServiceUpdateProperties	The properties of a stateful service resource for patch operations.
StatefulServiceUpdatePropertiesOutput	The properties of a stateful service resource for patch operations.
StatelessServiceProperties	The properties of a stateless service resource.
StatelessServicePropertiesOutput	The properties of a stateless service resource.
StatelessServiceUpdateProperties	The properties of a stateless service resource for patch operations.
StatelessServiceUpdatePropertiesOutput	The properties of a stateless service resource for patch operations.
SystemData	Metadata pertaining to creation and last modification of the resource.
SystemDataOutput	Metadata pertaining to creation and last modification of the resource.
UniformInt64RangePartitionSchemeDescription	Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.
UniformInt64RangePartitionSchemeDescriptionOutput	Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.
UpgradableVersionPathResultOutput	The list of intermediate cluster code versions for an upgrade or downgrade. Or minimum and maximum upgradable version if no target was given
UpgradableVersionsDescription
UserAssignedIdentity
UserAssignedIdentityOutput

Type Aliases

ApplicationTypeVersionsCreateOrUpdateParameters
ApplicationTypeVersionsDeleteParameters
ApplicationTypeVersionsGetParameters
ApplicationTypeVersionsListParameters
ApplicationTypesCreateOrUpdateParameters
ApplicationTypesDeleteParameters
ApplicationTypesGetParameters
ApplicationTypesListParameters
ApplicationsCreateOrUpdateParameters
ApplicationsDeleteParameters
ApplicationsGetParameters
ApplicationsListParameters
ApplicationsUpdateParameters
ClusterVersionsGetByEnvironmentParameters
ClusterVersionsGetParameters
ClusterVersionsListByEnvironmentParameters
ClusterVersionsListParameters
ClustersCreateOrUpdateParameters
ClustersDeleteParameters
ClustersGetParameters
ClustersListByResourceGroupParameters
ClustersListParameters
ClustersListUpgradableVersionsParameters
ClustersUpdateParameters
GetArrayType	Helper type to extract the type of an array
GetPage	The type of a custom function that defines how to get a page and a link to the next one if any.
OperationsListParameters
PaginateReturn	Helper type to infer the Type of the paged elements from the response type This type is generated based on the swagger information for x-ms-pageable specifically on the itemName property which indicates the property of the response where the page items are found. The default value is value. This type will allow us to provide strongly typed Iterator based on the response we get as second parameter
PartitionSchemeDescription	Describes how the service is partitioned.
PartitionSchemeDescriptionOutput	Describes how the service is partitioned.
ServiceFabricClient
ServiceResourceProperties	The service resource properties.
ServiceResourcePropertiesOutput	The service resource properties.
ServiceResourceUpdateProperties	The service resource properties for patch operations.
ServiceResourceUpdatePropertiesOutput	The service resource properties for patch operations.
ServicesCreateOrUpdateParameters
ServicesDeleteParameters
ServicesGetParameters
ServicesListParameters
ServicesUpdateParameters

Functions

default(TokenCredential, ServiceFabricClientOptions)	Initialize a new instance of ServiceFabricClient
getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)	Helper function that builds a Poller object to help polling a long running operation.
isUnexpected(ClustersGet200Response | ClustersGetDefaultResponse)
isUnexpected(ClustersCreateOrUpdate200Response | ClustersCreateOrUpdate202Response | ClustersCreateOrUpdateDefaultResponse)
isUnexpected(ClustersUpdate200Response | ClustersUpdate202Response | ClustersUpdateDefaultResponse)
isUnexpected(ClustersDelete200Response | ClustersDelete204Response | ClustersDeleteDefaultResponse)
isUnexpected(ClustersListByResourceGroup200Response | ClustersListByResourceGroupDefaultResponse)
isUnexpected(ClustersList200Response | ClustersListDefaultResponse)
isUnexpected(ClustersListUpgradableVersions200Response | ClustersListUpgradableVersionsDefaultResponse)
isUnexpected(ClusterVersionsGet200Response | ClusterVersionsGetDefaultResponse)
isUnexpected(ClusterVersionsGetByEnvironment200Response | ClusterVersionsGetByEnvironmentDefaultResponse)
isUnexpected(ClusterVersionsList200Response | ClusterVersionsListDefaultResponse)
isUnexpected(ClusterVersionsListByEnvironment200Response | ClusterVersionsListByEnvironmentDefaultResponse)
isUnexpected(OperationsList200Response | OperationsListDefaultResponse)
isUnexpected(ApplicationTypesGet200Response | ApplicationTypesGetDefaultResponse)
isUnexpected(ApplicationTypesCreateOrUpdate200Response | ApplicationTypesCreateOrUpdateDefaultResponse)
isUnexpected(ApplicationTypesDelete202Response | ApplicationTypesDelete204Response | ApplicationTypesDeleteDefaultResponse)
isUnexpected(ApplicationTypesList200Response | ApplicationTypesListDefaultResponse)
isUnexpected(ApplicationTypeVersionsGet200Response | ApplicationTypeVersionsGetDefaultResponse)
isUnexpected(ApplicationTypeVersionsCreateOrUpdate202Response | ApplicationTypeVersionsCreateOrUpdateDefaultResponse)
isUnexpected(ApplicationTypeVersionsDelete202Response | ApplicationTypeVersionsDelete204Response | ApplicationTypeVersionsDeleteDefaultResponse)
isUnexpected(ApplicationTypeVersionsList200Response | ApplicationTypeVersionsListDefaultResponse)
isUnexpected(ApplicationsGet200Response | ApplicationsGetDefaultResponse)
isUnexpected(ApplicationsCreateOrUpdate202Response | ApplicationsCreateOrUpdateDefaultResponse)
isUnexpected(ApplicationsUpdate202Response | ApplicationsUpdateDefaultResponse)
isUnexpected(ApplicationsDelete202Response | ApplicationsDelete204Response | ApplicationsDeleteDefaultResponse)
isUnexpected(ApplicationsList200Response | ApplicationsListDefaultResponse)
isUnexpected(ServicesGet200Response | ServicesGetDefaultResponse)
isUnexpected(ServicesCreateOrUpdate202Response | ServicesCreateOrUpdateDefaultResponse)
isUnexpected(ServicesUpdate202Response | ServicesUpdateDefaultResponse)
isUnexpected(ServicesDelete202Response | ServicesDelete204Response | ServicesDeleteDefaultResponse)
isUnexpected(ServicesList200Response | ServicesListDefaultResponse)
paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)	Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

Function Details

default(TokenCredential, ServiceFabricClientOptions)

Initialize a new instance of ServiceFabricClient

function default(credentials: TokenCredential, options?: ServiceFabricClientOptions): ServiceFabricClient

Parameters

credentials

TokenCredential

uniquely identify client credential

options

ServiceFabricClientOptions

the parameter for all optional parameters

Returns

ServiceFabricClient

getLongRunningPoller<TResult>(Client, TResult, CreateHttpPollerOptions<TResult, OperationState<TResult>>)

Helper function that builds a Poller object to help polling a long running operation.

function getLongRunningPoller<TResult>(client: Client, initialResponse: TResult, options?: CreateHttpPollerOptions<TResult, OperationState<TResult>>): Promise<SimplePollerLike<OperationState<TResult>, TResult>>

Parameters

client

Client

Client to use for sending the request to get additional pages.

initialResponse

TResult

The initial response.

options

CreateHttpPollerOptions<TResult, OperationState<TResult>>

Options to set a resume state or custom polling interval.

Returns

Promise<SimplePollerLike<OperationState<TResult>, TResult>>

• A poller object to poll for operation state updates and eventually get the final response.

isUnexpected(ClustersGet200Response | ClustersGetDefaultResponse)

function isUnexpected(response: ClustersGet200Response | ClustersGetDefaultResponse): response

Parameters

response

ClustersGet200Response | ClustersGetDefaultResponse

Returns

response

isUnexpected(ClustersCreateOrUpdate200Response | ClustersCreateOrUpdate202Response | ClustersCreateOrUpdateDefaultResponse)

function isUnexpected(response: ClustersCreateOrUpdate200Response | ClustersCreateOrUpdate202Response | ClustersCreateOrUpdateDefaultResponse): response

Parameters

response

ClustersCreateOrUpdate200Response | ClustersCreateOrUpdate202Response | ClustersCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(ClustersUpdate200Response | ClustersUpdate202Response | ClustersUpdateDefaultResponse)

function isUnexpected(response: ClustersUpdate200Response | ClustersUpdate202Response | ClustersUpdateDefaultResponse): response

Parameters

response

ClustersUpdate200Response | ClustersUpdate202Response | ClustersUpdateDefaultResponse

Returns

response

isUnexpected(ClustersDelete200Response | ClustersDelete204Response | ClustersDeleteDefaultResponse)

function isUnexpected(response: ClustersDelete200Response | ClustersDelete204Response | ClustersDeleteDefaultResponse): response

Parameters

response

ClustersDelete200Response | ClustersDelete204Response | ClustersDeleteDefaultResponse

Returns

response

isUnexpected(ClustersListByResourceGroup200Response | ClustersListByResourceGroupDefaultResponse)

function isUnexpected(response: ClustersListByResourceGroup200Response | ClustersListByResourceGroupDefaultResponse): response

Parameters

response

ClustersListByResourceGroup200Response | ClustersListByResourceGroupDefaultResponse

Returns

response

isUnexpected(ClustersList200Response | ClustersListDefaultResponse)

function isUnexpected(response: ClustersList200Response | ClustersListDefaultResponse): response

Parameters

response

ClustersList200Response | ClustersListDefaultResponse

Returns

response

isUnexpected(ClustersListUpgradableVersions200Response | ClustersListUpgradableVersionsDefaultResponse)

function isUnexpected(response: ClustersListUpgradableVersions200Response | ClustersListUpgradableVersionsDefaultResponse): response

Parameters

response

ClustersListUpgradableVersions200Response | ClustersListUpgradableVersionsDefaultResponse

Returns

response

isUnexpected(ClusterVersionsGet200Response | ClusterVersionsGetDefaultResponse)

function isUnexpected(response: ClusterVersionsGet200Response | ClusterVersionsGetDefaultResponse): response

Parameters

response

ClusterVersionsGet200Response | ClusterVersionsGetDefaultResponse

Returns

response

isUnexpected(ClusterVersionsGetByEnvironment200Response | ClusterVersionsGetByEnvironmentDefaultResponse)

function isUnexpected(response: ClusterVersionsGetByEnvironment200Response | ClusterVersionsGetByEnvironmentDefaultResponse): response

Parameters

response

ClusterVersionsGetByEnvironment200Response | ClusterVersionsGetByEnvironmentDefaultResponse

Returns

response

isUnexpected(ClusterVersionsList200Response | ClusterVersionsListDefaultResponse)

function isUnexpected(response: ClusterVersionsList200Response | ClusterVersionsListDefaultResponse): response

Parameters

response

ClusterVersionsList200Response | ClusterVersionsListDefaultResponse

Returns

response

isUnexpected(ClusterVersionsListByEnvironment200Response | ClusterVersionsListByEnvironmentDefaultResponse)

function isUnexpected(response: ClusterVersionsListByEnvironment200Response | ClusterVersionsListByEnvironmentDefaultResponse): response

Parameters

response

ClusterVersionsListByEnvironment200Response | ClusterVersionsListByEnvironmentDefaultResponse

Returns

response

isUnexpected(OperationsList200Response | OperationsListDefaultResponse)

function isUnexpected(response: OperationsList200Response | OperationsListDefaultResponse): response

Parameters

response

OperationsList200Response | OperationsListDefaultResponse

Returns

response

isUnexpected(ApplicationTypesGet200Response | ApplicationTypesGetDefaultResponse)

function isUnexpected(response: ApplicationTypesGet200Response | ApplicationTypesGetDefaultResponse): response

Parameters

response

ApplicationTypesGet200Response | ApplicationTypesGetDefaultResponse

Returns

response

isUnexpected(ApplicationTypesCreateOrUpdate200Response | ApplicationTypesCreateOrUpdateDefaultResponse)

function isUnexpected(response: ApplicationTypesCreateOrUpdate200Response | ApplicationTypesCreateOrUpdateDefaultResponse): response

Parameters

response

ApplicationTypesCreateOrUpdate200Response | ApplicationTypesCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(ApplicationTypesDelete202Response | ApplicationTypesDelete204Response | ApplicationTypesDeleteDefaultResponse)

function isUnexpected(response: ApplicationTypesDelete202Response | ApplicationTypesDelete204Response | ApplicationTypesDeleteDefaultResponse): response

Parameters

response

ApplicationTypesDelete202Response | ApplicationTypesDelete204Response | ApplicationTypesDeleteDefaultResponse

Returns

response

isUnexpected(ApplicationTypesList200Response | ApplicationTypesListDefaultResponse)

function isUnexpected(response: ApplicationTypesList200Response | ApplicationTypesListDefaultResponse): response

Parameters

response

ApplicationTypesList200Response | ApplicationTypesListDefaultResponse

Returns

response

isUnexpected(ApplicationTypeVersionsGet200Response | ApplicationTypeVersionsGetDefaultResponse)

function isUnexpected(response: ApplicationTypeVersionsGet200Response | ApplicationTypeVersionsGetDefaultResponse): response

Parameters

response

ApplicationTypeVersionsGet200Response | ApplicationTypeVersionsGetDefaultResponse

Returns

response

isUnexpected(ApplicationTypeVersionsCreateOrUpdate202Response | ApplicationTypeVersionsCreateOrUpdateDefaultResponse)

function isUnexpected(response: ApplicationTypeVersionsCreateOrUpdate202Response | ApplicationTypeVersionsCreateOrUpdateDefaultResponse): response

Parameters

response

ApplicationTypeVersionsCreateOrUpdate202Response | ApplicationTypeVersionsCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(ApplicationTypeVersionsDelete202Response | ApplicationTypeVersionsDelete204Response | ApplicationTypeVersionsDeleteDefaultResponse)

function isUnexpected(response: ApplicationTypeVersionsDelete202Response | ApplicationTypeVersionsDelete204Response | ApplicationTypeVersionsDeleteDefaultResponse): response

Parameters

response

ApplicationTypeVersionsDelete202Response | ApplicationTypeVersionsDelete204Response | ApplicationTypeVersionsDeleteDefaultResponse

Returns

response

isUnexpected(ApplicationTypeVersionsList200Response | ApplicationTypeVersionsListDefaultResponse)

function isUnexpected(response: ApplicationTypeVersionsList200Response | ApplicationTypeVersionsListDefaultResponse): response

Parameters

response

ApplicationTypeVersionsList200Response | ApplicationTypeVersionsListDefaultResponse

Returns

response

isUnexpected(ApplicationsGet200Response | ApplicationsGetDefaultResponse)

function isUnexpected(response: ApplicationsGet200Response | ApplicationsGetDefaultResponse): response

Parameters

response

ApplicationsGet200Response | ApplicationsGetDefaultResponse

Returns

response

isUnexpected(ApplicationsCreateOrUpdate202Response | ApplicationsCreateOrUpdateDefaultResponse)

function isUnexpected(response: ApplicationsCreateOrUpdate202Response | ApplicationsCreateOrUpdateDefaultResponse): response

Parameters

response

ApplicationsCreateOrUpdate202Response | ApplicationsCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(ApplicationsUpdate202Response | ApplicationsUpdateDefaultResponse)

function isUnexpected(response: ApplicationsUpdate202Response | ApplicationsUpdateDefaultResponse): response

Parameters

response

ApplicationsUpdate202Response | ApplicationsUpdateDefaultResponse

Returns

response

isUnexpected(ApplicationsDelete202Response | ApplicationsDelete204Response | ApplicationsDeleteDefaultResponse)

function isUnexpected(response: ApplicationsDelete202Response | ApplicationsDelete204Response | ApplicationsDeleteDefaultResponse): response

Parameters

response

ApplicationsDelete202Response | ApplicationsDelete204Response | ApplicationsDeleteDefaultResponse

Returns

response

isUnexpected(ApplicationsList200Response | ApplicationsListDefaultResponse)

function isUnexpected(response: ApplicationsList200Response | ApplicationsListDefaultResponse): response

Parameters

response

ApplicationsList200Response | ApplicationsListDefaultResponse

Returns

response

isUnexpected(ServicesGet200Response | ServicesGetDefaultResponse)

function isUnexpected(response: ServicesGet200Response | ServicesGetDefaultResponse): response

Parameters

response

ServicesGet200Response | ServicesGetDefaultResponse

Returns

response

isUnexpected(ServicesCreateOrUpdate202Response | ServicesCreateOrUpdateDefaultResponse)

function isUnexpected(response: ServicesCreateOrUpdate202Response | ServicesCreateOrUpdateDefaultResponse): response

Parameters

response

ServicesCreateOrUpdate202Response | ServicesCreateOrUpdateDefaultResponse

Returns

response

isUnexpected(ServicesUpdate202Response | ServicesUpdateDefaultResponse)

function isUnexpected(response: ServicesUpdate202Response | ServicesUpdateDefaultResponse): response

Parameters

response

ServicesUpdate202Response | ServicesUpdateDefaultResponse

Returns

response

isUnexpected(ServicesDelete202Response | ServicesDelete204Response | ServicesDeleteDefaultResponse)

function isUnexpected(response: ServicesDelete202Response | ServicesDelete204Response | ServicesDeleteDefaultResponse): response

Parameters

response

ServicesDelete202Response | ServicesDelete204Response | ServicesDeleteDefaultResponse

Returns

response

isUnexpected(ServicesList200Response | ServicesListDefaultResponse)

function isUnexpected(response: ServicesList200Response | ServicesListDefaultResponse): response

Parameters

response

ServicesList200Response | ServicesListDefaultResponse

Returns

response

paginate<TResponse>(Client, TResponse, PagingOptions<TResponse>)

Helper to paginate results from an initial response that follows the specification of Autorest x-ms-pageable extension

function paginate<TResponse>(client: Client, initialResponse: TResponse, options?: PagingOptions<TResponse>): PagedAsyncIterableIterator<PaginateReturn<TResponse>>

Parameters

client

Client

Client to use for sending the next page requests

initialResponse

TResponse

Initial response containing the nextLink and current page of elements

options

PagingOptions<TResponse>

Returns

PagedAsyncIterableIterator<PaginateReturn<TResponse>>

• PagedAsyncIterableIterator to iterate the elements