@azure/arm-resources
Version:
A generated SDK for ResourceManagementClient.
943 lines (774 loc) • 29.2 kB
Markdown
## API Report File for "@azure/arm-resources"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import * as coreAuth from '@azure/core-auth';
import * as coreClient from '@azure/core-client';
import { OperationState } from '@azure/core-lro';
import { PagedAsyncIterableIterator } from '@azure/core-paging';
import { SimplePollerLike } from '@azure/core-lro';
// @public
export interface Alias {
readonly defaultMetadata?: AliasPathMetadata;
defaultPath?: string;
defaultPattern?: AliasPattern;
name?: string;
paths?: AliasPath[];
type?: AliasType;
}
// @public
export interface AliasPath {
apiVersions?: string[];
readonly metadata?: AliasPathMetadata;
path?: string;
pattern?: AliasPattern;
}
// @public
export type AliasPathAttributes = string;
// @public (undocumented)
export interface AliasPathMetadata {
readonly attributes?: AliasPathAttributes;
readonly type?: AliasPathTokenType;
}
// @public
export type AliasPathTokenType = string;
// @public
export interface AliasPattern {
phrase?: string;
type?: AliasPatternType;
variable?: string;
}
// @public
export type AliasPatternType = "NotSpecified" | "Extract";
// @public
export type AliasType = "NotSpecified" | "PlainText" | "Mask";
// @public (undocumented)
export interface ApiProfile {
readonly apiVersion?: string;
readonly profileVersion?: string;
}
// @public
export interface CloudError {
error?: ErrorResponse;
}
// @public
export interface ErrorAdditionalInfo {
readonly info?: Record<string, unknown>;
readonly type?: string;
}
// @public
export interface ErrorResponse {
readonly additionalInfo?: ErrorAdditionalInfo[];
readonly code?: string;
readonly details?: ErrorResponse[];
readonly message?: string;
readonly target?: string;
}
// @public
export type ExportTemplateOutputFormat = string;
// @public
export interface ExportTemplateRequest {
options?: string;
outputFormat?: ExportTemplateOutputFormat;
resources?: string[];
}
// @public
export interface ExtendedLocation {
name?: string;
type?: ExtendedLocationType;
}
// @public
export type ExtendedLocationType = string;
// @public
export interface GenericResource extends Resource {
identity?: Identity;
kind?: string;
managedBy?: string;
plan?: Plan;
properties?: Record<string, unknown>;
sku?: Sku;
}
// @public
export interface GenericResourceExpanded extends GenericResource {
readonly changedTime?: Date;
readonly createdTime?: Date;
readonly provisioningState?: string;
}
// @public
export interface GenericResourceFilter {
resourceType?: string;
tagname?: string;
tagvalue?: string;
}
// @public
export function getContinuationToken(page: unknown): string | undefined;
// @public
export interface Identity {
readonly principalId?: string;
readonly tenantId?: string;
type?: ResourceIdentityType;
userAssignedIdentities?: {
[propertyName: string]: IdentityUserAssignedIdentitiesValue;
};
}
// @public (undocumented)
export interface IdentityUserAssignedIdentitiesValue {
readonly clientId?: string;
readonly principalId?: string;
}
// @public
export enum KnownAliasPathAttributes {
Modifiable = "Modifiable",
None = "None"
}
// @public
export enum KnownAliasPathTokenType {
Any = "Any",
Array = "Array",
Boolean = "Boolean",
Integer = "Integer",
NotSpecified = "NotSpecified",
Number = "Number",
Object = "Object",
String = "String"
}
// @public
export enum KnownExportTemplateOutputFormat {
Bicep = "Bicep",
Json = "Json"
}
// @public
export enum KnownExtendedLocationType {
EdgeZone = "EdgeZone"
}
// @public
export enum KnownProviderAuthorizationConsentState {
Consented = "Consented",
NotRequired = "NotRequired",
NotSpecified = "NotSpecified",
Required = "Required"
}
// @public
export enum KnownTagsPatchOperation {
Delete = "Delete",
Merge = "Merge",
Replace = "Replace"
}
// @public
export interface Operation {
display?: OperationDisplay;
name?: string;
}
// @public
export interface OperationDisplay {
description?: string;
operation?: string;
provider?: string;
resource?: string;
}
// @public
export interface OperationListResult {
nextLink?: string;
value?: Operation[];
}
// @public
export interface Operations {
list(options?: OperationsListOptionalParams): PagedAsyncIterableIterator<Operation>;
}
// @public
export interface OperationsListNextOptionalParams extends coreClient.OperationOptions {
}
// @public
export type OperationsListNextResponse = OperationListResult;
// @public
export interface OperationsListOptionalParams extends coreClient.OperationOptions {
}
// @public
export type OperationsListResponse = OperationListResult;
// @public
export interface Permission {
actions?: string[];
dataActions?: string[];
notActions?: string[];
notDataActions?: string[];
}
// @public
export interface Plan {
name?: string;
product?: string;
promotionCode?: string;
publisher?: string;
version?: string;
}
// @public
export interface Provider {
readonly id?: string;
namespace?: string;
providerAuthorizationConsentState?: ProviderAuthorizationConsentState;
readonly registrationPolicy?: string;
readonly registrationState?: string;
readonly resourceTypes?: ProviderResourceType[];
}
// @public
export type ProviderAuthorizationConsentState = string;
// @public
export interface ProviderConsentDefinition {
consentToAuthorization?: boolean;
}
// @public
export interface ProviderExtendedLocation {
extendedLocations?: string[];
location?: string;
type?: string;
}
// @public
export interface ProviderListResult {
readonly nextLink?: string;
value?: Provider[];
}
// @public
export interface ProviderPermission {
applicationId?: string;
managedByRoleDefinition?: RoleDefinition;
providerAuthorizationConsentState?: ProviderAuthorizationConsentState;
roleDefinition?: RoleDefinition;
}
// @public
export interface ProviderPermissionListResult {
readonly nextLink?: string;
value?: ProviderPermission[];
}
// @public
export interface ProviderRegistrationRequest {
thirdPartyProviderConsent?: ProviderConsentDefinition;
}
// @public
export interface ProviderResourceType {
aliases?: Alias[];
readonly apiProfiles?: ApiProfile[];
apiVersions?: string[];
capabilities?: string;
readonly defaultApiVersion?: string;
locationMappings?: ProviderExtendedLocation[];
locations?: string[];
properties?: {
[propertyName: string]: string;
};
resourceType?: string;
// (undocumented)
zoneMappings?: ZoneMapping[];
}
// @public
export interface ProviderResourceTypeListResult {
readonly nextLink?: string;
value?: ProviderResourceType[];
}
// @public
export interface ProviderResourceTypes {
list(resourceProviderNamespace: string, options?: ProviderResourceTypesListOptionalParams): Promise<ProviderResourceTypesListResponse>;
}
// @public
export interface ProviderResourceTypesListOptionalParams extends coreClient.OperationOptions {
expand?: string;
}
// @public
export type ProviderResourceTypesListResponse = ProviderResourceTypeListResult;
// @public
export interface Providers {
get(resourceProviderNamespace: string, options?: ProvidersGetOptionalParams): Promise<ProvidersGetResponse>;
getAtTenantScope(resourceProviderNamespace: string, options?: ProvidersGetAtTenantScopeOptionalParams): Promise<ProvidersGetAtTenantScopeResponse>;
list(options?: ProvidersListOptionalParams): PagedAsyncIterableIterator<Provider>;
listAtTenantScope(options?: ProvidersListAtTenantScopeOptionalParams): PagedAsyncIterableIterator<Provider>;
providerPermissions(resourceProviderNamespace: string, options?: ProvidersProviderPermissionsOptionalParams): Promise<ProvidersProviderPermissionsResponse>;
register(resourceProviderNamespace: string, options?: ProvidersRegisterOptionalParams): Promise<ProvidersRegisterResponse>;
registerAtManagementGroupScope(resourceProviderNamespace: string, groupId: string, options?: ProvidersRegisterAtManagementGroupScopeOptionalParams): Promise<void>;
unregister(resourceProviderNamespace: string, options?: ProvidersUnregisterOptionalParams): Promise<ProvidersUnregisterResponse>;
}
// @public
export interface ProvidersGetAtTenantScopeOptionalParams extends coreClient.OperationOptions {
expand?: string;
}
// @public
export type ProvidersGetAtTenantScopeResponse = Provider;
// @public
export interface ProvidersGetOptionalParams extends coreClient.OperationOptions {
expand?: string;
}
// @public
export type ProvidersGetResponse = Provider;
// @public
export interface ProvidersListAtTenantScopeNextOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ProvidersListAtTenantScopeNextResponse = ProviderListResult;
// @public
export interface ProvidersListAtTenantScopeOptionalParams extends coreClient.OperationOptions {
expand?: string;
}
// @public
export type ProvidersListAtTenantScopeResponse = ProviderListResult;
// @public
export interface ProvidersListNextOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ProvidersListNextResponse = ProviderListResult;
// @public
export interface ProvidersListOptionalParams extends coreClient.OperationOptions {
expand?: string;
}
// @public
export type ProvidersListResponse = ProviderListResult;
// @public
export interface ProvidersProviderPermissionsOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ProvidersProviderPermissionsResponse = ProviderPermissionListResult;
// @public
export interface ProvidersRegisterAtManagementGroupScopeOptionalParams extends coreClient.OperationOptions {
}
// @public
export interface ProvidersRegisterOptionalParams extends coreClient.OperationOptions {
properties?: ProviderRegistrationRequest;
}
// @public
export type ProvidersRegisterResponse = Provider;
// @public
export interface ProvidersUnregisterOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ProvidersUnregisterResponse = Provider;
// @public
export interface Resource {
extendedLocation?: ExtendedLocation;
readonly id?: string;
location?: string;
readonly name?: string;
tags?: {
[propertyName: string]: string;
};
readonly type?: string;
}
// @public
export interface ResourceGroup {
readonly id?: string;
location: string;
managedBy?: string;
readonly name?: string;
properties?: ResourceGroupProperties;
tags?: {
[propertyName: string]: string;
};
readonly type?: string;
}
// @public
export interface ResourceGroupExportResult {
error?: ErrorResponse;
output?: string;
template?: Record<string, unknown>;
}
// @public
export interface ResourceGroupFilter {
tagName?: string;
tagValue?: string;
}
// @public
export interface ResourceGroupListResult {
readonly nextLink?: string;
value?: ResourceGroup[];
}
// @public
export interface ResourceGroupPatchable {
managedBy?: string;
name?: string;
properties?: ResourceGroupProperties;
tags?: {
[propertyName: string]: string;
};
}
// @public
export interface ResourceGroupProperties {
readonly provisioningState?: string;
}
// @public
export interface ResourceGroups {
beginDelete(resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
beginDeleteAndWait(resourceGroupName: string, options?: ResourceGroupsDeleteOptionalParams): Promise<void>;
beginExportTemplate(resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams): Promise<SimplePollerLike<OperationState<ResourceGroupsExportTemplateResponse>, ResourceGroupsExportTemplateResponse>>;
beginExportTemplateAndWait(resourceGroupName: string, parameters: ExportTemplateRequest, options?: ResourceGroupsExportTemplateOptionalParams): Promise<ResourceGroupsExportTemplateResponse>;
checkExistence(resourceGroupName: string, options?: ResourceGroupsCheckExistenceOptionalParams): Promise<ResourceGroupsCheckExistenceResponse>;
createOrUpdate(resourceGroupName: string, parameters: ResourceGroup, options?: ResourceGroupsCreateOrUpdateOptionalParams): Promise<ResourceGroupsCreateOrUpdateResponse>;
get(resourceGroupName: string, options?: ResourceGroupsGetOptionalParams): Promise<ResourceGroupsGetResponse>;
list(options?: ResourceGroupsListOptionalParams): PagedAsyncIterableIterator<ResourceGroup>;
update(resourceGroupName: string, parameters: ResourceGroupPatchable, options?: ResourceGroupsUpdateOptionalParams): Promise<ResourceGroupsUpdateResponse>;
}
// @public
export interface ResourceGroupsCheckExistenceOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourceGroupsCheckExistenceResponse = {
body: boolean;
};
// @public
export interface ResourceGroupsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourceGroupsCreateOrUpdateResponse = ResourceGroup;
// @public
export interface ResourceGroupsDeleteHeaders {
location?: string;
}
// @public
export interface ResourceGroupsDeleteOptionalParams extends coreClient.OperationOptions {
forceDeletionTypes?: string;
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export interface ResourceGroupsExportTemplateOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export type ResourceGroupsExportTemplateResponse = ResourceGroupExportResult;
// @public
export interface ResourceGroupsGetOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourceGroupsGetResponse = ResourceGroup;
// @public
export interface ResourceGroupsListNextOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourceGroupsListNextResponse = ResourceGroupListResult;
// @public
export interface ResourceGroupsListOptionalParams extends coreClient.OperationOptions {
filter?: string;
top?: number;
}
// @public
export type ResourceGroupsListResponse = ResourceGroupListResult;
// @public
export interface ResourceGroupsUpdateOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourceGroupsUpdateResponse = ResourceGroup;
// @public
export type ResourceIdentityType = "SystemAssigned" | "UserAssigned" | "SystemAssigned, UserAssigned" | "None";
// @public
export interface ResourceListResult {
readonly nextLink?: string;
value?: GenericResourceExpanded[];
}
// @public (undocumented)
export class ResourceManagementClient extends coreClient.ServiceClient {
// (undocumented)
$host: string;
constructor(credentials: coreAuth.TokenCredential, subscriptionId: string, options?: ResourceManagementClientOptionalParams);
constructor(credentials: coreAuth.TokenCredential, options?: ResourceManagementClientOptionalParams);
// (undocumented)
apiVersion: string;
// (undocumented)
operations: Operations;
// (undocumented)
providerResourceTypes: ProviderResourceTypes;
// (undocumented)
providers: Providers;
// (undocumented)
resourceGroups: ResourceGroups;
// (undocumented)
resources: Resources;
// (undocumented)
subscriptionId?: string;
// (undocumented)
tagsOperations: TagsOperations;
}
// @public
export interface ResourceManagementClientOptionalParams extends coreClient.ServiceClientOptions {
$host?: string;
apiVersion?: string;
endpoint?: string;
}
// @public
export interface ResourceProviderOperationDisplayProperties {
description?: string;
operation?: string;
provider?: string;
publisher?: string;
resource?: string;
}
// @public
export interface Resources {
beginCreateOrUpdate(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ResourcesCreateOrUpdateResponse>, ResourcesCreateOrUpdateResponse>>;
beginCreateOrUpdateAndWait(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateOptionalParams): Promise<ResourcesCreateOrUpdateResponse>;
beginCreateOrUpdateById(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams): Promise<SimplePollerLike<OperationState<ResourcesCreateOrUpdateByIdResponse>, ResourcesCreateOrUpdateByIdResponse>>;
beginCreateOrUpdateByIdAndWait(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesCreateOrUpdateByIdOptionalParams): Promise<ResourcesCreateOrUpdateByIdResponse>;
beginDelete(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
beginDeleteAndWait(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesDeleteOptionalParams): Promise<void>;
beginDeleteById(resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
beginDeleteByIdAndWait(resourceId: string, apiVersion: string, options?: ResourcesDeleteByIdOptionalParams): Promise<void>;
beginMoveResources(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
beginMoveResourcesAndWait(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesMoveResourcesOptionalParams): Promise<void>;
beginUpdate(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ResourcesUpdateResponse>, ResourcesUpdateResponse>>;
beginUpdateAndWait(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateOptionalParams): Promise<ResourcesUpdateResponse>;
beginUpdateById(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams): Promise<SimplePollerLike<OperationState<ResourcesUpdateByIdResponse>, ResourcesUpdateByIdResponse>>;
beginUpdateByIdAndWait(resourceId: string, apiVersion: string, parameters: GenericResource, options?: ResourcesUpdateByIdOptionalParams): Promise<ResourcesUpdateByIdResponse>;
beginValidateMoveResources(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
beginValidateMoveResourcesAndWait(sourceResourceGroupName: string, parameters: ResourcesMoveInfo, options?: ResourcesValidateMoveResourcesOptionalParams): Promise<void>;
checkExistence(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesCheckExistenceOptionalParams): Promise<ResourcesCheckExistenceResponse>;
checkExistenceById(resourceId: string, apiVersion: string, options?: ResourcesCheckExistenceByIdOptionalParams): Promise<ResourcesCheckExistenceByIdResponse>;
get(resourceGroupName: string, resourceProviderNamespace: string, parentResourcePath: string, resourceType: string, resourceName: string, apiVersion: string, options?: ResourcesGetOptionalParams): Promise<ResourcesGetResponse>;
getById(resourceId: string, apiVersion: string, options?: ResourcesGetByIdOptionalParams): Promise<ResourcesGetByIdResponse>;
list(options?: ResourcesListOptionalParams): PagedAsyncIterableIterator<GenericResourceExpanded>;
listByResourceGroup(resourceGroupName: string, options?: ResourcesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<GenericResourceExpanded>;
}
// @public
export interface ResourcesCheckExistenceByIdOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourcesCheckExistenceByIdResponse = {
body: boolean;
};
// @public
export interface ResourcesCheckExistenceOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourcesCheckExistenceResponse = {
body: boolean;
};
// @public
export interface ResourcesCreateOrUpdateByIdOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export type ResourcesCreateOrUpdateByIdResponse = GenericResource;
// @public
export interface ResourcesCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export type ResourcesCreateOrUpdateResponse = GenericResource;
// @public
export interface ResourcesDeleteByIdOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export interface ResourcesDeleteOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export interface ResourcesGetByIdOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourcesGetByIdResponse = GenericResource;
// @public
export interface ResourcesGetOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourcesGetResponse = GenericResource;
// @public
export interface ResourcesListByResourceGroupNextOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourcesListByResourceGroupNextResponse = ResourceListResult;
// @public
export interface ResourcesListByResourceGroupOptionalParams extends coreClient.OperationOptions {
expand?: string;
filter?: string;
top?: number;
}
// @public
export type ResourcesListByResourceGroupResponse = ResourceListResult;
// @public
export interface ResourcesListNextOptionalParams extends coreClient.OperationOptions {
}
// @public
export type ResourcesListNextResponse = ResourceListResult;
// @public
export interface ResourcesListOptionalParams extends coreClient.OperationOptions {
expand?: string;
filter?: string;
top?: number;
}
// @public
export type ResourcesListResponse = ResourceListResult;
// @public
export interface ResourcesMoveInfo {
resources?: string[];
targetResourceGroup?: string;
}
// @public
export interface ResourcesMoveResourcesOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export interface ResourcesUpdateByIdOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export type ResourcesUpdateByIdResponse = GenericResource;
// @public
export interface ResourcesUpdateOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export type ResourcesUpdateResponse = GenericResource;
// @public
export interface ResourcesValidateMoveResourcesOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export interface RoleDefinition {
id?: string;
isServiceRole?: boolean;
name?: string;
permissions?: Permission[];
scopes?: string[];
}
// @public
export interface Sku {
capacity?: number;
family?: string;
model?: string;
name?: string;
size?: string;
tier?: string;
}
// @public
export interface SubResource {
id?: string;
}
// @public
export interface TagCount {
type?: string;
value?: number;
}
// @public
export interface TagDetails {
count?: TagCount;
readonly id?: string;
tagName?: string;
values?: TagValue[];
}
// @public
export interface Tags {
tags?: {
[propertyName: string]: string;
};
}
// @public
export interface TagsCreateOrUpdateAtScopeHeaders {
location?: string;
}
// @public
export interface TagsCreateOrUpdateAtScopeOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export type TagsCreateOrUpdateAtScopeResponse = TagsResource;
// @public
export interface TagsCreateOrUpdateOptionalParams extends coreClient.OperationOptions {
}
// @public
export type TagsCreateOrUpdateResponse = TagDetails;
// @public
export interface TagsCreateOrUpdateValueOptionalParams extends coreClient.OperationOptions {
}
// @public
export type TagsCreateOrUpdateValueResponse = TagValue;
// @public
export interface TagsDeleteAtScopeHeaders {
location?: string;
}
// @public
export interface TagsDeleteAtScopeOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export interface TagsDeleteOptionalParams extends coreClient.OperationOptions {
}
// @public
export interface TagsDeleteValueOptionalParams extends coreClient.OperationOptions {
}
// @public
export interface TagsGetAtScopeOptionalParams extends coreClient.OperationOptions {
}
// @public
export type TagsGetAtScopeResponse = TagsResource;
// @public
export interface TagsListNextOptionalParams extends coreClient.OperationOptions {
}
// @public
export type TagsListNextResponse = TagsListResult;
// @public
export interface TagsListOptionalParams extends coreClient.OperationOptions {
}
// @public
export type TagsListResponse = TagsListResult;
// @public
export interface TagsListResult {
readonly nextLink?: string;
value?: TagDetails[];
}
// @public
export interface TagsOperations {
beginCreateOrUpdateAtScope(scope: string, parameters: TagsResource, options?: TagsCreateOrUpdateAtScopeOptionalParams): Promise<SimplePollerLike<OperationState<TagsCreateOrUpdateAtScopeResponse>, TagsCreateOrUpdateAtScopeResponse>>;
beginCreateOrUpdateAtScopeAndWait(scope: string, parameters: TagsResource, options?: TagsCreateOrUpdateAtScopeOptionalParams): Promise<TagsCreateOrUpdateAtScopeResponse>;
beginDeleteAtScope(scope: string, options?: TagsDeleteAtScopeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>;
beginDeleteAtScopeAndWait(scope: string, options?: TagsDeleteAtScopeOptionalParams): Promise<void>;
beginUpdateAtScope(scope: string, parameters: TagsPatchResource, options?: TagsUpdateAtScopeOptionalParams): Promise<SimplePollerLike<OperationState<TagsUpdateAtScopeResponse>, TagsUpdateAtScopeResponse>>;
beginUpdateAtScopeAndWait(scope: string, parameters: TagsPatchResource, options?: TagsUpdateAtScopeOptionalParams): Promise<TagsUpdateAtScopeResponse>;
createOrUpdate(tagName: string, options?: TagsCreateOrUpdateOptionalParams): Promise<TagsCreateOrUpdateResponse>;
createOrUpdateValue(tagName: string, tagValue: string, options?: TagsCreateOrUpdateValueOptionalParams): Promise<TagsCreateOrUpdateValueResponse>;
delete(tagName: string, options?: TagsDeleteOptionalParams): Promise<void>;
deleteValue(tagName: string, tagValue: string, options?: TagsDeleteValueOptionalParams): Promise<void>;
getAtScope(scope: string, options?: TagsGetAtScopeOptionalParams): Promise<TagsGetAtScopeResponse>;
list(options?: TagsListOptionalParams): PagedAsyncIterableIterator<TagDetails>;
}
// @public
export type TagsPatchOperation = string;
// @public
export interface TagsPatchResource {
operation?: TagsPatchOperation;
properties?: Tags;
}
// @public
export interface TagsResource {
readonly id?: string;
readonly name?: string;
properties: Tags;
readonly type?: string;
}
// @public
export interface TagsUpdateAtScopeHeaders {
location?: string;
}
// @public
export interface TagsUpdateAtScopeOptionalParams extends coreClient.OperationOptions {
resumeFrom?: string;
updateIntervalInMs?: number;
}
// @public
export type TagsUpdateAtScopeResponse = TagsResource;
// @public
export interface TagValue {
count?: TagCount;
readonly id?: string;
tagValue?: string;
}
// @public (undocumented)
export interface ZoneMapping {
location?: string;
// (undocumented)
zones?: string[];
}
// (No @packageDocumentation comment for this package)
```