@azure/arm-providerhub package

Classes

ProviderHubClient

Interfaces

AdditionalAuthorization	model interface AdditionalAuthorization
AllowedResourceName	model interface AllowedResourceName
AllowedUnauthorizedActionsExtension	model interface AllowedUnauthorizedActionsExtension
ApiProfile	model interface ApiProfile
ApplicationDataAuthorization	model interface ApplicationDataAuthorization
ApplicationProviderAuthorization	model interface ApplicationProviderAuthorization
AsyncOperationPollingRules	model interface AsyncOperationPollingRules
AsyncTimeoutRule	model interface AsyncTimeoutRule
AuthorizationActionMapping	model interface AuthorizationActionMapping
AuthorizedApplication	Concrete proxy resource types can be created by aliasing this type using a specific property type.
AuthorizedApplicationProperties	model interface AuthorizedApplicationProperties
AuthorizedApplicationsCreateOrUpdateOptionalParams	Optional parameters.
AuthorizedApplicationsDeleteOptionalParams	Optional parameters.
AuthorizedApplicationsGetOptionalParams	Optional parameters.
AuthorizedApplicationsListOptionalParams	Optional parameters.
AuthorizedApplicationsOperations	Interface representing a AuthorizedApplications operations.
CanaryTrafficRegionRolloutConfiguration	model interface CanaryTrafficRegionRolloutConfiguration
CheckNameAvailabilitySpecifications	model interface CheckNameAvailabilitySpecifications
CheckinManifestInfo	model interface CheckinManifestInfo
CheckinManifestOptionalParams	Optional parameters.
CheckinManifestParams	model interface CheckinManifestParams
CustomRollout	Concrete proxy resource types can be created by aliasing this type using a specific property type.
CustomRolloutProperties	model interface CustomRolloutProperties
CustomRolloutPropertiesSpecification	The specification.
CustomRolloutPropertiesStatus	The status.
CustomRolloutSpecification	model interface CustomRolloutSpecification
CustomRolloutSpecificationAutoProvisionConfig	The auto provisioning configuration.
CustomRolloutSpecificationCanary	The canary region configuration.
CustomRolloutSpecificationProviderRegistration	The provider registration.
CustomRolloutStatus	model interface CustomRolloutStatus
CustomRolloutStatusManifestCheckinStatus	The manifest checkin status.
CustomRolloutsCreateOrUpdateOptionalParams	Optional parameters.
CustomRolloutsDeleteOptionalParams	Optional parameters.
CustomRolloutsGetOptionalParams	Optional parameters.
CustomRolloutsListByProviderRegistrationOptionalParams	Optional parameters.
CustomRolloutsOperations	Interface representing a CustomRollouts operations.
CustomRolloutsStopOptionalParams	Optional parameters.
DefaultRollout	Concrete proxy resource types can be created by aliasing this type using a specific property type.
DefaultRolloutProperties	model interface DefaultRolloutProperties
DefaultRolloutPropertiesSpecification	The default rollout specification.
DefaultRolloutPropertiesStatus	The default rollout status.
DefaultRolloutSpecification	model interface DefaultRolloutSpecification
DefaultRolloutSpecificationAutoProvisionConfig	The auto provisioning config.
DefaultRolloutSpecificationCanary	The canary traffic region configuration.
DefaultRolloutSpecificationExpeditedRollout	The expedited rollout definition.
DefaultRolloutSpecificationHighTraffic	The high traffic region configuration.
DefaultRolloutSpecificationLowTraffic	The low traffic region configuration.
DefaultRolloutSpecificationMediumTraffic	The medium traffic region configuration.
DefaultRolloutSpecificationProviderRegistration	The provider registration.
DefaultRolloutSpecificationRestOfTheWorldGroupOne	The rest of the world group one region configuration.
DefaultRolloutSpecificationRestOfTheWorldGroupTwo	The rest of the world group two region configuration.
DefaultRolloutStatus	model interface DefaultRolloutStatus
DefaultRolloutStatusManifestCheckinStatus	The manifest checkin status.
DefaultRolloutsCreateOrUpdateOptionalParams	Optional parameters.
DefaultRolloutsDeleteOptionalParams	Optional parameters.
DefaultRolloutsGetOptionalParams	Optional parameters.
DefaultRolloutsListByProviderRegistrationOptionalParams	Optional parameters.
DefaultRolloutsOperations	Interface representing a DefaultRollouts operations.
DefaultRolloutsStopOptionalParams	Optional parameters.
DeleteDependency	model interface DeleteDependency
DstsConfiguration	model interface DstsConfiguration
EndpointInformation	model interface EndpointInformation
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExpeditedRolloutDefinition	model interface ExpeditedRolloutDefinition
ExtendedErrorInfo	Error information.
ExtendedLocationOptions	model interface ExtendedLocationOptions
ExtensionOptions	model interface ExtensionOptions
FanoutLinkedNotificationRule	model interface FanoutLinkedNotificationRule
FanoutLinkedNotificationRuleDstsConfiguration	The dsts configuration.
FeaturesRule	model interface FeaturesRule
FilterRule	model interface FilterRule
FrontloadPayload	model interface FrontloadPayload
FrontloadPayloadProperties	model interface FrontloadPayloadProperties
FrontloadPayloadPropertiesOverrideEndpointLevelFields	The endpoint level fields to override.
FrontloadPayloadPropertiesOverrideManifestLevelFields	The manifest level fields to override.
GenerateManifestOptionalParams	Optional parameters.
IdentityManagement	model interface IdentityManagement
IdentityManagementProperties	model interface IdentityManagementProperties
LegacyDisallowedCondition	model interface LegacyDisallowedCondition
LightHouseAuthorization	model interface LightHouseAuthorization
LinkedAccessCheck	model interface LinkedAccessCheck
LinkedNotificationRule	model interface LinkedNotificationRule
LinkedOperationRule	model interface LinkedOperationRule
LocalizedOperationDefinition	model interface LocalizedOperationDefinition
LocalizedOperationDefinitionDisplay	Display information of the operation.
LocalizedOperationDisplayDefinition	model interface LocalizedOperationDisplayDefinition
LocalizedOperationDisplayDefinitionCs	Display information of the operation for cs locale.
LocalizedOperationDisplayDefinitionDe	Display information of the operation for de locale.
LocalizedOperationDisplayDefinitionDefault	Display information of the operation.
LocalizedOperationDisplayDefinitionEn	Display information of the operation for en locale.
LocalizedOperationDisplayDefinitionEs	Display information of the operation for es locale.
LocalizedOperationDisplayDefinitionFr	Display information of the operation for fr locale.
LocalizedOperationDisplayDefinitionHu	Display information of the operation for hu locale.
LocalizedOperationDisplayDefinitionIt	Display information of the operation for it locale.
LocalizedOperationDisplayDefinitionJa	Display information of the operation for ja locale.
LocalizedOperationDisplayDefinitionKo	Display information of the operation for ko locale.
LocalizedOperationDisplayDefinitionNl	Display information of the operation for nl locale.
LocalizedOperationDisplayDefinitionPl	Display information of the operation for pl locale.
LocalizedOperationDisplayDefinitionPtBR	Display information of the operation for pt-BR locale.
LocalizedOperationDisplayDefinitionPtPT	Display information of the operation for pt-PT locale.
LocalizedOperationDisplayDefinitionRu	Display information of the operation for ru locale.
LocalizedOperationDisplayDefinitionSv	Display information of the operation for sv locale.
LocalizedOperationDisplayDefinitionZhHans	Display information of the operation for zh-Hans locale.
LocalizedOperationDisplayDefinitionZhHant	Display information of the operation for zh-Hant locale.
LocationQuotaRule	model interface LocationQuotaRule
LoggingHiddenPropertyPath	model interface LoggingHiddenPropertyPath
LoggingRule	model interface LoggingRule
LoggingRuleHiddenPropertyPaths	The hidden property paths.
ManifestLevelPropertyBag	model interface ManifestLevelPropertyBag
NewRegionFrontloadReleaseCreateOrUpdateOptionalParams	Optional parameters.
NewRegionFrontloadReleaseGenerateManifestOptionalParams	Optional parameters.
NewRegionFrontloadReleaseGetOptionalParams	Optional parameters.
NewRegionFrontloadReleaseOperations	Interface representing a NewRegionFrontloadRelease operations.
NewRegionFrontloadReleaseStopOptionalParams	Optional parameters.
Notification	model interface Notification
NotificationEndpoint	model interface NotificationEndpoint
NotificationRegistration	Concrete proxy resource types can be created by aliasing this type using a specific property type.
NotificationRegistrationProperties	model interface NotificationRegistrationProperties
NotificationRegistrationsCreateOrUpdateOptionalParams	Optional parameters.
NotificationRegistrationsDeleteOptionalParams	Optional parameters.
NotificationRegistrationsGetOptionalParams	Optional parameters.
NotificationRegistrationsListByProviderRegistrationOptionalParams	Optional parameters.
NotificationRegistrationsOperations	Interface representing a NotificationRegistrations operations.
OpenApiConfiguration	model interface OpenApiConfiguration
OpenApiValidation	model interface OpenApiValidation
OperationsContentProperties	model interface OperationsContentProperties
OperationsCreateOrUpdateOptionalParams	Optional parameters.
OperationsDefinition	Properties of an Operation.
OperationsDefinitionDisplay	Display information of the operation.
OperationsDeleteOptionalParams	Optional parameters.
OperationsDisplayDefinition	model interface OperationsDisplayDefinition
OperationsListByProviderRegistrationOptionalParams	Optional parameters.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
OperationsPutContent	Concrete proxy resource types can be created by aliasing this type using a specific property type.
OperationsPutContentProperties	model interface OperationsPutContentProperties
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
PrivateResourceProviderConfiguration	model interface PrivateResourceProviderConfiguration
ProviderHubClientOptionalParams	Optional parameters for the client.
ProviderHubMetadata	model interface ProviderHubMetadata
ProviderHubMetadataProviderAuthentication	The provider authentication.
ProviderHubMetadataThirdPartyProviderAuthorization	The third party provider authorization.
ProviderMonitorSetting	Concrete tracked resource types can be created by aliasing this type using a specific property type.
ProviderMonitorSettingProperties	model interface ProviderMonitorSettingProperties
ProviderMonitorSettingsCreateOptionalParams	Optional parameters.
ProviderMonitorSettingsDeleteOptionalParams	Optional parameters.
ProviderMonitorSettingsGetOptionalParams	Optional parameters.
ProviderMonitorSettingsListByResourceGroupOptionalParams	Optional parameters.
ProviderMonitorSettingsListBySubscriptionOptionalParams	Optional parameters.
ProviderMonitorSettingsOperations	Interface representing a ProviderMonitorSettings operations.
ProviderMonitorSettingsUpdateOptionalParams	Optional parameters.
ProviderRegistration	Concrete proxy resource types can be created by aliasing this type using a specific property type.
ProviderRegistrationProperties	model interface ProviderRegistrationProperties
ProviderRegistrationPropertiesPrivateResourceProviderConfiguration	The private resource provider configuration.
ProviderRegistrationPropertiesProviderHubMetadata	The provider hub metadata.
ProviderRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications	The subscription lifecycle notification specifications.
ProviderRegistrationsCreateOrUpdateOptionalParams	Optional parameters.
ProviderRegistrationsDeleteOptionalParams	Optional parameters.
ProviderRegistrationsGenerateOperationsOptionalParams	Optional parameters.
ProviderRegistrationsGetOptionalParams	Optional parameters.
ProviderRegistrationsListOptionalParams	Optional parameters.
ProviderRegistrationsOperations	Interface representing a ProviderRegistrations operations.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
QuotaRule	model interface QuotaRule
ReRegisterSubscriptionMetadata	model interface ReRegisterSubscriptionMetadata
RequestHeaderOptions	model interface RequestHeaderOptions
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
ResourceAccessRole	model interface ResourceAccessRole
ResourceActionsDeleteResourcesOptionalParams	Optional parameters.
ResourceActionsOperations	Interface representing a ResourceActions operations.
ResourceConcurrencyControlOption	model interface ResourceConcurrencyControlOption
ResourceGraphConfiguration	model interface ResourceGraphConfiguration
ResourceHydrationAccount	model interface ResourceHydrationAccount
ResourceManagementAction	model interface ResourceManagementAction
ResourceManagementEntity	model interface ResourceManagementEntity
ResourceMovePolicy	model interface ResourceMovePolicy
ResourceProviderAuthentication	model interface ResourceProviderAuthentication
ResourceProviderAuthorization	model interface ResourceProviderAuthorization
ResourceProviderAuthorizationManagedByAuthorization	Managed by authorization.
ResourceProviderAuthorizationRules	model interface ResourceProviderAuthorizationRules
ResourceProviderCapabilities	model interface ResourceProviderCapabilities
ResourceProviderEndpoint	model interface ResourceProviderEndpoint
ResourceProviderEndpointFeaturesRule	The feature rules.
ResourceProviderManagement	model interface ResourceProviderManagement
ResourceProviderManagementErrorResponseMessageOptions	Options for error response messages.
ResourceProviderManagementExpeditedRolloutMetadata	Metadata for expedited rollout.
ResourceProviderManifest	model interface ResourceProviderManifest
ResourceProviderManifestFeaturesRule	The features rule.
ResourceProviderManifestManagement	The resource provider management.
ResourceProviderManifestProperties	model interface ResourceProviderManifestProperties
ResourceProviderManifestPropertiesDstsConfiguration	The dsts configuration.
ResourceProviderManifestPropertiesFeaturesRule	The features rule.
ResourceProviderManifestPropertiesManagement	The resource provider management.
ResourceProviderManifestPropertiesNotificationSettings	Notification settings.
ResourceProviderManifestPropertiesProviderAuthentication	The provider authentication.
ResourceProviderManifestPropertiesRequestHeaderOptions	The request header options.
ResourceProviderManifestPropertiesResourceGroupLockOptionDuringMove	Resource group lock option during move.
ResourceProviderManifestPropertiesResponseOptions	Response options.
ResourceProviderManifestPropertiesTemplateDeploymentOptions	The template deployment options.
ResourceProviderManifestProviderAuthentication	The provider authentication.
ResourceProviderManifestReRegisterSubscriptionMetadata	The re-register subscription metadata.
ResourceProviderManifestRequestHeaderOptions	The request header options.
ResourceProviderService	Resource provider service.
ResourceType	model interface ResourceType
ResourceTypeEndpoint	model interface ResourceTypeEndpoint
ResourceTypeEndpointBase	model interface ResourceTypeEndpointBase
ResourceTypeEndpointBaseDstsConfiguration	The dsts configuration.
ResourceTypeEndpointBaseFeaturesRule	The features rule.
ResourceTypeEndpointDstsConfiguration	The dsts configuration.
ResourceTypeEndpointFeaturesRule	The features rule.
ResourceTypeExtension	model interface ResourceTypeExtension
ResourceTypeExtensionOptions	model interface ResourceTypeExtensionOptions
ResourceTypeExtensionOptionsResourceCreationBegin	Resource creation begin.
ResourceTypeFeaturesRule	The features rule.
ResourceTypeIdentityManagement	The identity management.
ResourceTypeOnBehalfOfToken	model interface ResourceTypeOnBehalfOfToken
ResourceTypeRegistration	Concrete proxy resource types can be created by aliasing this type using a specific property type.
ResourceTypeRegistrationProperties	model interface ResourceTypeRegistrationProperties
ResourceTypeRegistrationPropertiesAvailabilityZoneRule	The availability zone rule.
ResourceTypeRegistrationPropertiesCapacityRule	Capacity rule.
ResourceTypeRegistrationPropertiesCheckNameAvailabilitySpecifications	The check name availability specifications.
ResourceTypeRegistrationPropertiesDstsConfiguration	The dsts configuration.
ResourceTypeRegistrationPropertiesExtensionOptions	The extension options.
ResourceTypeRegistrationPropertiesFeaturesRule	The features rule.
ResourceTypeRegistrationPropertiesIdentityManagement	The identity management.
ResourceTypeRegistrationPropertiesLegacyPolicy	The legacy policy.
ResourceTypeRegistrationPropertiesManagement	The resource provider management.
ResourceTypeRegistrationPropertiesMarketplaceOptions	Marketplace options.
ResourceTypeRegistrationPropertiesRequestHeaderOptions	The request header options.
ResourceTypeRegistrationPropertiesResourceCache	Resource cache options.
ResourceTypeRegistrationPropertiesResourceGraphConfiguration	The resource graph configuration.
ResourceTypeRegistrationPropertiesResourceManagementOptions	Resource management options.
ResourceTypeRegistrationPropertiesResourceManagementOptionsBatchProvisioningSupport	Batch provisioning support.
ResourceTypeRegistrationPropertiesResourceManagementOptionsNestedProvisioningSupport	Nested provisioning support.
ResourceTypeRegistrationPropertiesResourceMovePolicy	The resource move policy.
ResourceTypeRegistrationPropertiesResourceQueryManagement	Resource query management options.
ResourceTypeRegistrationPropertiesResourceTypeCommonAttributeManagement	Resource type common attribute management.
ResourceTypeRegistrationPropertiesRoutingRule	Routing rule.
ResourceTypeRegistrationPropertiesSubscriptionLifecycleNotificationSpecifications	The subscription lifecycle notification specifications.
ResourceTypeRegistrationPropertiesTemplateDeploymentOptions	The template deployment options.
ResourceTypeRegistrationPropertiesTemplateDeploymentPolicy	The template deployment policy.
ResourceTypeRegistrationsCreateOrUpdateOptionalParams	Optional parameters.
ResourceTypeRegistrationsDeleteOptionalParams	Optional parameters.
ResourceTypeRegistrationsGetOptionalParams	Optional parameters.
ResourceTypeRegistrationsListByProviderRegistrationOptionalParams	Optional parameters.
ResourceTypeRegistrationsOperations	Interface representing a ResourceTypeRegistrations operations.
ResourceTypeRequestHeaderOptions	The request header options.
ResourceTypeSku	model interface ResourceTypeSku
ResourceTypeTemplateDeploymentPolicy	The template deployment policy.
RestorePollerOptions
RolloutStatusBase	model interface RolloutStatusBase
ServiceTreeInfo	model interface ServiceTreeInfo
SkuCapability	model interface SkuCapability
SkuCapacity	model interface SkuCapacity
SkuCost	model interface SkuCost
SkuLocationInfo	model interface SkuLocationInfo
SkuResource	Concrete proxy resource types can be created by aliasing this type using a specific property type.
SkuResourceProperties	model interface SkuResourceProperties
SkuSetting	model interface SkuSetting
SkuSettingCapacity	The capacity.
SkuZoneDetail	model interface SkuZoneDetail
SkusCreateOrUpdateNestedResourceTypeFirstOptionalParams	Optional parameters.
SkusCreateOrUpdateNestedResourceTypeSecondOptionalParams	Optional parameters.
SkusCreateOrUpdateNestedResourceTypeThirdOptionalParams	Optional parameters.
SkusCreateOrUpdateOptionalParams	Optional parameters.
SkusDeleteNestedResourceTypeFirstOptionalParams	Optional parameters.
SkusDeleteNestedResourceTypeSecondOptionalParams	Optional parameters.
SkusDeleteNestedResourceTypeThirdOptionalParams	Optional parameters.
SkusDeleteOptionalParams	Optional parameters.
SkusGetNestedResourceTypeFirstOptionalParams	Optional parameters.
SkusGetNestedResourceTypeSecondOptionalParams	Optional parameters.
SkusGetNestedResourceTypeThirdOptionalParams	Optional parameters.
SkusGetOptionalParams	Optional parameters.
SkusListByResourceTypeRegistrationsNestedResourceTypeFirstOptionalParams	Optional parameters.
SkusListByResourceTypeRegistrationsNestedResourceTypeSecondOptionalParams	Optional parameters.
SkusListByResourceTypeRegistrationsNestedResourceTypeThirdOptionalParams	Optional parameters.
SkusListByResourceTypeRegistrationsOptionalParams	Optional parameters.
SkusOperations	Interface representing a Skus operations.
SubscriberSetting	model interface SubscriberSetting
SubscriptionLifecycleNotificationSpecifications	model interface SubscriptionLifecycleNotificationSpecifications
SubscriptionStateOverrideAction	model interface SubscriptionStateOverrideAction
SubscriptionStateRule	model interface SubscriptionStateRule
SwaggerSpecification	model interface SwaggerSpecification
SystemData	Metadata pertaining to creation and last modification of the resource.
TemplateDeploymentOptions	model interface TemplateDeploymentOptions
TemplateDeploymentPolicy	model interface TemplateDeploymentPolicy
ThirdPartyExtension	model interface ThirdPartyExtension
ThirdPartyProviderAuthorization	model interface ThirdPartyProviderAuthorization
ThrottlingMetric	model interface ThrottlingMetric
ThrottlingRule	model interface ThrottlingRule
TokenAuthConfiguration	model interface TokenAuthConfiguration
TrackedResource	The resource model definition for an Azure Resource Manager tracked top level resource which has 'tags' and a 'location'
TrafficRegionRolloutConfiguration	model interface TrafficRegionRolloutConfiguration
TrafficRegions	model interface TrafficRegions
TypedErrorInfo	Error information.

Type Aliases

AdditionalOptions	The additional options. KnownAdditionalOptions can be used interchangeably with AdditionalOptions, this enum contains the known values that the service supports. Known values supported by the service ProtectedAsyncOperationPolling ProtectedAsyncOperationPollingAuditOnly
AdditionalOptionsAsyncOperation	The additional options. KnownAdditionalOptionsAsyncOperation can be used interchangeably with AdditionalOptionsAsyncOperation, this enum contains the known values that the service supports. Known values supported by the service ProtectedAsyncOperationPolling ProtectedAsyncOperationPollingAuditOnly
AdditionalOptionsResourceTypeRegistration	The additional options. KnownAdditionalOptionsResourceTypeRegistration can be used interchangeably with AdditionalOptionsResourceTypeRegistration, this enum contains the known values that the service supports. Known values supported by the service ProtectedAsyncOperationPolling ProtectedAsyncOperationPollingAuditOnly
AuthenticationScheme	The authentication scheme. KnownAuthenticationScheme can be used interchangeably with AuthenticationScheme, this enum contains the known values that the service supports. Known values supported by the service PoP Bearer
AvailabilityZonePolicy	Type of AvailabilityZonePolicy
AvailableCheckInManifestEnvironment	The environment type. KnownAvailableCheckInManifestEnvironment can be used interchangeably with AvailableCheckInManifestEnvironment, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Canary Prod All Mooncake Fairfax
AzureSupportedClouds	The supported values for cloud setting as a string literal type
BlockActionVerb	The action verb that will be blocked when the resource group is locked during move. KnownBlockActionVerb can be used interchangeably with BlockActionVerb, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Read Write Action Delete Unrecognized
CapacityPolicy	Capacity policy. KnownCapacityPolicy can be used interchangeably with CapacityPolicy, this enum contains the known values that the service supports. Known values supported by the service Default Restricted
CommonApiVersionsMergeMode	Common api versions merge mode. KnownCommonApiVersionsMergeMode can be used interchangeably with CommonApiVersionsMergeMode, this enum contains the known values that the service supports. Known values supported by the service Merge Overwrite
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
CrossTenantTokenValidation	The cross tenant token validation. KnownCrossTenantTokenValidation can be used interchangeably with CrossTenantTokenValidation, this enum contains the known values that the service supports. Known values supported by the service EnsureSecureValidation PassthroughInsecureToken
DataBoundary	The data boundary. KnownDataBoundary can be used interchangeably with DataBoundary, this enum contains the known values that the service supports. Known values supported by the service NotDefined Global EU US
EndpointType	The endpoint type. KnownEndpointType can be used interchangeably with EndpointType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Canary Production TestInProduction
EndpointTypeResourceType	The endpoint type. KnownEndpointTypeResourceType can be used interchangeably with EndpointTypeResourceType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Canary Production TestInProduction
ExpeditedRolloutIntent	Expedited rollout intent. KnownExpeditedRolloutIntent can be used interchangeably with ExpeditedRolloutIntent, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Hotfix
ExtendedLocationType	The extended location type. KnownExtendedLocationType can be used interchangeably with ExtendedLocationType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified: The extended location type is not specified. CustomLocation: The extended location type is custom location. EdgeZone: The extended location type is edge zone. ArcZone: The extended location type is arc zone.
ExtensionCategory	Type of ExtensionCategory
ExtensionOptionType	Type of ExtensionOptionType
FeaturesPolicy	The required feature policy. KnownFeaturesPolicy can be used interchangeably with FeaturesPolicy, this enum contains the known values that the service supports. Known values supported by the service Any All
FilterOption	Filter option. KnownFilterOption can be used interchangeably with FilterOption, this enum contains the known values that the service supports. Known values supported by the service NotSpecified EnableSubscriptionFilterOnTenant
FrontdoorRequestMode	The frontdoor request mode. KnownFrontdoorRequestMode can be used interchangeably with FrontdoorRequestMode, this enum contains the known values that the service supports. Known values supported by the service NotSpecified UseManifest
IdentityManagementTypes	The type. KnownIdentityManagementTypes can be used interchangeably with IdentityManagementTypes, this enum contains the known values that the service supports. Known values supported by the service NotSpecified SystemAssigned UserAssigned Actor DelegatedResourceIdentity
Intent	The intent. KnownIntent can be used interchangeably with Intent, this enum contains the known values that the service supports. Known values supported by the service NOT_SPECIFIED: Default value. LOW_PRIVILEGE: Data is not sensitive and ok to access. DEFERRED_ACCESS_CHECK: Used for RP's using a custom authorization check outside of ARM. RP_CONTRACT: RP contract allows certain operations to be unauthorized action.
LegacyOperation	Type of LegacyOperation
LinkedAction	The linked action. KnownLinkedAction can be used interchangeably with LinkedAction, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Blocked Validate Enabled
LinkedOperation	The linked operation. KnownLinkedOperation can be used interchangeably with LinkedOperation, this enum contains the known values that the service supports. Known values supported by the service None CrossResourceGroupResourceMove CrossSubscriptionResourceMove
LoggingDetails	The detail level. KnownLoggingDetails can be used interchangeably with LoggingDetails, this enum contains the known values that the service supports. Known values supported by the service None Body
LoggingDirections	The direction. KnownLoggingDirections can be used interchangeably with LoggingDirections, this enum contains the known values that the service supports. Known values supported by the service None Request Response
ManifestResourceDeletionPolicy	The resource deletion policy. KnownManifestResourceDeletionPolicy can be used interchangeably with ManifestResourceDeletionPolicy, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Cascade Force
MarketplaceType	The marketplace type.
MessageScope	The message scope. KnownMessageScope can be used interchangeably with MessageScope, this enum contains the known values that the service supports. Known values supported by the service NotSpecified RegisteredSubscriptions
NotificationEndpointType	The endpoint type. KnownNotificationEndpointType can be used interchangeably with NotificationEndpointType, this enum contains the known values that the service supports. Known values supported by the service Webhook Eventhub
NotificationMode	The notification mode. KnownNotificationMode can be used interchangeably with NotificationMode, this enum contains the known values that the service supports. Known values supported by the service NotSpecified EventHub WebHook
NotificationOptions	Notification options. KnownNotificationOptions can be used interchangeably with NotificationOptions, this enum contains the known values that the service supports. Known values supported by the service NotSpecified None EmitSpendingLimit
NotificationType	The notification type. KnownNotificationType can be used interchangeably with NotificationType, this enum contains the known values that the service supports. Known values supported by the service Unspecified SubscriptionNotification
OperationActionType	The action type.
OperationOrigins	The origin.
OptInHeaderType	The opt in headers. KnownOptInHeaderType can be used interchangeably with OptInHeaderType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified SignedUserToken ClientGroupMembership SignedAuxiliaryTokens UnboundedClientGroupMembership PrivateLinkId PrivateLinkResourceId ManagementGroupAncestorsEncoded PrivateLinkVnetTrafficTag ResourceGroupLocation ClientPrincipalNameEncoded MSIResourceIdEncoded
OptOutHeaderType	The opt out headers. KnownOptOutHeaderType can be used interchangeably with OptOutHeaderType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified SystemDataCreatedByLastModifiedBy
Policy	The policy. KnownPolicy can be used interchangeably with Policy, this enum contains the known values that the service supports. Known values supported by the service NotSpecified SynchronizeBeginExtension
PolicyExecutionType	The policy execution type. KnownPolicyExecutionType can be used interchangeably with PolicyExecutionType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified ExecutePolicies BypassPolicies ExpectPartialPutRequests
PreflightOption	Type of PreflightOption
ProviderRegistrationKind	Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. KnownProviderRegistrationKind can be used interchangeably with ProviderRegistrationKind, this enum contains the known values that the service supports. Known values supported by the service Managed: Resource Provider with all the resource types 'managed' by the ProviderHub service. Hybrid: Resource Provider with a mix of 'managed' and 'direct' resource types. Direct: Resource Provider with all the resource types 'managed' on by itself.
ProvisioningState	Type of ProvisioningState
QuotaPolicy	Type of QuotaPolicy
Readiness	The readiness. KnownReadiness can be used interchangeably with Readiness, this enum contains the known values that the service supports. Known values supported by the service ClosingDown Deprecated GA InDevelopment InternalOnly PrivatePreview PublicPreview RemovedFromARM Retired
Regionality	The regionality. KnownRegionality can be used interchangeably with Regionality, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Global Regional
ResourceAccessPolicy	The resource access policy.
ResourceDeletionPolicy	The resource deletion policy. KnownResourceDeletionPolicy can be used interchangeably with ResourceDeletionPolicy, this enum contains the known values that the service supports. Known values supported by the service NotSpecified CascadeDeleteAll CascadeDeleteProxyOnlyChildren
ResourceProviderCapabilitiesEffect	The effect. KnownResourceProviderCapabilitiesEffect can be used interchangeably with ResourceProviderCapabilitiesEffect, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Allow Disallow
ResourceProviderType	The provider type. KnownResourceProviderType can be used interchangeably with ResourceProviderType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Internal External Hidden RegistrationFree LegacyRegistrationRequired TenantOnly AuthorizationFree
ResourceSubType	The resource sub type. KnownResourceSubType can be used interchangeably with ResourceSubType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified AsyncOperation
ResourceTypeCategory	The category. KnownResourceTypeCategory can be used interchangeably with ResourceTypeCategory, this enum contains the known values that the service supports. Known values supported by the service None FreeForm Internal PureProxy
ResourceTypeEndpointKind	Resource type endpoint kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. KnownResourceTypeEndpointKind can be used interchangeably with ResourceTypeEndpointKind, this enum contains the known values that the service supports. Known values supported by the service Managed: Endpoint served by ProviderHub service Direct: Endpoint served by the onboarded Resource Provider Service.
ResourceTypeExtendedLocationPolicy	Type of ResourceTypeExtendedLocationPolicy
ResourceTypeRegistrationKind	Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. KnownResourceTypeRegistrationKind can be used interchangeably with ResourceTypeRegistrationKind, this enum contains the known values that the service supports. Known values supported by the service Managed: Resource type served by the ProviderHub service. Hybrid: Resource type served by both the ProviderHub & the onboarded Resource Provider Services (i.e. The type has a mix of managed and direct endpoints). Direct: Resource type served by the onboarded Resource Provider Service.
ResourceValidation	The resource validation. KnownResourceValidation can be used interchangeably with ResourceValidation, this enum contains the known values that the service supports. Known values supported by the service NotSpecified ReservedWords ProfaneWords
Role	The ownership role the application has on the resource types. The service owner role gives the application owner permissions. The limited owner role gives elevated permissions but does not allow all the permissions of a service owner, such as read/write on internal metadata. KnownRole can be used interchangeably with Role, this enum contains the known values that the service supports. Known values supported by the service ServiceOwner LimitedOwner
RoutingType	The routing type. KnownRoutingType can be used interchangeably with RoutingType, this enum contains the known values that the service supports. Known values supported by the service Default: The resource routing type is default. ProxyOnly: The resource routing type is proxy only. HostBased: The resource routing type is host based. Extension: The resource routing type is extension. Tenant: The resource routing type is tenant. Fanout: The resource routing type is fanout. LocationBased: The resource routing type is location based. Failover: The resource routing type is failover. CascadeExtension: The resource routing type is cascade extension. ChildFanout: The resource routing type is child fanout. CascadeAuthorizedExtension: The resource routing type is cascade authorized extension. BypassEndpointSelectionOptimization: The resource routing type is bypass endpoint selection optimization. LocationMapping: The resource routing type is location mapping. ServiceFanout: The resource routing type is service fanout.
ServerFailureResponseMessageType	Type of server failure response message. KnownServerFailureResponseMessageType can be used interchangeably with ServerFailureResponseMessageType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified OutageReporting
ServiceClientOptionsType	Type of ServiceClientOptionsType
ServiceFeatureFlagAction	The service feature flag. KnownServiceFeatureFlagAction can be used interchangeably with ServiceFeatureFlagAction, this enum contains the known values that the service supports. Known values supported by the service DoNotCreate Create
ServiceStatus	The status. KnownServiceStatus can be used interchangeably with ServiceStatus, this enum contains the known values that the service supports. Known values supported by the service Active Inactive
SignedRequestScope	The signed request scope. KnownSignedRequestScope can be used interchangeably with SignedRequestScope, this enum contains the known values that the service supports. Known values supported by the service ResourceUri Endpoint
SkipNotifications	Whether notifications should be skipped. KnownSkipNotifications can be used interchangeably with SkipNotifications, this enum contains the known values that the service supports. Known values supported by the service Unspecified Enabled Disabled
SkuScaleType	The scale type. KnownSkuScaleType can be used interchangeably with SkuScaleType, this enum contains the known values that the service supports. Known values supported by the service None Manual Automatic
SubscriptionNotificationOperation	The action. KnownSubscriptionNotificationOperation can be used interchangeably with SubscriptionNotificationOperation, this enum contains the known values that the service supports. Known values supported by the service NotDefined DeleteAllResources SoftDeleteAllResources NoOp BillingCancellation UndoSoftDelete
SubscriptionReregistrationResult	The subscription reregistration result. KnownSubscriptionReregistrationResult can be used interchangeably with SubscriptionReregistrationResult, this enum contains the known values that the service supports. Known values supported by the service NotApplicable ConditionalUpdate ForcedUpdate Failed
SubscriptionState	The subscription state. KnownSubscriptionState can be used interchangeably with SubscriptionState, this enum contains the known values that the service supports. Known values supported by the service NotDefined Enabled Warned PastDue Disabled Deleted
SubscriptionTransitioningState	The state. KnownSubscriptionTransitioningState can be used interchangeably with SubscriptionTransitioningState, this enum contains the known values that the service supports. Known values supported by the service Registered Unregistered Warned Suspended Deleted WarnedToRegistered WarnedToSuspended WarnedToDeleted WarnedToUnregistered SuspendedToRegistered SuspendedToWarned SuspendedToDeleted SuspendedToUnregistered
SupportedOperations	Supported operations. KnownSupportedOperations can be used interchangeably with SupportedOperations, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Get Delete
TemplateDeploymentCapabilities	The capabilities. KnownTemplateDeploymentCapabilities can be used interchangeably with TemplateDeploymentCapabilities, this enum contains the known values that the service supports. Known values supported by the service Default Preflight
TemplateDeploymentPreflightNotifications	The preflight notifications. KnownTemplateDeploymentPreflightNotifications can be used interchangeably with TemplateDeploymentPreflightNotifications, this enum contains the known values that the service supports. Known values supported by the service None UnregisteredSubscriptions
TemplateDeploymentPreflightOptions	The preflight options. KnownTemplateDeploymentPreflightOptions can be used interchangeably with TemplateDeploymentPreflightOptions, this enum contains the known values that the service supports. Known values supported by the service None ValidationRequests DeploymentRequests TestOnly RegisteredOnly
ThrottlingMetricType	The throttling metric type KnownThrottlingMetricType can be used interchangeably with ThrottlingMetricType, this enum contains the known values that the service supports. Known values supported by the service NotSpecified NumberOfRequests NumberOfResources
TrafficRegionCategory	The next traffic region. KnownTrafficRegionCategory can be used interchangeably with TrafficRegionCategory, this enum contains the known values that the service supports. Known values supported by the service NotSpecified Canary LowTraffic MediumTraffic HighTraffic None RestOfTheWorldGroupOne RestOfTheWorldGroupTwo

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownAdditionalOptions	The additional options.
KnownAdditionalOptionsAsyncOperation	The additional options.
KnownAdditionalOptionsResourceTypeRegistration	The additional options.
KnownAuthenticationScheme	The authentication scheme.
KnownAvailabilityZonePolicy	Known values of AvailabilityZonePolicy that the service accepts.
KnownAvailableCheckInManifestEnvironment	The environment type.
KnownBlockActionVerb	The action verb that will be blocked when the resource group is locked during move.
KnownCapacityPolicy	Capacity policy.
KnownCommonApiVersionsMergeMode	Common api versions merge mode.
KnownCreatedByType	The kind of entity that created the resource.
KnownCrossTenantTokenValidation	The cross tenant token validation.
KnownDataBoundary	The data boundary.
KnownEndpointType	The endpoint type.
KnownEndpointTypeResourceType	The endpoint type.
KnownExpeditedRolloutIntent	Expedited rollout intent.
KnownExtendedLocationType	The extended location type.
KnownExtensionCategory	Known values of ExtensionCategory that the service accepts.
KnownExtensionOptionType	Known values of ExtensionOptionType that the service accepts.
KnownFeaturesPolicy	The required feature policy.
KnownFilterOption	Filter option.
KnownFrontdoorRequestMode	The frontdoor request mode.
KnownIdentityManagementTypes	The type.
KnownIntent	The intent.
KnownLegacyOperation	Known values of LegacyOperation that the service accepts.
KnownLinkedAction	The linked action.
KnownLinkedOperation	The linked operation.
KnownLoggingDetails	The detail level.
KnownLoggingDirections	The direction.
KnownManifestResourceDeletionPolicy	The resource deletion policy.
KnownMessageScope	The message scope.
KnownNotificationEndpointType	The endpoint type.
KnownNotificationMode	The notification mode.
KnownNotificationOptions	Notification options.
KnownNotificationType	The notification type.
KnownOptInHeaderType	The opt in headers.
KnownOptOutHeaderType	The opt out headers.
KnownPolicy	The policy.
KnownPolicyExecutionType	The policy execution type.
KnownPreflightOption	Known values of PreflightOption that the service accepts.
KnownProviderRegistrationKind	Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type.
KnownProvisioningState	Known values of ProvisioningState that the service accepts.
KnownQuotaPolicy	Known values of QuotaPolicy that the service accepts.
KnownReadiness	The readiness.
KnownRegionality	The regionality.
KnownResourceDeletionPolicy	The resource deletion policy.
KnownResourceProviderCapabilitiesEffect	The effect.
KnownResourceProviderType	The provider type.
KnownResourceSubType	The resource sub type.
KnownResourceTypeCategory	The category.
KnownResourceTypeEndpointKind	Resource type endpoint kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type.
KnownResourceTypeExtendedLocationPolicy	Known values of ResourceTypeExtendedLocationPolicy that the service accepts.
KnownResourceTypeRegistrationKind	Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type.
KnownResourceValidation	The resource validation.
KnownRole	The ownership role the application has on the resource types. The service owner role gives the application owner permissions. The limited owner role gives elevated permissions but does not allow all the permissions of a service owner, such as read/write on internal metadata.
KnownRoutingType	The routing type.
KnownServerFailureResponseMessageType	Type of server failure response message.
KnownServiceClientOptionsType	Known values of ServiceClientOptionsType that the service accepts.
KnownServiceFeatureFlagAction	The service feature flag.
KnownServiceStatus	The status.
KnownSignedRequestScope	The signed request scope.
KnownSkipNotifications	Whether notifications should be skipped.
KnownSkuScaleType	The scale type.
KnownSubscriptionNotificationOperation	The action.
KnownSubscriptionReregistrationResult	The subscription reregistration result.
KnownSubscriptionState	The subscription state.
KnownSubscriptionTransitioningState	The state.
KnownSupportedOperations	Supported operations.
KnownTemplateDeploymentCapabilities	The capabilities.
KnownTemplateDeploymentPreflightNotifications	The preflight notifications.
KnownTemplateDeploymentPreflightOptions	The preflight options.
KnownThrottlingMetricType	The throttling metric type
KnownTrafficRegionCategory	The next traffic region.
KnownVersions	The available API versions.

Functions

restorePoller<TResponse, TResult>(ProviderHubClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Function Details

restorePoller<TResponse, TResult>(ProviderHubClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: ProviderHubClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

ProviderHubClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>