swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Providers API schemes: - https tags: - name: Providers paths: /providers/Microsoft.ADHybridHealthService/addsservices/{serviceName}: get: tags: - Providers description: Gets the details of an Active Directory Domain Service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. x-ms-examples: addsServices_get: $ref: ./examples/Service.json operationId: microsoftAzureAddsservicesGet parameters: - name: serviceName in: path description: The name of the service. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: 'The Active Directory Domain Controller service as specified by the serviceName property. ' schema: $ref: '#/definitions/ServiceProperties' summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Servicename delete: tags: - Providers description: Deletes an Active Directory Domain Service which is onboarded to Azure Active Directory Connect Health. x-ms-examples: addsServices_delete: $ref: ./examples/DeleteService.json operationId: microsoftAzureAddsservicesDelete parameters: - name: serviceName in: path description: The name of the service which needs to be deleted. required: true type: string - name: confirm in: query description: Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered. required: false type: boolean - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Successfully deleted the service. summary: Microsoft Azure Delete Providers Microsoft Adhybridhealthservice Addsservices Servicename patch: tags: - Providers description: Updates an Active Directory Domain Service properties of an onboarded service. x-ms-examples: addsServices_update: $ref: ./examples/UpdateService.json operationId: microsoftAzureAddsservicesUpdate parameters: - name: serviceName in: path description: The name of the service which needs to be deleted. required: true type: string - name: service in: body description: The service object. required: true schema: $ref: '#/definitions/ServiceProperties' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully updated service. schema: $ref: '#/definitions/ServiceProperties' summary: Microsoft Azure Patch Providers Microsoft Adhybridhealthservice Addsservices Servicename /providers/Microsoft.ADHybridHealthService/addsservices/premiumCheck: get: tags: - Providers description: Gets the details of Active Directory Domain Services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. x-ms-examples: addsServices_listPremiumServices: $ref: ./examples/Services.json operationId: microsoftAzureAddsservicesListpremiumservices parameters: - name: $filter in: query description: The service property filter to apply. required: false type: string - name: serviceType in: query description: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. required: false type: string - name: skipCount in: query description: The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements. required: false type: integer - name: takeCount in: query description: The take count , which specifies the number of elements that can be returned from a sequence. required: false type: integer - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The list of premium services. schema: $ref: '#/definitions/Services' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Addsservices Premiumcheck /providers/Microsoft.ADHybridHealthService/services: get: tags: - Providers description: Gets the details of services, for a tenant, that are onboarded to Azure Active Directory Connect Health. x-ms-examples: services_list: $ref: ./examples/Services.json operationId: microsoftAzureServicesList parameters: - name: $filter in: query description: The service property filter to apply. required: false type: string - name: serviceType in: query description: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. required: false type: string - name: skipCount in: query description: The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements. required: false type: integer - name: takeCount in: query description: The take count , which specifies the number of elements that can be returned from a sequence. required: false type: integer - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The list of services. schema: $ref: '#/definitions/Services' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services post: tags: - Providers description: Onboards a service for a given tenant in Azure Active Directory Connect Health. x-ms-examples: services_add: $ref: ./examples/AddService.json operationId: microsoftAzureServicesAdd parameters: - $ref: '#/parameters/apiVersionParameter' - name: service in: body description: The service object. required: true schema: $ref: '#/definitions/ServiceProperties' responses: '200': description: Successfully added the service. schema: $ref: '#/definitions/ServiceProperties' summary: Microsoft Azure Post Providers Microsoft Adhybridhealthservice Services /providers/Microsoft.ADHybridHealthService/services/premiumCheck: get: tags: - Providers description: Gets the details of services for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. x-ms-examples: services_listPremium: $ref: ./examples/Services.json operationId: microsoftAzureServicesListpremium parameters: - name: $filter in: query description: The service property filter to apply. required: false type: string - name: serviceType in: query description: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. required: false type: string - name: skipCount in: query description: The skip count, which specifies the number of elements that can be bypassed from a sequence and then return the remaining elements. required: false type: integer - name: takeCount in: query description: The take count , which specifies the number of elements that can be returned from a sequence. required: false type: integer - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The list of premium services. schema: $ref: '#/definitions/Services' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Premiumcheck /providers/Microsoft.ADHybridHealthService/services/{serviceName}: get: tags: - Providers description: Gets the details of a service for a tenant having Azure AD Premium license and is onboarded to Azure Active Directory Connect Health. x-ms-examples: services_get: $ref: ./examples/Service.json operationId: microsoftAzureServicesGet parameters: - name: serviceName in: path description: The name of the service. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The list of services. schema: $ref: '#/definitions/ServiceProperties' summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename delete: tags: - Providers description: Deletes a service which is onboarded to Azure Active Directory Connect Health. x-ms-examples: services_delete: $ref: ./examples/DeleteService.json operationId: microsoftAzureServicesDelete parameters: - name: serviceName in: path description: The name of the service which needs to be deleted. required: true type: string - name: confirm in: query description: Indicates if the service will be permanently deleted or disabled. True indicates that the service will be permanently deleted and False indicates that the service will be marked disabled and then deleted after 30 days, if it is not re-registered. required: false type: boolean - $ref: '#/parameters/apiVersionParameter' responses: '204': description: Successfully deleted the service. summary: Microsoft Azure Delete Providers Microsoft Adhybridhealthservice Services Servicename patch: tags: - Providers description: Updates the service properties of an onboarded service. x-ms-examples: services_update: $ref: ./examples/UpdateService.json operationId: microsoftAzureServicesUpdate parameters: - name: serviceName in: path description: The name of the service which needs to be deleted. required: true type: string - name: service in: body description: The service object. required: true schema: $ref: '#/definitions/ServiceProperties' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully updated the service. schema: $ref: '#/definitions/ServiceProperties' summary: Microsoft Azure Patch Providers Microsoft Adhybridhealthservice Services Servicename /providers/Microsoft.ADHybridHealthService/services/{serviceName}/checkServiceFeatureAvailibility/{featureName}: get: tags: - Providers description: Checks if the service has all the pre-requisites met to use a feature. x-ms-examples: services_getFeatureAvailibility: $ref: ./examples/CheckFeatureAvailibility.json operationId: microsoftAzureServicesGetfeatureavailibility parameters: - name: serviceName in: path description: The name of the service. required: true type: string - name: featureName in: path description: The name of the feature. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Indicates if the feature is available or not. schema: $ref: '#/definitions/Result' summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Checkservicefeatureavailibility Featurename /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/counts: get: tags: - Providers description: Gets the count of latest AAD export errors. x-ms-examples: services_listExportErrors: $ref: ./examples/ErrorCounts.json operationId: microsoftAzureServicesListexporterrors parameters: - name: serviceName in: path description: The name of the service. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The list of export errors. schema: $ref: '#/definitions/ErrorCounts' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Exporterrors Counts /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exporterrors/listV2: get: tags: - Providers description: ' Gets the categorized export errors.' x-ms-examples: services_listExportErrorsV2: $ref: ./examples/MergedExportErrors.json operationId: microsoftAzureServicesListexporterrorsv2 parameters: - name: serviceName in: path description: The name of the service. required: true type: string - name: errorBucket in: query description: The error category to query for. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The list of merged export errors. schema: $ref: '#/definitions/MergedExportErrors' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Exporterrors Listv2 /providers/Microsoft.ADHybridHealthService/services/{serviceName}/exportstatus: get: tags: - Providers description: Gets the export status. x-ms-examples: services_listExportStatus: $ref: ./examples/ExportStatus.json operationId: microsoftAzureServicesListexportstatus parameters: - name: serviceName in: path description: The name of the service. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The list of export statuses. schema: $ref: '#/definitions/ExportStatuses' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Exportstatus /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfiguration: patch: tags: - Providers description: Updates the service level monitoring configuration. x-ms-examples: services_updateMonitoringConfiguration: $ref: ./examples/PatchMonitoringConfiguration.json operationId: microsoftAzureServicesUpdatemonitoringconfiguration parameters: - name: serviceName in: path description: The name of the service. required: true type: string - name: configurationSetting in: body description: The monitoring configuration to update required: true schema: $ref: '#/definitions/Item' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Successfully updated the monitoring configuration. summary: Microsoft Azure Patch Providers Microsoft Adhybridhealthservice Services Servicename Monitoringconfiguration /providers/Microsoft.ADHybridHealthService/services/{serviceName}/monitoringconfigurations: get: tags: - Providers description: Gets the service level monitoring configurations. x-ms-examples: services_listMonitoringConfigurations: $ref: ./examples/MonitoringConfigurations.json operationId: microsoftAzureServicesListmonitoringconfigurations parameters: - name: serviceName in: path description: The name of the service. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: The list of monitoring configurations. schema: $ref: '#/definitions/Items' x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Monitoringconfigurations /providers/Microsoft.ADHybridHealthService/services/{serviceName}/TenantWhitelisting/{featureName}: get: tags: - Providers description: Checks if the tenant, to which a service is registered, is listed as allowed to use a feature. x-ms-examples: services_getTenantWhitelisting: $ref: ./examples/TenantWhitelisting.json operationId: microsoftAzureServicesGettenantwhitelisting parameters: - name: serviceName in: path description: The name of the service. required: true type: string - name: featureName in: path description: The name of the feature. required: true type: string - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Indicates if a tenant is listed as allowed for a feature or not. schema: $ref: '#/definitions/Result' summary: Microsoft Azure Get Providers Microsoft Adhybridhealthservice Services Servicename Tenantwhitelisting Featurename /providers/Microsoft.Web/publishingUsers/web: get: summary: Microsoft Azure Gets Publishing User description: Description for Gets publishing user operationId: microsoftAzureGetpublishinguser parameters: - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/User default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Providers put: summary: Microsoft Azure Updates Publishing User description: Description for Updates publishing user operationId: microsoftAzureUpdatepublishinguser parameters: - name: userDetails in: body description: Details of publishing user required: true schema: $ref: ./CommonDefinitions.json#/definitions/User - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: $ref: ./CommonDefinitions.json#/definitions/User default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Providers /providers/Microsoft.Web/sourcecontrols: get: summary: Microsoft Azure Gets The Source Controls Available For Azure Websites description: Description for Gets the source controls available for Azure websites. operationId: microsoftAzureListsourcecontrols parameters: - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/SourceControlCollection' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse x-ms-pageable: nextLinkName: nextLink tags: - Providers /providers/Microsoft.Web/sourcecontrols/{sourceControlType}: get: summary: Microsoft Azure Gets Source Control Token description: Description for Gets source control token operationId: microsoftAzureGetsourcecontrol parameters: - name: sourceControlType in: path description: Type of source control required: true type: string - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/SourceControl' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Providers put: summary: Microsoft Azure Updates Source Control Token description: Description for Updates source control token operationId: microsoftAzureUpdatesourcecontrol parameters: - name: sourceControlType in: path description: Type of source control required: true type: string - name: requestMessage in: body description: Source control token information required: true schema: $ref: '#/definitions/SourceControl' - $ref: '#/parameters/apiVersionParameter_2' responses: '200': description: OK schema: $ref: '#/definitions/SourceControl' default: description: App Service error response. schema: $ref: ./CommonDefinitions.json#/definitions/DefaultErrorResponse tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/attestations: get: operationId: microsoftAzureAttestationsListforresource description: Gets all attestations for a resource. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The retrieved attestations. schema: $ref: '#/definitions/AttestationListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List attestations at individual resource scope: $ref: ./examples/Attestations_ListResourceScope.json List attestations at individual resource scope with query parameters: $ref: ./examples/Attestations_ListResourceScope_WithQuery.json summary: Microsoft Azure Get Resourceid Providers Microsoft Policyinsights Attestations tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/attestations/{attestationName}: put: operationId: microsoftAzureAttestationsCreateorupdateatresource description: Creates or updates an attestation at resource scope. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/attestationNameParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter - name: parameters in: body required: true schema: $ref: '#/definitions/Attestation' description: The attestation parameters. responses: '200': description: The updated attestation. schema: $ref: '#/definitions/Attestation' '201': description: The created attestation. schema: $ref: '#/definitions/Attestation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-examples: Create attestation at individual resource scope: $ref: ./examples/Attestations_CreateResourceScope.json summary: Microsoft Azure Put Resourceid Providers Microsoft Policyinsights Attestations Attestationname tags: - Providers get: operationId: microsoftAzureAttestationsGetatresource description: Gets an existing attestation at resource scope. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/attestationNameParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The retrieved attestation. schema: $ref: '#/definitions/Attestation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get attestation at individual resource scope: $ref: ./examples/Attestations_GetResourceScope.json summary: Microsoft Azure Get Resourceid Providers Microsoft Policyinsights Attestations Attestationname tags: - Providers delete: operationId: microsoftAzureAttestationsDeleteatresource description: Deletes an existing attestation at individual resource scope. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/attestationNameParameter' - $ref: ../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter responses: '200': description: The attestation was successfully deleted. '204': description: The attestation did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Delete attestation at individual resource scope: $ref: ./examples/Attestations_DeleteResourceScope.json summary: Microsoft Azure Delete Resourceid Providers Microsoft Policyinsights Attestations Attestationname tags: - Providers /providers/Microsoft.Authorization/operations: get: operationId: microsoftAzureOperationsList x-ms-examples: {} description: Lists the operations available from this provider. parameters: - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Describe the result of a successful operation. schema: $ref: '#/definitions/OperationListResult' default: description: Unexpected error schema: $ref: '#/definitions/ErrorDefinition_2' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Authorization Operations tags: - Providers /providers/Microsoft.AlertsManagement/operations: get: operationId: microsoftAzureOperationsList description: List all operations available through Azure Alerts Management Resource Provider. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter produces: - application/json responses: '200': description: OK. Successfully retrieved operations list. schema: $ref: '#/definitions/operationsList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/errorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: ListOperations: $ref: ./examples/Operations_List.json summary: Microsoft Azure Get Providers Microsoft Alertsmanagement Operations tags: - Providers /providers/Microsoft.AlertsManagement/alertsMetaData: get: operationId: microsoftAzureAlertsMetadata description: List alerts meta data information based on value of identifier parameter. parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/identifier' produces: - application/json responses: '200': description: OK. Successfully listed alert meta data. schema: $ref: '#/definitions/alertsMetaData' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/errorResponse' x-ms-examples: MonService: $ref: ./examples/AlertsMetaData_MonitorService.json summary: Microsoft Azure Get Providers Microsoft Alertsmanagement Alertsmetadata tags: - Providers /{scope}/providers/Microsoft.AlertsManagement/alerts: get: operationId: microsoftAzureAlertsGetall description: 'List all existing alerts, where the results can be filtered on the basis of multiple parameters (e.g. time range). The results can then be sorted on the basis specific fields, with the default being lastModifiedDateTime. ' parameters: - $ref: '#/parameters/scope' - $ref: '#/parameters/targetResource' - $ref: '#/parameters/targetResourceType' - $ref: '#/parameters/targetResourceGroup' - $ref: '#/parameters/monitorService' - $ref: '#/parameters/monitorCondition' - $ref: '#/parameters/severity' - $ref: '#/parameters/alertState' - $ref: '#/parameters/alertRule' - $ref: '#/parameters/smartGroupIdFilter' - $ref: '#/parameters/includeContext' - $ref: '#/parameters/includeEgressConfig' - $ref: '#/parameters/pageCount' - $ref: '#/parameters/alertsSortBy' - $ref: '#/parameters/sortOrder' - $ref: '#/parameters/select' - $ref: '#/parameters/timeRange' - $ref: '#/parameters/customTimeRange' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter produces: - application/json responses: '200': description: OK. Successfully listed alert objects. schema: $ref: '#/definitions/alertsList' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/errorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: ListAlerts: $ref: ./examples/Alerts_List.json summary: Microsoft Azure Get Scope Providers Microsoft Alertsmanagement Alerts tags: - Providers /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}: get: operationId: microsoftAzureAlertsGetbyid summary: Microsoft Azure Get A Specific Alert description: Get information related to a specific alert produces: - application/json parameters: - $ref: '#/parameters/scope' - $ref: '#/parameters/alertId' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. Returns the alert with the specified ID. schema: $ref: '#/definitions/alert' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/errorResponse' x-ms-examples: GetById: $ref: ./examples/Alerts_GetById.json tags: - Providers /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate: post: operationId: microsoftAzureAlertsChangestate description: Change the state of an alert. parameters: - $ref: '#/parameters/scope' - $ref: '#/parameters/alertId' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/newState' - $ref: '#/parameters/comment' responses: '200': description: OK. Alert state updated. schema: $ref: '#/definitions/alert' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/errorResponse' x-ms-examples: Resolve: $ref: ./examples/Alerts_ChangeState.json summary: Microsoft Azure Post Scope Providers Microsoft Alertsmanagement Alerts Alertid Changestate tags: - Providers /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history: get: operationId: microsoftAzureAlertsGethistory description: Get the history of an alert, which captures any monitor condition changes (Fired/Resolved) and alert state changes (New/Acknowledged/Closed). parameters: - $ref: '#/parameters/scope' - $ref: '#/parameters/alertId' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. Returns the history of the specified alert. schema: $ref: '#/definitions/alertModification' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/errorResponse' x-ms-examples: Resolve: $ref: ./examples/Alerts_History.json summary: Microsoft Azure Get Scope Providers Microsoft Alertsmanagement Alerts Alertid History tags: - Providers /{scope}/providers/Microsoft.AlertsManagement/alertsSummary: get: operationId: microsoftAzureAlertsGetsummary description: Get a summarized count of your alerts grouped by various parameters (e.g. grouping by 'Severity' returns the count of alerts for each severity). parameters: - $ref: '#/parameters/scope' - $ref: '#/parameters/alertsSummaryGroupBy' - $ref: '#/parameters/includeSmartGroupsCount' - $ref: '#/parameters/targetResource' - $ref: '#/parameters/targetResourceType' - $ref: '#/parameters/targetResourceGroup' - $ref: '#/parameters/monitorService' - $ref: '#/parameters/monitorCondition' - $ref: '#/parameters/severity' - $ref: '#/parameters/alertState' - $ref: '#/parameters/alertRule' - $ref: '#/parameters/timeRange' - $ref: '#/parameters/customTimeRange' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. Alert summary returned. schema: $ref: '#/definitions/alertsSummary' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/errorResponse' x-ms-examples: Summary: $ref: ./examples/Alerts_Summary.json summary: Microsoft Azure Get Scope Providers Microsoft Alertsmanagement Alertssummary tags: - Providers /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/enrichments: get: operationId: microsoftAzureAlertsListenrichments description: List the enrichments of an alert. It returns a collection of one object named default. parameters: - $ref: '#/parameters/scope' - $ref: '#/parameters/alertId' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. Returns the enrichments of the specified alert. schema: $ref: '#/definitions/alertEnrichmentsList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Resolve: $ref: ./examples/Alerts_ListEnrichments.json x-ms-pageable: nextLinkName: null summary: Microsoft Azure Get Scope Providers Microsoft Alertsmanagement Alerts Alertid Enrichments tags: - Providers /{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/enrichments/default: get: operationId: microsoftAzureAlertsGetenrichments description: Get the enrichments of an alert. parameters: - $ref: '#/parameters/scope' - $ref: '#/parameters/alertId' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK. Returns the enrichments of the specified alert. schema: $ref: '#/definitions/alertEnrichmentResponse' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Resolve: $ref: ./examples/Alerts_GetEnrichments.json summary: Microsoft Azure Get Scope Providers Microsoft Alertsmanagement Alerts Alertid Enrichments Default tags: - Providers /providers/Microsoft.Migrate/operations: get: summary: Microsoft Azure Get List Of Operations Supported In The Api description: Get a list of REST API supported by Microsoft.Migrate provider. operationId: microsoftAzureOperationsList responses: '200': description: OK. Returns list of operations. schema: $ref: '#/definitions/OperationResultList' x-ms-pageable: nextLinkName: null x-ms-examples: Operations_List: $ref: ./examples/Operations_List.json tags: - Providers /providers/Microsoft.Quantum/operations: get: description: Returns list of operations. operationId: microsoftAzureOperationsList x-ms-examples: Operations: $ref: ./examples/operations.json parameters: - $ref: '#/parameters/ApiVersionParameter_2' responses: '200': description: Operation details. schema: $ref: '#/definitions/operationsList_2' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse deprecated: false x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Quantum Operations tags: - Providers /subscriptions/{subscriptionId}/providers: get: operationId: Providers_List summary: Microsoft Azure List Resource Providers description: Gets all resource providers for a subscription. tags: - Providers parameters: - $ref: '#/components/parameters/SubscriptionIdParameter' - $ref: '#/components/parameters/ApiVersionParameter' - name: $expand in: query description: The properties to include in the results. For example, use resourceTypes/aliases to get the aliases for resource types. schema: type: string example: example_value responses: '200': description: Successfully returned the list of providers. content: application/json: schema: $ref: '#/components/schemas/ProviderListResult' examples: ProvidersList200Example: summary: Default Providers_List 200 response x-microcks-default: true value: value: - id: abc123 namespace: example_value registrationState: example_value registrationPolicy: example_value resourceTypes: {} nextLink: example_value default: description: Error response describing why the operation failed. content: application/json: schema: $ref: '#/components/schemas/CloudError' examples: ProvidersListdefaultExample: summary: Default Providers_List default response x-microcks-default: true value: error: code: example_value message: example_value target: example_value details: - {} additionalInfo: - {} x-microcks-operation: delay: 0 dispatcher: FALLBACK ? /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName} : put: description: Create a new tenant action group or update an existing one. operationId: microsoftAzureTenantactiongroupsCreateorupdate x-ms-examples: Create or update a tenant action group: $ref: ./examples/createOrUpdateTenantActionGroup.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/ActionGroupNameParameter' - $ref: '#/parameters/TenantIdParameter' - name: actionGroup in: body required: true schema: $ref: '#/definitions/TenantActionGroupResource' description: The tenant action group to create or use for the update. - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: An existing tenant action group was successfully updated. schema: $ref: '#/definitions/TenantActionGroupResource' '201': description: A new tenant action group was successfully created. schema: $ref: '#/definitions/TenantActionGroupResource' default: description: An error occurred and the tenant action group could not be created or updated. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Put Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Insights Tenantactiongroups Tenantactiongroupname tags: - Providers get: description: Get a tenant action group. operationId: microsoftAzureTenantactiongroupsGet x-ms-examples: Get an action group: $ref: ./examples/getTenantActionGroup.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/ActionGroupNameParameter' - $ref: '#/parameters/TenantIdParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/TenantActionGroupResource' default: description: 'An error occurred and the tenant action group could not be retrieved. 404: The tenant action group does not exist.' schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Insights Tenantactiongroups Tenantactiongroupname tags: - Providers delete: description: Delete a tenant action group. operationId: microsoftAzureTenantactiongroupsDelete x-ms-examples: Delete a tenant action group: $ref: ./examples/deleteTenantActionGroup.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/ActionGroupNameParameter' - $ref: '#/parameters/TenantIdParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The tenant action group was successfully deleted. '204': description: The tenant action group does not exist. It may have already been deleted. default: description: An error occurred and the tenant action group could not be deleted. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Delete Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Insights Tenantactiongroups Tenantactiongroupname tags: - Providers patch: description: Updates an existing tenant action group's tags. To update other fields use the CreateOrUpdate method. operationId: microsoftAzureTenantactiongroupsUpdate parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/ActionGroupNameParameter' - $ref: '#/parameters/TenantIdParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: tenantActionGroupPatch in: body required: true schema: $ref: '#/definitions/ActionGroupPatchBody' description: Parameters supplied to the operation. responses: '200': description: An existing tenant action group was successfully updated. schema: $ref: '#/definitions/TenantActionGroupResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_2' x-ms-examples: Patch a tenant action group: $ref: ./examples/patchTenantActionGroup.json summary: Microsoft Azure Patch Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Insights Tenantactiongroups Tenantactiongroupname tags: - Providers /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups: get: description: Get a list of all tenant action groups in a management group. operationId: microsoftAzureTenantactiongroupsListbymanagementgroupid x-ms-examples: List tenant action groups at management group level: $ref: ./examples/listTenantActionGroups.json x-ms-pageable: nextLinkName: null parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/TenantIdParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/TenantActionGroupList' default: description: An error occurred and the list of tenant action groups could not be retrieved. schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Insights Tenantactiongroups tags: - Providers ? /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}/createNotifications : post: x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: location description: Send test notifications to a set of provided receivers operationId: microsoftAzureCreatenotificationsattenantactiongroupresourcelevel x-ms-examples: Create notifications at tenant action group level: $ref: ./examples/postTestNotificationsAtTenantActionGroupResourceLevel.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/ActionGroupNameParameter' - $ref: '#/parameters/TenantIdParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - name: notificationRequest in: body required: true schema: $ref: '#/definitions/TenantNotificationRequestBody' description: The notification request body which includes the contact details responses: '200': description: The notification succeeded schema: $ref: '#/definitions/TestNotificationDetailsResponse' '202': description: The notification request accepted headers: location: type: string description: The location header that has the polling uri. default: description: An error occurred while sending the test notifications schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse summary: Microsoft Azure Post Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Insights Tenantactiongroups Tenantactiongroupname Createnotifications tags: - Providers ? /providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}/notificationStatus/{notificationId} : get: description: Get the test notifications by the notification id operationId: microsoftAzureGettestnotificationsattenantactiongroupresourcelevel x-ms-examples: Get notification details at tenant action group level: $ref: ./examples/getTestNotificationsAtTenantActionGroupResourceLevel.json parameters: - $ref: '#/parameters/ManagementGroupIdParameter' - $ref: '#/parameters/ActionGroupNameParameter' - $ref: '#/parameters/TenantIdParameter' - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/NotificationIdParameter' responses: '200': description: The notification details schema: $ref: '#/definitions/TestNotificationDetailsResponse' default: description: An error occurred while sending the test notifications schema: $ref: '#/definitions/ErrorResponse_2' summary: Microsoft Azure Get Providers Microsoft Management Managementgroups Managementgroupid Providers Microsoft Insights Tenantactiongroups Tenantactiongroupname Notificationstatus Notificationid tags: - Providers /providers/Microsoft.Media/operations: get: summary: Microsoft Azure List Operations description: Lists all the Media operations. operationId: microsoftAzureOperationsList responses: '200': description: OK schema: $ref: '#/definitions/OperationCollection' default: description: Detailed error information. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter x-ms-examples: List Operations: $ref: examples/operations-list-all.json tags: - Providers /providers/Microsoft.AzureDataTransfer/validateSchema: post: description: Validates a schema for Azure Data Transfer. x-ms-examples: Performs action request: $ref: examples/postValidateSchema.json operationId: microsoftAzureAzuredatatransferValidateschema parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: schema in: body required: true schema: $ref: '#/definitions/schema' description: The schema to validate responses: '200': description: Result of the schema validation. schema: $ref: '#/definitions/validateSchemaResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Post Providers Microsoft Azuredatatransfer Validateschema tags: - Providers /providers/Microsoft.AzureDataTransfer/listApprovedSchemas: post: description: Lists approved schemas for Azure Data Transfer. x-ms-examples: Performs action request: $ref: examples/postListApprovedSchemas.json operationId: microsoftAzureAzuredatatransferListapprovedschemas parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: pipeline in: body required: true schema: $ref: '#/definitions/listApprovedSchemasRequest' description: The request to list approved schemas. responses: '200': description: List of approved schemas. schema: $ref: '#/definitions/schemasListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Post Providers Microsoft Azuredatatransfer Listapprovedschemas tags: - Providers /providers/Microsoft.Carbon/carbonEmissionReports: post: operationId: microsoftAzureCarbonserviceListcarbonemissionreports description: API for Carbon Emissions Reports parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - name: queryParameters in: body description: Query parameters required: true schema: $ref: '#/definitions/QueryFilter' responses: '200': description: The request has succeeded. schema: $ref: '#/definitions/CarbonEmissionDataListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: CarbonService_ListCarbonEmissionReports: $ref: ./examples/carbonEmissionsReport.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Post Providers Microsoft Carbon Carbonemissionreports tags: - Providers /providers/Microsoft.Carbon/queryCarbonEmissionDataAvailableDateRange: post: operationId: microsoftAzureCarbonserviceQuerycarbonemissiondataavailabledaterange description: API for query carbon emission data available date range parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/CarbonEmissionDataAvailableDateRange' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: CarbonService_QueryCarbonEmissionDataAvailableDateRange: $ref: ./examples/carbonEmissionsDataAvailableDateRange.json summary: Microsoft Azure Post Providers Microsoft Carbon Querycarbonemissiondataavailabledaterange tags: - Providers /providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}: get: operationId: microsoftAzureGetusersettingswithlocation x-ms-examples: GetUserSettings: $ref: ./examples/GetUserSettings_Location.json summary: Microsoft Azure Get User Settings description: Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings. parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/UserSettingsNameParameter' - $ref: '#/parameters/LocationParameter' responses: '200': description: OK schema: $ref: '#/definitions/UserSettingsResponse' headers: x-ms-console-required-location-code: type: string description: normalized required location code x-ms-console-preview-user: type: boolean description: indicates whether user is a previous usr. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers patch: operationId: microsoftAzurePatchusersettingswithlocation summary: Microsoft Azure Patch User Settings description: Patch cloud shell settings for current signed in user x-ms-examples: PatchUserSettings: $ref: ./examples/PatchUserSettings_Location.json parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/UserSettingsNameParameter' - $ref: '#/parameters/LocationParameter' - name: parameters description: The properties of the user settings to be updated. required: true in: body schema: $ref: '#/definitions/CloudShellPatchUserSettings' responses: '200': description: OK schema: $ref: '#/definitions/UserSettingsResponse' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers delete: operationId: microsoftAzureDeleteusersettingswithlocation summary: Microsoft Azure Delete User Settings x-ms-examples: DeleteUserSettings: $ref: ./examples/DeleteUserSettings_Location.json description: Delete cloud shell settings for current signed in user parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/UserSettingsNameParameter' - $ref: '#/parameters/LocationParameter' responses: '200': description: OK '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers put: operationId: microsoftAzurePutusersettingswithlocation summary: Microsoft Azure Put User Settings x-ms-examples: PutUserSettings: $ref: ./examples/PutUserSettings_Location.json description: Create or update cloud shell settings for current signed in user parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/UserSettingsNameParameter' - $ref: '#/parameters/LocationParameter' - name: parameters description: The properties of the user settings to be created or updated. required: true in: body schema: $ref: '#/definitions/CloudShellUserSettings' responses: '200': description: OK schema: $ref: '#/definitions/UserSettingsResponse' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}: get: operationId: microsoftAzureGetconsolewithlocation summary: Microsoft Azure Get Console x-ms-examples: GetConsole: $ref: ./examples/GetConsole_Location.json description: Gets the console for the user. parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/ConsoleNameParameter' - $ref: '#/parameters/LocationParameter' responses: '200': description: OK schema: $ref: '#/definitions/CloudShellConsole' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers put: operationId: microsoftAzurePutconsolewithlocation summary: Microsoft Azure Put Console x-ms-examples: PutConsole: $ref: ./examples/PutConsole_Location.json description: Puts a request for a console parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/ConsoleNameParameter' - $ref: '#/parameters/LocationParameter' responses: '200': description: OK schema: $ref: '#/definitions/CloudShellConsole' '201': description: Created schema: $ref: '#/definitions/CloudShellConsole' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers delete: operationId: microsoftAzureDeleteconsolewithlocation summary: Microsoft Azure Delete Console x-ms-examples: DeleteConsole: $ref: ./examples/DeleteConsole_Location.json description: Deletes the console parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/ConsoleNameParameter' - $ref: '#/parameters/LocationParameter' responses: '200': description: OK '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers /providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}/keepAlive: post: operationId: microsoftAzureKeepalivewithlocation x-ms-examples: GetUserSettings: $ref: ./examples/KeepAlive_Location.json summary: Microsoft Azure Keep Alive description: Keep console alive parameters: - $ref: '#/parameters/ConsoleNameParameter' - $ref: '#/parameters/LocationParameter' responses: '200': description: OK headers: x-ms-console-remaining-seconds: type: integer format: int32 description: Remaining time left in session, in seconds. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers /providers/Microsoft.Portal/userSettings/{userSettingsName}: get: operationId: microsoftAzureGetusersettings x-ms-examples: GetUserSettings: $ref: ./examples/GetUserSettings.json summary: Microsoft Azure Get User Settings description: Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings. parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/UserSettingsNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/UserSettingsResponse' headers: x-ms-console-required-location-code: type: string description: normalized required location code x-ms-console-preview-user: type: boolean description: indicates whether user is a previous usr. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers patch: operationId: microsoftAzurePatchusersettings summary: Microsoft Azure Patch User Settings description: Patch cloud shell settings for current signed in user x-ms-examples: PatchUserSettings: $ref: ./examples/PatchUserSettings.json parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/UserSettingsNameParameter' - name: parameters description: The properties of the user settings to be updated. required: true in: body schema: $ref: '#/definitions/CloudShellPatchUserSettings' responses: '200': description: OK schema: $ref: '#/definitions/UserSettingsResponse' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers delete: operationId: microsoftAzureDeleteusersettings x-ms-examples: DeleteUserSettings: $ref: ./examples/DeleteUserSettings.json summary: Microsoft Azure Delete User Settings description: Delete cloud shell settings for current signed in user parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/UserSettingsNameParameter' responses: '200': description: OK '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers put: operationId: microsoftAzurePutusersettings x-ms-examples: PutUserSettings: $ref: ./examples/PutUserSettings.json summary: Microsoft Azure Put User Settings description: Create or update cloud shell settings for current signed in user parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/UserSettingsNameParameter' - name: parameters description: The properties of the user settings to be created or updated. required: true in: body schema: $ref: '#/definitions/CloudShellUserSettings' responses: '200': description: OK schema: $ref: '#/definitions/UserSettingsResponse' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers /providers/Microsoft.Portal/consoles/{consoleName}: get: operationId: microsoftAzureGetconsole x-ms-examples: GetConsole: $ref: ./examples/GetConsole.json summary: Microsoft Azure Get Console description: Gets the console for the user. parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/ConsoleNameParameter' responses: '200': description: OK schema: $ref: '#/definitions/CloudShellConsole' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers put: operationId: microsoftAzurePutconsole x-ms-examples: PutConsole: $ref: ./examples/PutConsole.json summary: Microsoft Azure Put Console description: Puts a request for a console parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/ConsoleNameParameter' - name: parameters description: The console definition. required: true in: body schema: $ref: '#/definitions/ConsoleDefinition' responses: '200': description: OK schema: $ref: '#/definitions/CloudShellConsole' '201': description: Created schema: $ref: '#/definitions/CloudShellConsole' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers delete: operationId: microsoftAzureDeleteconsole x-ms-examples: DeleteConsole: $ref: ./examples/DeleteConsole.json summary: Microsoft Azure Delete Console description: Deletes the console parameters: - $ref: '#/parameters/ApiVersionParameter_3' - $ref: '#/parameters/ConsoleNameParameter' responses: '200': description: OK '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers /providers/Microsoft.Portal/consoles/{consoleName}/keepAlive: post: operationId: microsoftAzureKeepalive x-ms-examples: KeepAlive: $ref: ./examples/KeepAlive.json summary: Microsoft Azure Keep Alive description: Keep console alive parameters: - $ref: '#/parameters/ConsoleNameParameter' responses: '200': description: OK headers: x-ms-console-remaining-seconds: type: integer format: int32 description: Remaining time left in session, in seconds. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_3' tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/componentPolicyStates/{componentPolicyStatesResource}/queryResults: post: operationId: microsoftAzureComponentpolicystatesListqueryresultsforresource description: Queries component policy states for the resource. parameters: - $ref: '#/parameters/resourceId' - $ref: '#/parameters/componentPolicyStatesResource' - $ref: '#/parameters/apiVersion' - $ref: '#/parameters/top' - $ref: '#/parameters/orderBy' - $ref: '#/parameters/select_2' - $ref: '#/parameters/from' - $ref: '#/parameters/to' - $ref: '#/parameters/filter' - $ref: '#/parameters/apply' - $ref: '#/parameters/componentPolicyStatesExpand' responses: '200': description: Query results. schema: $ref: '#/definitions/ComponentPolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: ../../stable/2019-10-01/policyMetadata.json#/definitions/ErrorResponse x-ms-examples: Query latest component policy states at resource scope: $ref: ./examples/ComponentPolicyStates_QueryResourceScope.json Query latest component policy states at resource scope and expand policyEvaluationDetails: $ref: ./examples/ComponentPolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json ? Query latest component policy compliance state count grouped by component type at resource scope filtered by given assignment. : $ref: ./examples/ComponentPolicyStates_QueryResourceScopeGroupByComponentTypeWithAggregate.json Query latest component policy states at nested resource scope: $ref: ./examples/ComponentPolicyStates_QueryNestedResourceScope.json Query latest component policy compliance state at resource scope filtered by given component id.: $ref: ./examples/ComponentPolicyStates_QueryResourceScopeFilterByComponentId.json summary: Microsoft Azure Post Resourceid Providers Microsoft Policyinsights Componentpolicystates Componentpolicystatesresource Queryresults tags: - Providers /providers/Microsoft.Kubernetes/operations: get: description: Lists all of the available API operations for Connected Cluster resource. operationId: microsoftAzureOperationsGet produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: '#/definitions/OperationList' default: description: Resource Provider error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: ListConnectedClusterOperationsExample: $ref: ./examples/ListConnectedClusterOperationsExample.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Kubernetes Operations tags: - Providers /{scope}/providers/Microsoft.Consumption/tags: get: tags: - Providers operationId: microsoftAzureTagsGet description: Get all available tag keys for the defined scope externalDocs: url: https://docs.microsoft.com/en-us/rest/api/consumption/ x-ms-examples: Tags_Get: $ref: ./examples/Tags.json parameters: - $ref: '#/parameters/scopeTagsParameter' - $ref: '#/parameters/apiVersionParameter_3' responses: '200': description: OK. The request has succeeded. schema: $ref: '#/definitions/TagsResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_4' summary: Microsoft Azure Get Scope Providers Microsoft Consumption Tags /providers/Microsoft.Security/sensitivitySettings: get: description: Gets a list with a single sensitivity settings resource operationId: microsoftAzureSensitivitysettingsList parameters: - $ref: ../../../common/v1/types.json#/parameters/ApiVersion responses: '200': description: Success of the sensitivity settings list get schema: $ref: '#/definitions/GetSensitivitySettingsListResponse' default: description: Error response describing why the operation failed schema: $ref: ../../../common/v1/types.json#/definitions/CloudError x-ms-examples: Get sensitivity settings list: $ref: ./examples/SensitivitySettings/GetSensitivitySettingsList_example.json summary: Microsoft Azure Get Providers Microsoft Security Sensitivitysettings tags: - Providers /providers/Microsoft.DeviceUpdate/operations: get: description: Returns list of operations for Microsoft.DeviceUpdate resource provider. operationId: microsoftAzureOperationsList parameters: - $ref: '#/parameters/ApiVersionParameter_4' responses: '200': description: Operation details. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse deprecated: false x-ms-pageable: nextLinkName: nextLink x-ms-examples: Gets list of Operations: $ref: ./examples/Operations_List.json summary: Microsoft Azure Get Providers Microsoft Deviceupdate Operations tags: - Providers /providers/Microsoft.GraphServices/operations: get: description: Returns list of operations. operationId: microsoftAzureOperationList parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Operation details. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult default: description: Error response describing the reason for operation failure. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-examples: Get list of operations: $ref: ./examples/Operations_List.json deprecated: false x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Graphservices Operations tags: - Providers /{resourceUri}/providers/microsoft.insights/guestDiagnosticSettingsAssociation/{associationName}: patch: description: Updates an existing guestDiagnosticsSettingsAssociation Resource. To update other fields use the CreateOrUpdate method operationId: microsoftAzureGuestdiagnosticssettingsassociationUpdate parameters: - name: resourceUri in: path required: true type: string description: The fully qualified ID of the resource, including the resource name and resource type. x-ms-skip-url-encoding: true - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/DiagnosticSettingsAssociationNameParameter' - name: parameters in: body required: true schema: $ref: '#/definitions/GuestDiagnosticSettingsAssociationResourcePatch' description: Parameters supplied to the operation. responses: '200': description: An existing guest diagnostics setting resource was successfully updated. schema: $ref: '#/definitions/GuestDiagnosticSettingsAssociationResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_5' x-ms-examples: Update a service diagnostic setting: $ref: ./examples/updateGuestDiagnosticSettingsAssociation.json summary: Microsoft Azure Patch Resourceuri Providers Microsoft Insights Guestdiagnosticsettingsassociation Associationname tags: - Providers /providers/Microsoft.HDInsight/operations: get: description: Returns list of operations. operationId: microsoftAzureOperationsList x-ms-examples: ListOperations: $ref: ./examples/GetOperations.json parameters: - $ref: ../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: Operation details. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Hdinsight Operations tags: - Providers /providers/Microsoft.Intune/locations: get: description: Returns location for user tenant. operationId: microsoftAzureGetlocations parameters: - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: location response as a collection schema: $ref: '#/definitions/LocationCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations tags: - Providers /providers/Microsoft.Intune/locations/hostName: get: description: Returns location for given tenant. operationId: microsoftAzureGetlocationbyhostname produces: - application/json parameters: - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: single location response schema: $ref: '#/definitions/Location' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/apps: get: description: Returns Intune Manageable apps. operationId: microsoftAzureGetapps produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $filter in: query required: false type: string description: The filter to apply on the operation. - name: $top in: query required: false type: integer format: int32 - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: applications as collection response schema: $ref: '#/definitions/ApplicationCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Apps tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/iosPolicies: get: description: Returns Intune iOSPolicies. operationId: microsoftAzureIosGetmampolicies produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $filter in: query required: false type: string description: The filter to apply on the operation. - name: $top in: query required: false type: integer format: int32 - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: applications as collection response schema: $ref: '#/definitions/IOSMAMPolicyCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Iospolicies tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/androidPolicies: get: description: Returns Intune Android policies. operationId: microsoftAzureAndroidGetmampolicies produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $filter in: query required: false type: string description: The filter to apply on the operation. - name: $top in: query required: false type: integer format: int32 - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: android Policies response schema: $ref: '#/definitions/AndroidMAMPolicyCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Androidpolicies tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/iosPolicies/{policyName}: get: description: Returns Intune iOS policies. operationId: microsoftAzureIosGetmampolicybyname produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: iOSMAMPolicy entity. schema: $ref: '#/definitions/iOSMAMPolicy' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Iospolicies Policyname tags: - Providers put: description: Creates or updates iOSMAMPolicy. operationId: microsoftAzureIosCreateorupdatemampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: parameters in: body required: true schema: $ref: '#/definitions/iOSMAMPolicy' description: Parameters supplied to the Create or update an android policy operation. responses: '200': description: iOSMAMPolicy entity. schema: $ref: '#/definitions/iOSMAMPolicy' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Put Providers Microsoft Intune Locations Hostname Iospolicies Policyname tags: - Providers patch: description: ' patch an iOSMAMPolicy.' operationId: microsoftAzureIosPatchmampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: parameters in: body required: true schema: $ref: '#/definitions/iOSMAMPolicy' description: Parameters supplied to the Create or update an android policy operation. responses: '200': description: iOSMAMPolicy entity. schema: $ref: '#/definitions/iOSMAMPolicy' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Patch Providers Microsoft Intune Locations Hostname Iospolicies Policyname tags: - Providers delete: description: Delete Ios Policy operationId: microsoftAzureIosDeletemampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Delete Providers Microsoft Intune Locations Hostname Iospolicies Policyname tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/androidPolicies/{policyName}: get: description: Returns AndroidMAMPolicy with given name. operationId: microsoftAzureAndroidGetmampolicybyname produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: iOSMAMPolicy entity. schema: $ref: '#/definitions/AndroidMAMPolicy' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Androidpolicies Policyname tags: - Providers put: description: Creates or updates AndroidMAMPolicy. operationId: microsoftAzureAndroidCreateorupdatemampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: parameters in: body required: true schema: $ref: '#/definitions/AndroidMAMPolicy' description: Parameters supplied to the Create or update an android policy operation. responses: '200': description: android entity. schema: $ref: '#/definitions/AndroidMAMPolicy' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Put Providers Microsoft Intune Locations Hostname Androidpolicies Policyname tags: - Providers patch: description: Patch AndroidMAMPolicy. operationId: microsoftAzureAndroidPatchmampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: parameters in: body required: true schema: $ref: '#/definitions/AndroidMAMPolicy' description: Parameters supplied to the Create or update an android policy operation. responses: '200': description: android entity. schema: $ref: '#/definitions/AndroidMAMPolicy' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Patch Providers Microsoft Intune Locations Hostname Androidpolicies Policyname tags: - Providers delete: description: Delete Android Policy operationId: microsoftAzureAndroidDeletemampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Delete Providers Microsoft Intune Locations Hostname Androidpolicies Policyname tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/iosPolicies/{policyName}/apps: get: description: Get apps for an iOSMAMPolicy. operationId: microsoftAzureIosGetappformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $filter in: query required: false type: string description: The filter to apply on the operation. - name: $top in: query required: false type: integer format: int32 - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: applications as collection response schema: $ref: '#/definitions/ApplicationCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Iospolicies Policyname Apps tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/AndroidPolicies/{policyName}/apps: get: description: Get apps for an AndroidMAMPolicy. operationId: microsoftAzureAndroidGetappformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $filter in: query required: false type: string description: The filter to apply on the operation. - name: $top in: query required: false type: integer format: int32 - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: applications as collection response schema: $ref: '#/definitions/ApplicationCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Androidpolicies Policyname Apps tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/iosPolicies/{policyName}/apps/{appName}: put: description: Add app to an iOSMAMPolicy. operationId: microsoftAzureIosAddappformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - name: appName in: path description: application unique Name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: parameters in: body required: true schema: $ref: '#/definitions/MAMPolicyAppIdOrGroupIdPayload' description: Parameters supplied to add an app to an ios policy. responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Put Providers Microsoft Intune Locations Hostname Iospolicies Policyname Apps Appname tags: - Providers delete: description: Delete App for Ios Policy operationId: microsoftAzureIosDeleteappformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - name: appName in: path description: application unique Name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Delete Providers Microsoft Intune Locations Hostname Iospolicies Policyname Apps Appname tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/androidPolicies/{policyName}/apps/{appName}: put: description: Add app to an AndroidMAMPolicy. operationId: microsoftAzureAndroidAddappformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - name: appName in: path description: application unique Name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: parameters in: body required: true schema: $ref: '#/definitions/MAMPolicyAppIdOrGroupIdPayload' description: Parameters supplied to the Create or update app to an android policy operation. responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Put Providers Microsoft Intune Locations Hostname Androidpolicies Policyname Apps Appname tags: - Providers delete: description: Delete App for Android Policy operationId: microsoftAzureAndroidDeleteappformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - name: appName in: path description: application unique Name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Delete Providers Microsoft Intune Locations Hostname Androidpolicies Policyname Apps Appname tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/iosPolicies/{policyName}/groups: get: description: Returns groups for a given iOSMAMPolicy. operationId: microsoftAzureIosGetgroupsformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: policy name for the tenant required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: groups as collection response schema: $ref: '#/definitions/GroupsCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Iospolicies Policyname Groups tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/androidPolicies/{policyName}/groups: get: description: Returns groups for a given AndroidMAMPolicy. operationId: microsoftAzureAndroidGetgroupsformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: policy name for the tenant required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: groups as collection response schema: $ref: '#/definitions/GroupsCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Androidpolicies Policyname Groups tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/iosPolicies/{policyName}/groups/{groupId}: put: description: Add group to an iOSMAMPolicy. operationId: microsoftAzureIosAddgroupformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - name: groupId in: path description: group Id required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: parameters in: body required: true schema: $ref: '#/definitions/MAMPolicyAppIdOrGroupIdPayload' description: Parameters supplied to the Create or update app to an android policy operation. responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Put Providers Microsoft Intune Locations Hostname Iospolicies Policyname Groups Groupid tags: - Providers delete: description: Delete Group for iOS Policy operationId: microsoftAzureIosDeletegroupformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - name: groupId in: path description: application unique Name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Delete Providers Microsoft Intune Locations Hostname Iospolicies Policyname Groups Groupid tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/androidPolicies/{policyName}/groups/{groupId}: put: description: Add group to an AndroidMAMPolicy. operationId: microsoftAzureAndroidAddgroupformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - name: groupId in: path description: group Id required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: parameters in: body required: true schema: $ref: '#/definitions/MAMPolicyAppIdOrGroupIdPayload' description: Parameters supplied to the Create or update app to an android policy operation. responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Put Providers Microsoft Intune Locations Hostname Androidpolicies Policyname Groups Groupid tags: - Providers delete: description: Delete Group for Android Policy operationId: microsoftAzureAndroidDeletegroupformampolicy produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: policyName in: path description: Unique name for the policy required: true type: string - name: groupId in: path description: application unique Name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: No-Content. '204': description: No-Content. default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Delete Providers Microsoft Intune Locations Hostname Androidpolicies Policyname Groups Groupid tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/users/{userName}/devices: get: description: Get devices for a user. operationId: microsoftAzureGetmamuserdevices produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: userName in: path description: user unique Name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $filter in: query required: false type: string description: The filter to apply on the operation. - name: $top in: query required: false type: integer format: int32 - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: devices as collection response schema: $ref: '#/definitions/DeviceCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Users Username Devices tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/users/{userName}/devices/{deviceName}: get: description: Get a unique device for a user. operationId: microsoftAzureGetmamuserdevicebydevicename produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: userName in: path description: unique user name required: true type: string - name: deviceName in: path description: device name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: Device entity. schema: $ref: '#/definitions/Device' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Users Username Devices Devicename tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/users/{userName}/devices/{deviceName}/wipe: post: description: Wipe a device for a user. operationId: microsoftAzureWipemamuserdevice produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: userName in: path description: unique user name required: true type: string - name: deviceName in: path description: device name required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: Wipe operation result. schema: $ref: '#/definitions/WipeDeviceOperationResult' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Post Providers Microsoft Intune Locations Hostname Users Username Devices Devicename Wipe tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/operationResults: get: description: Returns operationResults. operationId: microsoftAzureGetoperationresults produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $filter in: query required: false type: string description: The filter to apply on the operation. - name: $top in: query required: false type: integer format: int32 - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: applications as collection response schema: $ref: '#/definitions/OperationResultCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Operationresults tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/statuses/default: get: description: Returns Intune Tenant level statuses. operationId: microsoftAzureGetmamstatuses produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' responses: '200': description: applications as collection response schema: $ref: '#/definitions/StatusesDefault' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Statuses Default tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/flaggedUsers: get: description: Returns Intune flagged user collection operationId: microsoftAzureGetmamflaggedusers produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $filter in: query required: false type: string description: The filter to apply on the operation. - name: $top in: query required: false type: integer format: int32 - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: Flagged users as collection response schema: $ref: '#/definitions/FlaggedUserCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Flaggedusers tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/flaggedUsers/{userName}: get: description: Returns Intune flagged user details operationId: microsoftAzureGetmamflaggeduserbyname produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: userName in: path description: Flagged userName required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: Flagged user details in response schema: $ref: '#/definitions/FlaggedUser' default: description: unexpected error schema: $ref: '#/definitions/Error' summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Flaggedusers Username tags: - Providers /providers/Microsoft.Intune/locations/{hostName}/flaggedUsers/{userName}/flaggedEnrolledApps: get: description: Returns Intune flagged enrolled app collection for the User operationId: microsoftAzureGetmamuserflaggedenrolledapps produces: - application/json parameters: - name: hostName in: path description: Location hostName for the tenant required: true type: string - name: userName in: path description: User name for the tenant required: true type: string - $ref: '#/parameters/ApiVersionParameter_5' - name: $filter in: query required: false type: string description: The filter to apply on the operation. - name: $top in: query required: false type: integer format: int32 - name: $select in: query required: false type: string description: select specific fields in entity. responses: '200': description: Flagged enrolled Apps as collection response schema: $ref: '#/definitions/FlaggedEnrolledAppCollection' default: description: unexpected error schema: $ref: '#/definitions/Error' x-ms-pageable: nextLinkName: nextlink summary: Microsoft Azure Get Providers Microsoft Intune Locations Hostname Flaggedusers Username Flaggedenrolledapps tags: - Providers /{scope}/providers/Microsoft.ManagedIdentity/identities/default: get: operationId: microsoftAzureSystemassignedidentitiesGetbyscope description: Gets the systemAssignedIdentity available under the specified RP scope. x-ms-examples: MsiOperationsList: $ref: ./examples/SystemAssignedIdentityGet.json parameters: - $ref: '#/parameters/ScopeParameter' - $ref: '#/parameters/ApiVersionParameter_6' responses: '200': description: OK. The systemAssignedIdentity was retrieved and returned successfully. schema: $ref: '#/definitions/SystemAssignedIdentity' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' summary: Microsoft Azure Get Scope Providers Microsoft Managedidentity Identities Default tags: - Providers /providers/Microsoft.ManagedIdentity/operations: get: operationId: microsoftAzureOperationsList description: Lists available operations for the Microsoft.ManagedIdentity provider x-ms-examples: MsiOperationsList: $ref: ./examples/MsiOperationsList.json parameters: - $ref: '#/parameters/ApiVersionParameter_6' responses: '200': description: The operation was successful. The response contains the list of available operations. schema: $ref: '#/definitions/OperationListResult_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Managedidentity Operations tags: - Providers /{resourceUri}/providers/Microsoft.KubernetesRuntime/services: get: operationId: microsoftAzureServicesList tags: - Providers description: List ServiceResource resources by parent parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter' responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/ServiceResourceListResult' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Services_List: $ref: ./examples/Services_List.json x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Resourceuri Providers Microsoft Kubernetesruntime Services /{resourceUri}/providers/Microsoft.KubernetesRuntime/services/{serviceName}: get: operationId: microsoftAzureServicesGet tags: - Providers description: Get a ServiceResource parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter' - name: serviceName in: path description: The name of the the service required: true type: string pattern: ^(storageclass|networking)$ responses: '200': description: Azure operation completed successfully. schema: $ref: '#/definitions/ServiceResource' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Services_Get: $ref: ./examples/Services_Get.json summary: Microsoft Azure Get Resourceuri Providers Microsoft Kubernetesruntime Services Servicename put: operationId: microsoftAzureServicesCreateorupdate tags: - Providers description: Create a ServiceResource parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter' - name: serviceName in: path description: The name of the the service required: true type: string pattern: ^(storageclass|networking)$ - name: resource in: body description: Resource create parameters. required: true schema: $ref: '#/definitions/ServiceResource' responses: '200': description: Resource 'ServiceResource' update operation succeeded schema: $ref: '#/definitions/ServiceResource' '201': description: Resource 'ServiceResource' create operation succeeded schema: $ref: '#/definitions/ServiceResource' default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Services_CreateOrUpdate: $ref: ./examples/Services_CreateOrUpdate.json summary: Microsoft Azure Put Resourceuri Providers Microsoft Kubernetesruntime Services Servicename delete: operationId: microsoftAzureServicesDelete tags: - Providers description: Delete a ServiceResource parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/Azure.ResourceManager.ResourceUriParameter' - name: serviceName in: path description: The name of the the service required: true type: string pattern: ^(storageclass|networking)$ responses: '200': description: Resource deleted successfully. '204': description: Resource does not exist. default: description: An unexpected error response. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Services_Delete: $ref: ./examples/Services_Delete.json summary: Microsoft Azure Delete Resourceuri Providers Microsoft Kubernetesruntime Services Servicename /providers/Microsoft.SecurityDevOps/operations: get: description: Returns list of operations supported by the Microsoft.SecurityDevOps provider. operationId: microsoftAzureOperationsList produces: - application/json parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Operation details. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Operations_List: $ref: ./examples/OperationsList.json summary: Microsoft Azure Get Providers Microsoft Securitydevops Operations tags: - Providers /{resourceUri}/providers/Microsoft.ServiceLinker/linkers: get: deprecated: false description: Returns list of Linkers which connects to the resource. which supports to config both application and target service during the resource provision. operationId: microsoftAzureLinkerList x-ms-examples: LinkerList: $ref: ./examples/LinkerList.json parameters: - $ref: '#/parameters/ResourceUriParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter responses: '200': description: Linker details. schema: $ref: '#/definitions/ResourceList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Resourceuri Providers Microsoft Servicelinker Linkers tags: - Providers /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName}: get: description: Returns Linker resource for a given name. operationId: microsoftAzureLinkerGet x-ms-examples: Linker: $ref: ./examples/Linker.json parameters: - $ref: '#/parameters/ResourceUriParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/LinkerNameParameter' responses: '200': description: Linker details. schema: $ref: '#/definitions/LinkerResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Resourceuri Providers Microsoft Servicelinker Linkers Linkername tags: - Providers put: description: Create or update Linker resource. operationId: microsoftAzureLinkerCreateorupdate x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation x-ms-examples: PutLinker: $ref: ./examples/PutLinker.json parameters: - $ref: '#/parameters/ResourceUriParameter' - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter - $ref: '#/parameters/LinkerNameParameter' - name: parameters description: Linker details. in: body required: true schema: $ref: '#/definitions/LinkerResource' responses: '200': description: Successful. schema: $ref: '#/definitions/LinkerResource' '201': description: Long running operation. schema: $ref: '#/definitions/LinkerResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Resourceuri Providers Microsoft Servicelinker Linkers Linkername tags: - Providers /providers/Microsoft.Support/services: get: tags: - Providers description: Lists all the Azure services available for support ticket creation. For **Technical** issues, select the Service Id that maps to the Azure service/product as displayed in the **Services** drop-down list on the Azure portal's [New support request](https://portal.azure.com/#blade/Microsoft_Azure_Support/HelpAndSupportBlade/overview) page. Always use the service and its corresponding problem classification(s) obtained programmatically for support ticket creation. This practice ensures that you always have the most recent set of service and problem classification Ids. operationId: microsoftAzureServicesList parameters: - $ref: '#/parameters/ApiVersionParameter_7' responses: '200': description: Successfully retrieved list of the Azure services available for support. schema: $ref: '#/definitions/ServicesListResult' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: null x-ms-examples: Gets list of services for which a support ticket can be created: $ref: ./examples/ListServices.json summary: Microsoft Azure Get Providers Microsoft Support Services /providers/Microsoft.Support/services/{serviceName}: get: tags: - Providers description: Gets a specific Azure service for support ticket creation. operationId: microsoftAzureServicesGet parameters: - name: serviceName in: path description: Name of the Azure service. required: true type: string - $ref: '#/parameters/ApiVersionParameter_7' responses: '200': description: Successfully retrieved Azure service for support ticket creation. schema: $ref: '#/definitions/Service' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: Gets details of the Azure service: $ref: ./examples/GetService.json summary: Microsoft Azure Get Providers Microsoft Support Services Servicename /providers/Microsoft.NetworkCloud/operations: get: description: Get a list of all available resource provider operations. It contains a URL link to get the next set of results. summary: Microsoft Azure List Resource Provider Operations operationId: microsoftAzureOperationsList parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: OK schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/OperationListResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse x-ms-examples: List resource provider operations: $ref: ./examples/Operations_List.json x-ms-pageable: nextLinkName: nextLink tags: - Providers /providers/Microsoft.PolicyInsights/operations: get: operationId: microsoftAzureOperationsList description: Lists available operations. parameters: - $ref: '#/parameters/apiVersionParameter_5' responses: '200': description: List of available operations. schema: $ref: '#/definitions/OperationsListResults' default: description: Error response describing why the operation failed. schema: $ref: ../../stable/2019-10-01/operations.json#/definitions/QueryFailure x-ms-examples: List operations: $ref: ./examples/Operations_ListOperations.json summary: Microsoft Azure Get Providers Microsoft Policyinsights Operations tags: - Providers ? /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults : post: operationId: microsoftAzurePolicyeventsListqueryresultsformanagementgroup description: Queries policy events for the resources under the management group. parameters: - $ref: '#/parameters/policyEventsResourceParameter' - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupNameParameter' - $ref: '#/parameters/apiVersionParameter_6' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyEventsQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query at management group scope: $ref: ./examples/PolicyEvents_QueryManagementGroupScope.json Query at management group scope with next link: $ref: ./examples/PolicyEvents_QueryManagementGroupScopeNextLink.json summary: Microsoft Azure Post Providers Managementgroupsnamespace Managementgroups Managementgroupname Providers Microsoft Policyinsights Policyevents Policyeventsresource Queryresults tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/policyEvents/{policyEventsResource}/queryResults: post: operationId: microsoftAzurePolicyeventsListqueryresultsforresource description: Queries policy events for the resource. parameters: - $ref: '#/parameters/policyEventsResourceParameter' - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/apiVersionParameter_6' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyEventsQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query at resource scope: $ref: ./examples/PolicyEvents_QueryResourceScope.json Query at resource scope with next link: $ref: ./examples/PolicyEvents_QueryResourceScopeNextLink.json Query at subscription level resource scope: $ref: ./examples/PolicyEvents_QuerySubscriptionLevelResourceScope.json Query at nested resource scope: $ref: ./examples/PolicyEvents_QueryNestedResourceScope.json Query at subscription level nested resource scope: $ref: ./examples/PolicyEvents_QuerySubscriptionLevelNestedResourceScope.json summary: Microsoft Azure Post Resourceid Providers Microsoft Policyinsights Policyevents Policyeventsresource Queryresults tags: - Providers /providers/Microsoft.PolicyInsights/policyMetadata/{resourceName}: get: operationId: microsoftAzurePolicymetadataGetresource description: Get policy metadata resource. parameters: - $ref: '#/parameters/resourceNameParameter' - $ref: '#/parameters/apiVersionParameter_7' responses: '200': description: Policy metadata resource definition. schema: $ref: '#/definitions/PolicyMetadata' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get a single policy metadata resource: $ref: ./examples/PolicyMetadata_GetResource.json summary: Microsoft Azure Get Providers Microsoft Policyinsights Policymetadata Resourcename tags: - Providers /providers/Microsoft.PolicyInsights/policyMetadata: get: operationId: microsoftAzurePolicymetadataList description: Get a list of the policy metadata resources. parameters: - $ref: '#/parameters/apiVersionParameter_7' - $ref: '#/parameters/topParameter' responses: '200': description: Policy metadata resource collection. schema: $ref: '#/definitions/PolicyMetadataCollection' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Get collection of policy metadata resources: $ref: ./examples/PolicyMetadata_List.json Get collection of policy metadata resources using top query parameter: $ref: ./examples/PolicyMetadata_List_WithTop.json summary: Microsoft Azure Get Providers Microsoft Policyinsights Policymetadata tags: - Providers ? /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults : post: operationId: microsoftAzurePolicystatesListqueryresultsformanagementgroup description: Queries policy states for the resources under the management group. parameters: - $ref: '#/parameters/policyStatesResourceParameter' - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupNameParameter' - $ref: '#/parameters/apiVersionParameter_8' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query latest at management group scope: $ref: ./examples/PolicyStates_QueryManagementGroupScope.json Query latest at management group scope using odata nextLink: $ref: ./examples/PolicyStates_QueryManagementGroupScopeNextLink.json summary: Microsoft Azure Post Providers Managementgroupsnamespace Managementgroups Managementgroupname Providers Microsoft Policyinsights Policystates Policystatesresource Queryresults tags: - Providers ? /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize : post: operationId: microsoftAzurePolicystatesSummarizeformanagementgroup description: Summarizes policy states for the resources under the management group. parameters: - $ref: '#/parameters/policyStatesSummaryResourceParameter' - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupNameParameter' - $ref: '#/parameters/apiVersionParameter_8' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' responses: '200': description: Summarize results. schema: $ref: '#/definitions/SummarizeResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-examples: Summarize at management group scope: $ref: ./examples/PolicyStates_SummarizeManagementGroupScope.json summary: Microsoft Azure Post Providers Managementgroupsnamespace Managementgroups Managementgroupname Providers Microsoft Policyinsights Policystates Policystatessummaryresource Summarize tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesResource}/queryResults: post: operationId: microsoftAzurePolicystatesListqueryresultsforresource description: Queries policy states for the resource. parameters: - $ref: '#/parameters/policyStatesResourceParameter' - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/apiVersionParameter_8' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/orderByParameter' - $ref: '#/parameters/selectParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/applyParameter' - $ref: '#/parameters/expandParameter' - $ref: '#/parameters/skipTokenParameter' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyStatesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: '@odata.nextLink' x-ms-examples: Query all policy states at resource scope: $ref: ./examples/PolicyStates_QueryResourceScope.json Query all policy states at resource scope with next link: $ref: ./examples/PolicyStates_QueryResourceScopeNextLink.json Query all policy states at subscription level resource scope: $ref: ./examples/PolicyStates_QuerySubscriptionLevelResourceScope.json Query all policy states at nested resource scope: $ref: ./examples/PolicyStates_QueryNestedResourceScope.json Query all policy states at subscription level nested resource scope: $ref: ./examples/PolicyStates_QuerySubscriptionLevelNestedResourceScope.json Query all policy states at resource scope and expand policyEvaluationDetails: $ref: ./examples/PolicyStates_QueryResourceScopeExpandPolicyEvaluationDetails.json summary: Microsoft Azure Post Resourceid Providers Microsoft Policyinsights Policystates Policystatesresource Queryresults tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/policyStates/{policyStatesSummaryResource}/summarize: post: operationId: microsoftAzurePolicystatesSummarizeforresource description: Summarizes policy states for the resource. parameters: - $ref: '#/parameters/policyStatesSummaryResourceParameter' - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/apiVersionParameter_8' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/fromParameter' - $ref: '#/parameters/toParameter' - $ref: '#/parameters/filterParameter' responses: '200': description: Summarize results. schema: $ref: '#/definitions/SummarizeResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-examples: Summarize at resource scope: $ref: ./examples/PolicyStates_SummarizeResourceScope.json summary: Microsoft Azure Post Resourceid Providers Microsoft Policyinsights Policystates Policystatessummaryresource Summarize tags: - Providers /{scope}/providers/Microsoft.PolicyInsights/policyStates/$metadata: get: operationId: microsoftAzurePolicystatesGetmetadata description: Gets OData metadata XML document. produces: - application/xml parameters: - $ref: '#/parameters/scopeParameter' - $ref: '#/parameters/apiVersionParameter_8' responses: '200': description: OData metadata XML document. schema: $ref: '#/definitions/MetadataDocument' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-examples: Get metadata: $ref: ./examples/PolicyStates_GetMetadata.json summary: Microsoft Azure Get Scope Providers Microsoft Policyinsights Policystates $metadata tags: - Providers ? /providers/{managementGroupsNamespace}/managementGroups/{managementGroupName}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults : post: operationId: microsoftAzurePolicytrackedresourcesListqueryresultsformanagementgroup description: Queries policy tracked resources under the management group. parameters: - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupNameParameter' - $ref: '#/parameters/policyTrackedResourcesResourceParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/apiVersionParameter_9' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyTrackedResourcesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Query at management group scope: $ref: ./examples/PolicyTrackedResources_QueryManagementGroupScope.json Query at management group scope using query parameters: $ref: ./examples/PolicyTrackedResources_QueryManagementGroupScopeWithFilterAndTop.json summary: Microsoft Azure Post Providers Managementgroupsnamespace Managementgroups Managementgroupname Providers Microsoft Policyinsights Policytrackedresources Policytrackedresourcesresource Queryresults tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/policyTrackedResources/{policyTrackedResourcesResource}/queryResults: post: operationId: microsoftAzurePolicytrackedresourcesListqueryresultsforresource description: Queries policy tracked resources under the resource. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/policyTrackedResourcesResourceParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/apiVersionParameter_9' responses: '200': description: Query results. schema: $ref: '#/definitions/PolicyTrackedResourcesQueryResults' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/QueryFailure' x-ms-pageable: nextLinkName: nextLink x-ms-examples: Query at resource scope: $ref: ./examples/PolicyTrackedResources_QueryResourceScope.json Query at resource scope using query parameters: $ref: ./examples/PolicyTrackedResources_QueryResourceScopeWithFilterAndTop.json summary: Microsoft Azure Post Resourceid Providers Microsoft Policyinsights Policytrackedresources Policytrackedresourcesresource Queryresults tags: - Providers /providers/Microsoft.RecommendationsService/locations/{location}/operationStatuses/{operationId}: get: operationId: microsoftAzureOperationstatusesGet description: Returns the current status of an async operation. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/LocationParameter - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/OperationIdParameter responses: '200': description: Requested operation status schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/OperationStatusResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-examples: Get operation status: $ref: ./examples/OperationStatuses_Get.json summary: Microsoft Azure Get Providers Microsoft Recommendationsservice Locations Location Operationstatuses Operationid tags: - Providers /providers/Microsoft.RecommendationsService/operations: get: operationId: microsoftAzureOperationsList description: Returns list of operations. parameters: - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter responses: '200': description: Operation details. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/OperationListResult default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink x-ms-examples: Get all RecommendationsService operations: $ref: ./examples/Operations_List.json summary: Microsoft Azure Get Providers Microsoft Recommendationsservice Operations tags: - Providers ? /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments : post: operationId: microsoftAzureRemediationsListdeploymentsatmanagementgroup description: Gets all deployments for a remediation at management group scope. parameters: - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediation deployments. schema: $ref: '#/definitions/RemediationDeploymentsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List deployments for a remediation at management group scope: $ref: ./examples/Remediations_ListDeploymentsManagementGroupScope.json summary: Microsoft Azure Post Providers Managementgroupsnamespace Managementgroups Managementgroupid Providers Microsoft Policyinsights Remediations Remediationname Listdeployments tags: - Providers ? /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel : post: operationId: microsoftAzureRemediationsCancelatmanagementgroup description: Cancels a remediation at management group scope. parameters: - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The remediation that was canceled. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Cancel a remediation at management group scope: $ref: ./examples/Remediations_CancelManagementGroupScope.json summary: Microsoft Azure Post Providers Managementgroupsnamespace Managementgroups Managementgroupid Providers Microsoft Policyinsights Remediations Remediationname Cancel tags: - Providers ? /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations : get: operationId: microsoftAzureRemediationsListformanagementgroup description: Gets all remediations for the management group. parameters: - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupIdParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediations. schema: $ref: '#/definitions/RemediationListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List remediations at management group scope: $ref: ./examples/Remediations_ListManagementGroupScope.json List remediations at management group scope with query parameters: $ref: ./examples/Remediations_ListManagementGroupScope_WithQuery.json summary: Microsoft Azure Get Providers Managementgroupsnamespace Managementgroups Managementgroupid Providers Microsoft Policyinsights Remediations tags: - Providers ? /providers/{managementGroupsNamespace}/managementGroups/{managementGroupId}/providers/Microsoft.PolicyInsights/remediations/{remediationName} : put: operationId: microsoftAzureRemediationsCreateorupdateatmanagementgroup description: Creates or updates a remediation at management group scope. parameters: - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' - name: parameters in: body required: true schema: $ref: '#/definitions/Remediation' description: The remediation parameters. responses: '200': description: The updated remediation. schema: $ref: '#/definitions/Remediation' '201': description: The created remediation. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Create remediation at management group scope: $ref: ./examples/Remediations_CreateManagementGroupScope.json summary: Microsoft Azure Put Providers Managementgroupsnamespace Managementgroups Managementgroupid Providers Microsoft Policyinsights Remediations Remediationname tags: - Providers get: operationId: microsoftAzureRemediationsGetatmanagementgroup description: Gets an existing remediation at management group scope. parameters: - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediation. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get remediation at management group scope: $ref: ./examples/Remediations_GetManagementGroupScope.json summary: Microsoft Azure Get Providers Managementgroupsnamespace Managementgroups Managementgroupid Providers Microsoft Policyinsights Remediations Remediationname tags: - Providers delete: operationId: microsoftAzureRemediationsDeleteatmanagementgroup description: Deletes an existing remediation at management group scope. parameters: - $ref: '#/parameters/managementGroupsNamespaceParameter' - $ref: '#/parameters/managementGroupIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The deleted remediation. schema: $ref: '#/definitions/Remediation' '204': description: The remediation did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Delete remediation at management group scope: $ref: ./examples/Remediations_DeleteManagementGroupScope.json summary: Microsoft Azure Delete Providers Managementgroupsnamespace Managementgroups Managementgroupid Providers Microsoft Policyinsights Remediations Remediationname tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/listDeployments: post: operationId: microsoftAzureRemediationsListdeploymentsatresource description: Gets all deployments for a remediation at resource scope. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediation deployments. schema: $ref: '#/definitions/RemediationDeploymentsListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List deployments for a remediation at individual resource scope: $ref: ./examples/Remediations_ListDeploymentsResourceScope.json summary: Microsoft Azure Post Resourceid Providers Microsoft Policyinsights Remediations Remediationname Listdeployments tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}/cancel: post: operationId: microsoftAzureRemediationsCancelatresource description: Cancel a remediation at resource scope. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The remediation that was canceled. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Cancel a remediation at individual resource scope: $ref: ./examples/Remediations_CancelResourceScope.json summary: Microsoft Azure Post Resourceid Providers Microsoft Policyinsights Remediations Remediationname Cancel tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/remediations: get: operationId: microsoftAzureRemediationsListforresource description: Gets all remediations for a resource. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/topParameter' - $ref: '#/parameters/filterParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediations. schema: $ref: '#/definitions/RemediationListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink x-ms-examples: List remediations at individual resource scope: $ref: ./examples/Remediations_ListResourceScope.json List remediations at individual resource scope with query parameters: $ref: ./examples/Remediations_ListResourceScope_WithQuery.json summary: Microsoft Azure Get Resourceid Providers Microsoft Policyinsights Remediations tags: - Providers /{resourceId}/providers/Microsoft.PolicyInsights/remediations/{remediationName}: put: operationId: microsoftAzureRemediationsCreateorupdateatresource description: Creates or updates a remediation at resource scope. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' - name: parameters in: body required: true schema: $ref: '#/definitions/Remediation' description: The remediation parameters. responses: '200': description: The updated remediation. schema: $ref: '#/definitions/Remediation' '201': description: The created remediation. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Create remediation at individual resource scope: $ref: ./examples/Remediations_CreateResourceScope.json summary: Microsoft Azure Put Resourceid Providers Microsoft Policyinsights Remediations Remediationname tags: - Providers get: operationId: microsoftAzureRemediationsGetatresource description: Gets an existing remediation at resource scope. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The retrieved remediation. schema: $ref: '#/definitions/Remediation' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Get remediation at individual resource scope: $ref: ./examples/Remediations_GetResourceScope.json summary: Microsoft Azure Get Resourceid Providers Microsoft Policyinsights Remediations Remediationname tags: - Providers delete: operationId: microsoftAzureRemediationsDeleteatresource description: Deletes an existing remediation at individual resource scope. parameters: - $ref: '#/parameters/resourceIdParameter' - $ref: '#/parameters/remediationNameParameter' - $ref: '#/parameters/apiVersionParameter_10' responses: '200': description: The deleted remediation. schema: $ref: '#/definitions/Remediation' '204': description: The remediation did not exist. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-examples: Delete remediation at individual resource scope: $ref: ./examples/Remediations_DeleteResourceScope.json summary: Microsoft Azure Delete Resourceid Providers Microsoft Policyinsights Remediations Remediationname tags: - Providers /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister: post: tags: - Providers operationId: microsoftAzureProvidersUnregister description: Unregisters a subscription from a resource provider. parameters: - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider to unregister. - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the resource provider. schema: $ref: '#/definitions/Provider' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Resourceprovidernamespace Unregister /providers/Microsoft.Management/managementGroups/{groupId}/providers/{resourceProviderNamespace}/register: post: tags: - Providers operationId: microsoftAzureProvidersRegisteratmanagementgroupscope description: Registers a management group with a resource provider. Use this operation to register a resource provider with resource types that can be deployed at the management group scope. It does not recursively register subscriptions within the management group. Instead, you must register subscriptions individually. parameters: - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider to register. - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/GroupIdParameter' responses: '200': description: OK - Returns information about the resource provider. default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Post Providers Microsoft Management Managementgroups Groupid Providers Resourceprovidernamespace Register /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/providerPermissions: get: tags: - Providers operationId: microsoftAzureProvidersProviderpermissions description: Get the provider permissions. parameters: - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information on the provider permissions. schema: $ref: '#/definitions/ProviderPermissionListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-examples: Get provider resource types.: $ref: ./examples/GetProviderPermissions.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Resourceprovidernamespace Providerpermissions /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register: post: tags: - Providers operationId: microsoftAzureProvidersRegister description: Registers a subscription with a resource provider. parameters: - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider to register. - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter' - name: properties in: body required: false schema: $ref: '#/definitions/ProviderRegistrationRequest' description: The third party consent for S2S. responses: '200': description: OK - Returns information about the resource provider. schema: $ref: '#/definitions/Provider' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Post Subscriptions Subscriptionid Providers Resourceprovidernamespace Register /providers: get: tags: - Providers operationId: microsoftAzureProvidersListattenantscope description: Gets all resource providers for the tenant. parameters: - name: $expand in: query required: false type: string description: The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases. - $ref: '#/parameters/ApiVersionParameter_8' responses: '200': description: OK - Returns an array of resource providers. schema: $ref: '#/definitions/ProviderListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}: get: tags: - Providers operationId: microsoftAzureProvidersGet description: Gets the specified resource provider. parameters: - name: $expand in: query required: false type: string description: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns information about the resource provider. schema: $ref: '#/definitions/Provider' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-examples: Get provider.: $ref: ./examples/GetProvider.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Resourceprovidernamespace /subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/resourceTypes: get: tags: - Providers operationId: microsoftAzureProviderresourcetypesList description: List the resource types for a specified resource provider. parameters: - name: $expand in: query required: false type: string description: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - $ref: '#/parameters/ApiVersionParameter_8' - $ref: '#/parameters/SubscriptionIdParameter' responses: '200': description: OK - Returns resource types information for the resource provider. schema: $ref: '#/definitions/ProviderResourceTypeListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-examples: Get provider resource types.: $ref: ./examples/GetProviderResourceTypes.json summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Resourceprovidernamespace Resourcetypes /providers/{resourceProviderNamespace}: get: tags: - Providers x-ms-examples: Get a resource provider at tenant scope: $ref: ./examples/GetNamedProviderAtTenant.json operationId: microsoftAzureProvidersGetattenantscope description: Gets the specified resource provider at the tenant level. parameters: - name: $expand in: query required: false type: string description: The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases. - name: resourceProviderNamespace in: path required: true type: string description: The namespace of the resource provider. - $ref: '#/parameters/ApiVersionParameter_8' responses: '200': description: OK - Returns information about the resource provider. schema: $ref: '#/definitions/Provider' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' summary: Microsoft Azure Get Providers Resourceprovidernamespace /{scope}/providers/Microsoft.Resources/tags/default: put: tags: - Providers operationId: microsoftAzureTagsCreateorupdateatscope summary: Microsoft Azure Creates Or Updates The Entire Set Of Tags On A Resource Or Subscription description: This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags. parameters: - $ref: '#/parameters/ScopeParameter_2' - $ref: '#/parameters/ApiVersionParameter_8' - name: parameters in: body required: true schema: $ref: '#/definitions/TagsResource' responses: '200': description: Tags updated successfully. Returns tags from the specified object. schema: $ref: '#/definitions/TagsResource' '202': headers: Location: type: string description: URL to get status of this long-running operation. description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true x-ms-examples: Update tags on a resource: $ref: ./examples/PutTagsResource.json Update tags on a subscription: $ref: ./examples/PutTagsSubscription.json patch: tags: - Providers operationId: microsoftAzureTagsUpdateatscope summary: Microsoft Azure Selectively Updates The Set Of Tags On A Resource Or Subscription description: This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs. parameters: - $ref: '#/parameters/ScopeParameter_2' - $ref: '#/parameters/ApiVersionParameter_8' - name: parameters in: body required: true schema: $ref: '#/definitions/TagsPatchResource' responses: '200': description: Tags updated successfully. Returns tags from the specified object. schema: $ref: '#/definitions/TagsResource' '202': headers: Location: type: string description: URL to get status of this long-running operation. description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true x-ms-examples: Update tags on a resource: $ref: ./examples/PatchTagsResource.json Update tags on a subscription: $ref: ./examples/PatchTagsSubscription.json get: tags: - Providers operationId: microsoftAzureTagsGetatscope summary: Microsoft Azure Gets The Entire Set Of Tags On A Resource Or Subscription parameters: - $ref: '#/parameters/ScopeParameter_2' - $ref: '#/parameters/ApiVersionParameter_8' responses: '200': description: Returns tags from the specified object. schema: $ref: '#/definitions/TagsResource' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-examples: Get tags on a resource: $ref: ./examples/GetTagsResource.json Get tags on a subscription: $ref: ./examples/GetTagsSubscription.json description: Needs a more full description created. delete: tags: - Providers operationId: microsoftAzureTagsDeleteatscope summary: Microsoft Azure Deletes The Entire Set Of Tags On A Resource Or Subscription parameters: - $ref: '#/parameters/ScopeParameter_2' - $ref: '#/parameters/ApiVersionParameter_8' responses: '200': description: Tags successfully deleted. '202': headers: Location: type: string description: URL to get status of this long-running operation. description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/CloudError_3' x-ms-long-running-operation: true x-ms-examples: Update tags on a resource: $ref: ./examples/DeleteTagsResource.json Update tags on a subscription: $ref: ./examples/DeleteTagsSubscription.json description: Needs a more full description created. /providers/Microsoft.SecurityInsights/operations: get: x-ms-examples: Get all operations.: $ref: ./examples/operations/ListOperations.json operationId: microsoftAzureOperationsList description: Lists all operations available Azure Security Insights Resource Provider. parameters: - $ref: ../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter produces: - application/json responses: '200': description: OK. Successfully retrieved operations list. schema: $ref: '#/definitions/OperationsList' default: description: Error response describing why the operation failed. schema: $ref: ../../../common/2.0/types.json#/definitions/CloudError x-ms-pageable: nextLinkName: nextLink summary: Microsoft Azure Get Providers Microsoft Securityinsights Operations tags: - Providers ? /providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.AlertsManagement/tenantActivityLogAlerts/{alertRuleName} : put: description: Create a new Tenant Activity Log Alert rule or update an existing one. operationId: microsoftAzureTenantactivitylogalertsCreateorupdate x-ms-examples: Create or update a Tenant Activity Log Alert rule for tenant level events: $ref: ./examples/TenantActivityLogAlertRule_CreateOrUpdate.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ManagementGroupNameParameter - $ref: '#/parameters/TenantActivityLogAlertNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: tenantActivityLogAlertRule description: The Tenant Activity Log Alert rule to create or use for the update. in: body required: true schema: $ref: '#/definitions/TenantActivityLogAlertResource' responses: '200': description: An existing Tenant Activity Log Alert rule was successfully updated. schema: $ref: '#/definitions/TenantActivityLogAlertResource' '201': description: A new Tenant Activity Log Alert rule was successfully created. schema: $ref: '#/definitions/TenantActivityLogAlertResource' default: description: An error occurred and the Activity Log Alert rule could not be created or updated. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Put Providers Microsoft Management Managementgroups Managementgroupname Providers Microsoft Alertsmanagement Tenantactivitylogalerts Alertrulename tags: - Providers get: description: Get Tenant Activity Log Alert rule. operationId: microsoftAzureTenantactivitylogalertsGet x-ms-examples: Get a Tenant Activity Log Alert rule: $ref: ./examples/TenantActivityLogAlertRule_GetRule.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ManagementGroupNameParameter - $ref: '#/parameters/TenantActivityLogAlertNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/TenantActivityLogAlertResource' default: description: An error occurred and the Activity Log Alert rule could not be retrieved. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Providers Microsoft Management Managementgroups Managementgroupname Providers Microsoft Alertsmanagement Tenantactivitylogalerts Alertrulename tags: - Providers delete: description: Delete a Tenant Activity Log Alert rule. operationId: microsoftAzureTenantactivitylogalertsDelete x-ms-examples: Delete a Tenant Activity Log Alert rule: $ref: ./examples/TenantActivityLogAlertRule_DeleteRule.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ManagementGroupNameParameter - $ref: '#/parameters/TenantActivityLogAlertNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: The Tenant Activity Log Alert rule was successfully deleted. '204': description: The Tenant Activity Log Alert rule does not exist. It may have already been deleted. default: description: An error occurred and the Activity Log Alert rule could not be deleted. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Delete Providers Microsoft Management Managementgroups Managementgroupname Providers Microsoft Alertsmanagement Tenantactivitylogalerts Alertrulename tags: - Providers patch: description: Updates 'tags' and 'enabled' fields in an existing Tenant Alert rule. This method is used to update the Alert rule tags, and to enable or disable the Alert rule. To update other fields use CreateOrUpdate operation. operationId: microsoftAzureTenantactivitylogalertsUpdate x-ms-examples: Patch a Tenant Activity Log Alert rule: $ref: ./examples/TenantActivityLogAlertRule_UpdateRule.json parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ManagementGroupNameParameter - $ref: '#/parameters/TenantActivityLogAlertNameParameter' - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter - name: tenantActivityLogAlertRulePatch in: body required: true schema: $ref: '#/definitions/TenantAlertRulePatchObject' description: Parameters supplied to the operation. responses: '200': description: An existing Activity Log Alert rule was successfully updated. schema: $ref: '#/definitions/TenantActivityLogAlertResource' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Patch Providers Microsoft Management Managementgroups Managementgroupname Providers Microsoft Alertsmanagement Tenantactivitylogalerts Alertrulename tags: - Providers /providers/Microsoft.AlertsManagement/tenantActivityLogAlerts: get: description: Get a list of all Tenant Activity Log Alert rules in the tenant. operationId: microsoftAzureTenantactivitylogalertsListbytenant x-ms-examples: List Activity Log Alerts by tenant: $ref: ./examples/TenantActivityLogAlertRule_ListByTenant.json x-ms-pageable: nextLinkName: nextLink parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/TenantAlertRuleList' default: description: An error occurred and the list of Activity Log Alert rules could not be retrieved. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Providers Microsoft Alertsmanagement Tenantactivitylogalerts tags: - Providers ? /providers/Microsoft.Management/managementGroups/{managementGroupName}/providers/Microsoft.AlertsManagement/tenantActivityLogAlerts : get: description: Get a list of all Tenant Activity Log Alert rules in a management group. operationId: microsoftAzureTenantactivitylogalertsListbymanagementgroup x-ms-examples: List Activity Log Alerts by management group: $ref: ./examples/TenantActivityLogAlertRule_ListByManagementGroup.json x-ms-pageable: nextLinkName: nextLink parameters: - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ManagementGroupNameParameter - $ref: ../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter responses: '200': description: The request succeeded. schema: $ref: '#/definitions/TenantAlertRuleList' default: description: An error occurred and the list of Activity Log Alert rules could not be retrieved. schema: $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ErrorResponse summary: Microsoft Azure Get Providers Microsoft Management Managementgroups Managementgroupname Providers Microsoft Alertsmanagement Tenantactivitylogalerts tags: - Providers /providers/Microsoft.WorkloadMonitor/operations: get: summary: Microsoft Azure Get A List Of All Available Rest Api Operations operationId: microsoftAzureOperationsList produces: - application/json x-ms-pageable: nextLinkName: nextLink parameters: - $ref: '#/parameters/api-version' responses: '200': description: The list of available REST API operations. schema: $ref: '#/definitions/OperationList_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse_6' x-ms-examples: OperationList_Get: $ref: ./examples/OperationList_Get.json description: Needs a more full description created. tags: - Providers components: schemas: ErrorResponse: type: object description: Common error response for all Azure Resource Manager APIs. properties: code: type: string readOnly: true description: The error code. example: example_value message: type: string readOnly: true description: The error message. example: example_value target: type: string readOnly: true description: The error target. example: example_value details: type: array readOnly: true items: $ref: '#/components/schemas/ErrorResponse' description: The error details. example: [] additionalInfo: type: array readOnly: true items: $ref: '#/components/schemas/ErrorAdditionalInfo' description: The error additional info. example: [] ProviderListResult: type: object description: List of resource providers. properties: value: type: array items: $ref: '#/components/schemas/Provider' description: An array of resource providers. example: [] nextLink: type: string readOnly: true description: The URL to get the next set of results. example: example_value ProviderResourceType: type: object description: Resource type managed by the resource provider. properties: resourceType: type: string description: The resource type. example: example_value locations: type: array items: type: string description: The collection of locations where this resource type can be created. example: [] apiVersions: type: array items: type: string description: The API version. example: [] ErrorAdditionalInfo: type: object description: The resource management error additional info. properties: type: type: string readOnly: true description: The additional info type. example: example_value info: type: object readOnly: true description: The additional info. example: example_value CloudError: type: object description: An error response for a resource management request. properties: error: $ref: '#/components/schemas/ErrorResponse' Provider: type: object description: Resource provider information. properties: id: type: string readOnly: true description: The provider ID. example: abc123 namespace: type: string description: The namespace of the resource provider. example: example_value registrationState: type: string readOnly: true description: The registration state of the resource provider. example: example_value registrationPolicy: type: string readOnly: true description: The registration policy of the resource provider. example: example_value resourceTypes: type: array readOnly: true items: $ref: '#/components/schemas/ProviderResourceType' description: The collection of provider resource types. example: [] parameters: SubscriptionIdParameter: name: subscriptionId in: path required: true description: The ID of the target subscription. schema: type: string format: uuid ApiVersionParameter: name: api-version in: query required: true description: The API version to use for this operation. schema: type: string default: '2024-03-01' definitions: errorResponse: type: object description: An error response from the service. properties: error: $ref: '#/definitions/errorResponseBody' Operation_4: properties: name: type: string description: The operation name. display: $ref: '#/definitions/OperationDisplay_4' description: The operation display name. origin: type: string description: Origin of the operation. properties: $ref: '#/definitions/Properties' description: Operation properties format. isDataAction: type: boolean description: Whether the operation applies to data-plane. x-nullable: true actionType: type: string enum: - Internal x-ms-enum: name: ActionType values: - value: Internal description: An internal action. modelAsString: true description: Indicates the action type. x-nullable: true type: object required: - name description: An operation. Summary: description: Summary results. properties: '@odata.id': description: OData entity ID; always set to null since summaries do not have an entity ID. type: string '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string results: description: Non-compliance summary for all policy assignments. $ref: '#/definitions/SummaryResults' policyAssignments: description: Policy assignments summary. type: array items: $ref: '#/definitions/PolicyAssignmentSummary' operation: type: object description: Operation provided by provider properties: name: type: string description: Name of the operation display: type: object description: Properties of the operation properties: provider: type: string description: Provider name resource: type: string description: Resource name operation: type: string description: Operation name description: type: string description: Description of the operation origin: type: string description: Origin of the operation ConsoleProperties: description: Cloud shell console properties. type: object required: - osType - provisioningState - uri properties: osType: description: The operating system type of the cloud shell. type: string enum: - Linux - Windows x-ms-enum: name: osType modelAsString: true provisioningState: description: Provisioning state of the console. type: string enum: - NotSpecified - Accepted - Pending - Updating - Creating - Repairing - Failed - Canceled - Succeeded x-ms-enum: name: provisioningState modelAsString: true uri: description: Uri of the console. type: string AzureAppPushReceiver: description: The Azure mobile App push notification receiver. type: object properties: name: type: string description: The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group. emailAddress: type: string description: The email address registered for the Azure mobile app. required: - name - emailAddress alertModificationProperties: type: object description: Properties of the alert modification item. properties: alertId: type: string description: Unique Id of the alert for which the history is being retrieved readOnly: true modifications: type: array description: Modification details items: $ref: '#/definitions/alertModificationItem' x-ms-identifiers: [] OperationsList: description: Lists the operations available in the SecurityInsights RP. properties: nextLink: description: URL to fetch the next set of operations. type: string readOnly: true value: description: Array of operations items: $ref: '#/definitions/Operation_10' type: array required: - value type: object StatusesProperties: properties: deployedPolicies: type: integer readOnly: true enrolledUsers: type: integer readOnly: true flaggedUsers: type: integer readOnly: true lastModifiedTime: type: string readOnly: true format: date-time policyAppliedUsers: type: integer readOnly: true status: type: string readOnly: true wipeFailedApps: type: integer readOnly: true wipePendingApps: type: integer readOnly: true wipeSucceededApps: type: integer readOnly: true GuestDiagnosticSettingsAssociation: description: A guest diagnostic settings association. properties: guestDiagnosticSettingsName: type: string description: The guest diagnostic settings name. required: - guestDiagnosticSettingsName TenantAlertRulePatchProperties: type: object description: An Activity Log Alert rule properties for patch operations. properties: enabled: description: Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. type: boolean default: true AlertRuleAnyOfOrLeafCondition: description: "An Activity Log Alert rule condition that is met when all its member conditions are met.\nEach condition can be of one of the following types:\n__Important__: Each type has its unique subset of properties. Properties from different types CANNOT exist in one condition.\n * __Leaf Condition -__ must contain 'field' and either 'equals' or 'containsAny'.\n _Please note, 'anyOf' should __not__ be set in a Leaf Condition._\n * __AnyOf Condition -__ must contain __only__ 'anyOf' (which is an array of Leaf Conditions).\n _Please note, 'field', 'equals' and 'containsAny' should __not__ be set in an AnyOf Condition._\n" type: object allOf: - $ref: '#/definitions/AlertRuleLeafCondition' properties: anyOf: title: An Activity Log Alert rule 'anyOf' condition. description: An Activity Log Alert rule condition that is met when at least one of its member leaf conditions are met. type: array items: $ref: '#/definitions/AlertRuleLeafCondition' x-ms-identifiers: [] alertEnrichmentProperties: type: object description: Properties of the alert enrichment item. properties: alertId: type: string description: Unique Id (GUID) of the alert for which the enrichments are being retrieved. readOnly: true enrichments: type: array description: Enrichment details items: $ref: '#/definitions/alertEnrichmentItem' x-ms-identifiers: [] ConsoleCreateProperties: description: Cloud shell properties for creating a console. type: object required: - osType properties: osType: description: The operating system type of the cloud shell. type: string enum: - Linux - Windows x-ms-enum: name: osType modelAsString: true provisioningState: description: Provisioning state of the console. type: string enum: - NotSpecified - Accepted - Pending - Updating - Creating - Repairing - Failed - Canceled - Succeeded x-ms-enum: name: provisioningState modelAsString: true uri: description: Uri of the console. type: string alertsSummary: type: object description: Summary of alerts based on the input filters and 'groupby' parameters. allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/alertsSummaryGroup' AndroidMAMPolicy: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/AndroidMAMPolicyProperties' allOf: - $ref: '#/definitions/Resource_4' description: Android Policy entity for Intune MAM. CarbonEmissionData: type: object description: Response for given query parameters properties: dataType: type: string description: Query result data type name totalCarbonEmission: type: number format: double description: Total carbon emissions for given query parameters totalCarbonEmissionLastMonth: type: number format: double description: Total carbon emission for last month for given query parameters changeRatioForLastMonth: type: number format: double description: Change ratio between totalCarbonEmission and totalCarbonEmissionLastMonth totalCarbonEmission12MonthsAgo: type: number format: double description: Total carbon emissions for 12 months ago for given query parameters changeRatioFor12Months: type: number format: double description: Change ratio between totalCarbonEmission and totalCarbonEmission12MonthsAgo changeValueMonthOverMonth: type: number format: double description: Change Value between totalCarbonEmission and totalCarbonEmissionLastMonth discriminator: dataType required: - dataType - totalCarbonEmission - totalCarbonEmissionLastMonth - changeRatioForLastMonth - totalCarbonEmission12MonthsAgo - changeRatioFor12Months SystemAssignedIdentity: properties: location: type: string x-ms-mutability: - read - create description: The geo-location where the resource lives tags: type: object additionalProperties: type: string x-ms-mutability: - read - create - update description: Resource tags properties: x-ms-client-flatten: true readOnly: true description: The properties associated with the identity. $ref: '#/definitions/SystemAssignedIdentityProperties' required: - location allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource description: Describes a system assigned identity resource. Location: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/LocationProperties' allOf: - $ref: '#/definitions/Resource_4' description: Location entity for given tenant. MergedExportError: description: The merged export error. type: object properties: id: description: The error Id. type: string incomingObjectDisplayName: description: The incoming object display name. type: string incomingObjectType: description: The incoming object type. type: string userPrincipalName: description: The user principal name type: string type: description: The type of the error. type: string attributeName: description: The attribute name. type: string attributeValue: description: The attribute value. type: string timeOccurred: description: The date and time when the error occurred. type: string format: date-time timeFirstOccurred: description: The time when the error first occurred. type: string format: date-time csObjectId: description: ' the cs object Id.' type: string dn: description: the DN of the object. type: string incomingObject: description: The incoming object details. $ref: '#/definitions/AssociatedObject' existingObject: description: The existing object $ref: '#/definitions/AssociatedObject' modifiedOrRemovedAttributeValue: description: The modified or removed attribute value. type: string runStepResultId: description: The run step result Id. type: string format: uuid samAccountName: description: The sam account name. type: string serverErrorDetail: description: The server error details. type: string serviceId: description: The service Id. type: string format: uuid serviceMemberId: description: The server Id. type: string format: uuid mergedEntityId: description: The merged entity Id. type: string format: uuid createdDate: description: The date and time, in UTC, when the error was created. type: string format: date-time exportErrorStatus: description: The export error status. type: integer MAMPolicyAppOrGroupIdProperties: required: - url properties: url: type: string description: Android Policy request body for Intune MAM. AliasPathMetadata: properties: type: type: string readOnly: true enum: - NotSpecified - Any - String - Object - Array - Integer - Number - Boolean x-ms-enum: name: AliasPathTokenType modelAsString: true values: - value: NotSpecified description: The token type is not specified. - value: Any description: The token type can be anything. - value: String description: The token type is string. - value: Object description: The token type is object. - value: Array description: The token type is array. - value: Integer description: The token type is integer. - value: Number description: The token type is number. - value: Boolean description: The token type is boolean. description: The type of the token that the alias path is referring to. attributes: type: string readOnly: true enum: - None - Modifiable x-ms-enum: name: AliasPathAttributes modelAsString: true values: - value: None description: The token that the alias path is referring to has no attributes. - value: Modifiable description: The token that the alias path is referring to is modifiable by policies with 'modify' effect. description: The attributes of the token that the alias path is referring to. CloudShellPatchUserSettings: description: Cloud shell patch operation user settings. type: object properties: properties: $ref: '#/definitions/UserProperties' AttestationProperties: properties: policyAssignmentId: type: string description: The resource ID of the policy assignment that the attestation is setting the state for. policyDefinitionReferenceId: type: string description: The policy definition reference ID from a policy set definition that the attestation is setting the state for. If the policy assignment assigns a policy set definition the attestation can choose a definition within the set definition with this property or omit this and set the state for the entire set definition. complianceState: type: string enum: - Compliant - NonCompliant - Unknown x-ms-enum: name: ComplianceState modelAsString: true values: - value: Compliant description: The resource is in compliance with the policy. - value: NonCompliant description: The resource is not in compliance with the policy. - value: Unknown description: The compliance state of the resource is not known. description: The compliance state that should be set on the resource. expiresOn: type: string format: date-time description: The time the compliance state should expire. owner: type: string description: The person responsible for setting the state of the resource. This value is typically an Azure Active Directory object ID. comments: type: string description: Comments describing why this attestation was created. evidence: type: array items: $ref: '#/definitions/AttestationEvidence' x-ms-identifiers: [] description: The evidence supporting the compliance state set in this attestation. provisioningState: type: string description: The status of the attestation. readOnly: true lastComplianceStateChangeAt: type: string format: date-time description: The time the compliance state was last changed in this attestation. readOnly: true assessmentDate: type: string format: date-time description: The time the evidence was assessed metadata: type: object description: Additional metadata for this attestation required: - policyAssignmentId description: The properties of an attestation resource. PolicyMetadataProperties: description: The properties of the policy metadata. properties: description: description: The description of the policy metadata. type: string readOnly: true requirements: description: The requirements of the policy metadata. type: string readOnly: true allOf: - $ref: '#/definitions/PolicyMetadataSlimProperties' OperationCollection: properties: value: type: array items: $ref: '#/definitions/Operation_4' x-ms-identifiers: - name description: A collection of Operation items. type: object description: A collection of Operation items. PublicNetworkSolution: type: object description: Indicates public network solution, include firewall rules properties: deleteOrUpdateBehavior: description: Indicates whether to clean up previous operation(such as firewall rules) when Linker is updating or deleting $ref: '#/definitions/DeleteOrUpdateBehavior' action: description: Optional. Indicates public network solution. If enable, enable public network access of target service with best try. Default is enable. If optOut, opt out public network access configuration. $ref: '#/definitions/ActionType' firewallRules: description: Describe firewall rules of target service to make sure source application could connect to the target. $ref: '#/definitions/FirewallRules' OperationResultCollection: required: - value properties: value: type: array items: $ref: '#/definitions/OperationResult' nextlink: readOnly: true type: string description: Gets the URL to get the next set of results. Labels: description: List of Microsoft information protection sensitivity labels type: array items: $ref: '#/definitions/Label' ProviderConsentDefinition: type: object description: The provider consent. properties: consentToAuthorization: type: boolean description: A value indicating whether authorization is consented or not. ConsoleDefinition: description: Console definition type: object required: - properties properties: properties: $ref: '#/definitions/ConsoleCreateProperties' allOf: - $ref: '#/definitions/Resource_2' alertsList: type: object description: List the alerts. properties: nextLink: description: URL to fetch the next set of alerts. type: string value: description: List of alerts type: array items: $ref: '#/definitions/alert' Attestation: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/AttestationProperties' description: Properties for the attestation. systemData: readOnly: true type: object description: Azure Resource Manager metadata containing createdBy and modifiedBy information. $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/systemData allOf: - $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/Resource required: - properties description: An attestation resource. CloudShellUserSettings: description: Cloud shell user settings. type: object required: - properties properties: properties: $ref: '#/definitions/UserProperties' allOf: - $ref: '#/definitions/Resource_2' ExportStatus: description: The details of the export status. type: object properties: serviceId: description: The id of the service for whom the export status is being reported. type: string format: uuid serviceMemberId: description: The server Id for whom the export status is being reported. type: string format: uuid endTime: description: The date and time when the export ended. type: string format: date-time runStepResultId: description: The run step result Id. type: string Tag: description: The tag resource. properties: key: description: Tag key. type: string OperationListResult_2: title: Operations List. description: A list of operations supported by Microsoft.ManagedIdentity Resource Provider. properties: value: type: array items: $ref: '#/definitions/Operation_6' title: Operations List. description: A list of operations supported by Microsoft.ManagedIdentity Resource Provider. nextLink: type: string title: Next Link description: The url to get the next page of results, if any. RemediationFilters: properties: locations: type: array items: type: string description: The resource locations that will be remediated. description: The filters that will be applied to determine which resources to remediate. MetadataDocument: description: Metadata XML document. type: string TrackedResourceModificationDetails: type: object description: The details of the policy triggered deployment that created or modified the tracked resource. properties: policyDetails: $ref: '#/definitions/PolicyDetails' description: The details of the policy that created or modified the tracked resource. readOnly: true deploymentId: description: The ID of the deployment that created or modified the tracked resource. type: string readOnly: true deploymentTime: description: Timestamp of the deployment that created or modified the tracked resource. type: string format: date-time readOnly: true ConfigurationStore: type: object description: An option to store configuration into different place properties: appConfigurationId: x-nullable: true type: string description: The app configuration id to store configuration ConfigurationInfo: type: object description: The configuration information, used to generate configurations or save to applications properties: deleteOrUpdateBehavior: description: Indicates whether to clean up previous operation when Linker is updating or deleting $ref: '#/definitions/DeleteOrUpdateBehavior' action: description: Optional, indicate whether to apply configurations on source application. If enable, generate configurations and applied to the source application. Default is enable. If optOut, no configuration change will be made on source. $ref: '#/definitions/ActionType' customizedKeys: description: Optional. A dictionary of default key name and customized key name mapping. If not specified, default key name will be used for generate configurations type: object additionalProperties: type: string daprProperties: description: Indicates some additional properties for dapr client type $ref: '#/definitions/DaprProperties' additionalConfigurations: description: A dictionary of additional configurations to be added. Service will auto generate a set of basic configurations and this property is to full fill more customized configurations type: object additionalProperties: type: string additionalConnectionStringProperties: description: A dictionary of additional properties to be added in the end of connection string. type: object additionalProperties: type: string configurationStore: x-nullable: true description: An option to store configuration into different place $ref: '#/definitions/ConfigurationStore' MAMPolicyProperties: required: - friendlyName properties: friendlyName: type: string description: type: string appSharingFromLevel: type: string default: none enum: - none - policyManagedApps - allApps appSharingToLevel: type: string default: none enum: - none - policyManagedApps - allApps authentication: type: string default: required enum: - required - notRequired clipboardSharingLevel: type: string default: blocked enum: - blocked - policyManagedApps - policyManagedAppsWithPasteIn - allApps dataBackup: type: string default: allow enum: - allow - block fileSharingSaveAs: type: string default: allow enum: - allow - block pin: type: string default: required enum: - required - notRequired pinNumRetry: type: integer deviceCompliance: type: string default: enable enum: - enable - disable managedBrowser: type: string default: required enum: - required - notRequired accessRecheckOfflineTimeout: type: string format: duration accessRecheckOnlineTimeout: type: string format: duration offlineWipeTimeout: type: string format: duration numOfApps: type: integer readOnly: true groupStatus: readOnly: true type: string default: notTargeted enum: - notTargeted - targeted lastModifiedTime: type: string readOnly: true format: date-time Operation_2: type: object description: A REST API operation supported by the provider. properties: name: type: string description: Name of the operation. readOnly: true display: description: Displayable properties of the operation. $ref: '#/definitions/OperationDisplay_2' origin: type: string description: Origin of the operation. readOnly: true FlaggedEnrolledAppCollection: required: - value properties: value: type: array items: $ref: '#/definitions/FlaggedEnrolledApp' nextlink: readOnly: true type: string description: Gets the URL to get the next set of results. description: Flagged Enrolled App collection for the given tenant. TagProperties: description: The properties of the tag. properties: tags: description: A list of Tag. type: array items: $ref: '#/definitions/Tag' comments: type: object description: Change alert state reason properties: comments: type: string ComponentPolicyEvaluationDetails: type: object description: Policy evaluation details. properties: evaluatedExpressions: description: Details of the evaluated expressions. type: array readOnly: true items: $ref: '#/definitions/ComponentExpressionEvaluationDetails' x-ms-identifiers: [] reason: description: Additional textual reason for the evaluation outcome. type: string BuiltInInfoType: description: Pre-configured sensitive information type type: object properties: name: description: Display name of the info type type: string id: description: Id of the info type type: string format: uuid type: description: Category of the built-in info type type: string ActionDetail: description: The action detail type: object properties: mechanismType: type: string description: The mechanism type name: type: string description: The name of the action status: type: string description: The status of the action subState: type: string description: The substatus of the action sendTime: type: string description: The send time message: type: string description: The detail of the friendly error message AllowType: description: Whether to allow firewall rules. type: string enum: - 'true' - 'false' x-ms-enum: name: allowType modelAsString: true Context: description: The context info type: object properties: notificationSource: type: string description: The source of the notification request contextType: type: string description: The context id type ErrorResponse_5: description: Describes the format of Error response. type: object properties: code: description: Error code type: string message: description: Error message indicating why the operation failed. type: string ServiceSpecification: properties: logSpecifications: type: array items: $ref: '#/definitions/LogSpecification' x-ms-identifiers: - blobDuration - name description: List of log specifications. readOnly: true metricSpecifications: type: array items: $ref: '#/definitions/MetricSpecification' x-ms-identifiers: - name - unit description: List of metric specifications. readOnly: true type: object description: The service metric specifications. ComponentPolicyStatesQueryResults: type: object description: Query results. properties: '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string '@odata.count': description: OData entity count; represents the number of policy state records returned. type: integer format: int32 minimum: 0 value: description: Query results. type: array items: $ref: '#/definitions/ComponentPolicyState' x-ms-identifiers: [] ServiceProperties_3: description: Details about an Azure service available for support ticket creation. type: object properties: displayName: description: Localized name of the Azure service. type: string resourceTypes: description: ARM Resource types. type: array items: type: string TagsResource: type: object description: Wrapper resource for tags API requests and responses. required: - properties properties: id: readOnly: true type: string description: The ID of the tags wrapper resource. name: readOnly: true type: string description: The name of the tags wrapper resource. type: readOnly: true type: string description: The type of the tags wrapper resource. properties: $ref: '#/definitions/Tags' description: The set of tags. x-ms-azure-resource: true ErrorResponse_2: description: Describes the format of Error response. type: object properties: code: description: Error code type: string message: description: Error message indicating why the operation failed. type: string IOSMAMPolicyCollection: required: - value properties: value: type: array items: $ref: '#/definitions/iOSMAMPolicy' nextlink: readOnly: true type: string description: Gets the URL to get the next set of results. ErrorDefinition_2: type: object title: Error description: Error description and code explaining why an operation failed. properties: error: $ref: '#/definitions/ErrorDefinitionProperties' description: Error of the list gateway status. StorageProfile: description: The storage profile of the user settings. type: object properties: storageAccountResourceId: type: string description: Full resource ID of storage account. fileShareName: type: string description: Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and - diskSizeInGB: type: integer format: int32 description: Size of file share alertProperties: type: object description: Alert property bag properties: essentials: $ref: '#/definitions/essentials' context: $ref: '#/definitions/alertContext' egressConfig: $ref: '#/definitions/egressConfig' OperationDisplay_4: properties: provider: type: string description: The service provider. resource: type: string description: Resource on which the operation is performed. operation: type: string description: The operation type. description: type: string description: The operation description. type: object description: Operation details. alertEnrichmentsList: description: List the alert's enrichments. type: object properties: value: description: List the alert's enrichments type: array items: $ref: '#/definitions/alertEnrichmentResponse' nextLink: type: string description: Request URL that can be used to query next page. schema: type: object description: The schema object. properties: id: type: string description: ID associated with this schema connectionId: type: string description: Connection ID associated with this schema status: enum: - New - Approved type: string x-ms-enum: name: schemaStatus modelAsString: true description: Status of the schema name: type: string description: Name of the schema content: type: string description: Content of the schema WebhookReceiver: description: A webhook receiver. type: object properties: name: type: string description: The name of the webhook receiver. Names must be unique across all receivers within a tenant action group. serviceUri: type: string description: The URI where webhooks should be sent. useCommonAlertSchema: type: boolean default: false description: Indicates whether to use common alert schema. useAadAuth: type: boolean default: false description: Indicates whether or not use AAD authentication. objectId: type: string description: Indicates the webhook app object Id for aad auth. identifierUri: type: string description: Indicates the identifier uri for aad auth. tenantId: type: string description: Indicates the tenant id for aad auth. required: - name - serviceUri CloudError: x-ms-external: true properties: error: description: A list of additional details about the error. $ref: '#/definitions/CloudErrorBody' description: An error response from the ManagedServiceIdentity service. schemas: type: array description: The schemas for this connection x-ms-identifiers: - connectionId - name items: $ref: '#/definitions/schema' LinkerResource: type: object description: Linker of source and target resource allOf: - $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource description: The resource model definition for an Azure Resource Manager proxy resource. required: - properties properties: properties: description: The properties of the Linker. $ref: '#/definitions/LinkerProperties' x-ms-client-flatten: true systemData: x-nullable: true readOnly: true $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData description: The system data. FlaggedUser: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/FlaggedUserProperties' allOf: - $ref: '#/definitions/Resource_4' description: Flagged user for the given tenant. PolicyMetadataCollection: description: Collection of policy metadata resources. properties: value: description: Array of policy metadata definitions. type: array items: $ref: '#/definitions/SlimPolicyMetadata' readOnly: true nextLink: type: string description: The URL to get the next set of results. readOnly: true RemediationDeploymentsListResult: description: List of deployments for a remediation. properties: value: description: Array of deployments for the remediation. type: array items: $ref: '#/definitions/RemediationDeployment' readOnly: true nextLink: type: string description: The URL to get the next set of results. readOnly: true ComponentPolicyState: type: object description: Component Policy State record. properties: '@odata.id': description: OData entity ID; always set to null since component policy state records do not have an entity ID. type: string readOnly: true '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string readOnly: true timestamp: description: Timestamp for the component policy state record. type: string format: date-time readOnly: true componentId: description: Component Id. type: string readOnly: true componentType: description: Component type. type: string readOnly: true componentName: description: Component name. type: string readOnly: true resourceId: description: Resource ID. type: string readOnly: true policyAssignmentId: description: Policy assignment ID. type: string readOnly: true policyDefinitionId: description: Policy definition ID. type: string readOnly: true subscriptionId: description: Subscription ID. type: string readOnly: true resourceType: description: Resource type. type: string readOnly: true resourceLocation: description: Resource location. type: string readOnly: true resourceGroup: description: Resource group name. type: string readOnly: true policyAssignmentName: description: Policy assignment name. type: string readOnly: true policyAssignmentOwner: description: Policy assignment owner. type: string readOnly: true policyAssignmentParameters: description: Policy assignment parameters. type: string readOnly: true policyAssignmentScope: description: Policy assignment scope. type: string readOnly: true policyDefinitionName: description: Policy definition name. type: string readOnly: true policyDefinitionAction: description: Policy definition action, i.e. effect. type: string readOnly: true policyDefinitionCategory: description: Policy definition category. type: string readOnly: true policySetDefinitionId: description: Policy set definition ID, if the policy assignment is for a policy set. type: string readOnly: true policySetDefinitionName: description: Policy set definition name, if the policy assignment is for a policy set. type: string readOnly: true policySetDefinitionOwner: description: Policy set definition owner, if the policy assignment is for a policy set. type: string readOnly: true policySetDefinitionCategory: description: Policy set definition category, if the policy assignment is for a policy set. type: string readOnly: true policySetDefinitionParameters: description: Policy set definition parameters, if the policy assignment is for a policy set. type: string readOnly: true policyDefinitionReferenceId: description: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set. type: string readOnly: true complianceState: description: Compliance state of the resource. type: string readOnly: true policyEvaluationDetails: description: Policy evaluation details. This is only included in the response if the request contains $expand=PolicyEvaluationDetails. type: object $ref: '#/definitions/ComponentPolicyEvaluationDetails' policyDefinitionGroupNames: description: Policy definition group names. type: array items: type: string readOnly: true policyDefinitionVersion: description: Evaluated policy definition version. type: string readOnly: true policySetDefinitionVersion: description: Evaluated policy set definition version. type: string readOnly: true policyAssignmentVersion: description: Evaluated policy assignment version. type: string readOnly: true additionalProperties: description: The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated Tags: description: A dictionary of name and value pairs. properties: tags: type: object additionalProperties: type: string description: The tag value. MetricDimension: properties: name: type: string description: The metric dimension name. readOnly: true displayName: type: string description: The display name for the dimension. readOnly: true toBeExportedForShoebox: type: boolean description: Whether to export metric to shoebox. readOnly: true x-nullable: false type: object description: A metric dimension. operationMetadataProperties: required: - name - value properties: name: type: string value: type: string ErrorDefinition_3: description: Error definition. properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: Description of the error. type: string readOnly: true target: description: The target of the error. type: string readOnly: true details: description: Internal error details. type: array items: $ref: '#/definitions/ErrorDefinition_3' readOnly: true additionalInfo: description: Additional scenario specific error details. type: array items: $ref: '#/definitions/TypedErrorInfo' readOnly: true Operation_5: type: object description: The Connected cluster API operation properties: name: readOnly: true type: string description: 'Operation name: {Microsoft.Kubernetes}/{resource}/{operation}' display: type: object readOnly: true description: The object that represents the operation. properties: provider: type: string description: 'Service provider: Microsoft.connectedClusters' resource: type: string description: Connected Cluster Resource on which the operation is performed operation: type: string description: 'Operation type: Read, write, delete, etc.' description: type: string description: Description of the operation. ProviderListResult: properties: value: type: array items: $ref: '#/definitions/Provider' description: An array of resource providers. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of resource providers. Error: required: - code - message properties: code: type: string message: type: string AzureResource_2: description: An Azure resource object. x-ms-azure-resource: true type: object properties: id: description: The resource Id. type: string readOnly: true name: description: The name of the resource. type: string readOnly: true type: description: The type of the resource. type: string readOnly: true location: description: The location of the resource. Since Azure Activity Log Alerts is a global service, the location of the rules should always be 'global'. type: string default: global x-ms-mutability: - read - create tags: description: The tags of the resource. type: object additionalProperties: type: string ErrorDefinitionProperties: type: object title: Error description: Error description and code explaining why an operation failed. properties: message: type: string readOnly: true description: Description of the error. code: type: string description: Error code of list gateway. alertContext: type: object description: Information specific to the monitor service that gives more contextual details about the alert. readOnly: true CarbonEmissionDataListResult: type: object description: List of carbon emission results properties: value: type: array description: The CarbonEmissionData items on this page items: $ref: '#/definitions/CarbonEmissionData' x-ms-identifiers: [] skipToken: type: string description: The number of result items to skip for next page nextLink: type: string description: The link to the next page of items subscriptionAccessDecisionList: type: array description: 'The access decision list for each input subscription ' items: $ref: '#/definitions/SubscriptionAccessDecision' x-ms-identifiers: [] required: - value OperationListResult: description: The result of a request to list Microsoft.Authorization operations. type: object properties: value: description: The collection value. type: array items: $ref: '#/definitions/Operation' x-ms-identifiers: - name nextLink: description: The URI that can be used to request the next set of paged results. type: string actionStatus: type: object description: Action status properties: isSuppressed: type: boolean description: Value indicating whether alert is suppressed. PolicyEvent: type: object description: Policy event record. properties: '@odata.id': description: OData entity ID; always set to null since policy event records do not have an entity ID. type: string '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string timestamp: description: Timestamp for the policy event record. type: string format: date-time resourceId: description: Resource ID. type: string policyAssignmentId: description: Policy assignment ID. type: string policyDefinitionId: description: Policy definition ID. type: string effectiveParameters: description: Effective parameters for the policy assignment. type: string isCompliant: description: Flag which states whether the resource is compliant against the policy assignment it was evaluated against. type: boolean subscriptionId: description: Subscription ID. type: string resourceType: description: Resource type. type: string resourceLocation: description: Resource location. type: string resourceGroup: description: Resource group name. type: string resourceTags: description: List of resource tags. type: string policyAssignmentName: description: Policy assignment name. type: string policyAssignmentOwner: description: Policy assignment owner. type: string policyAssignmentParameters: description: Policy assignment parameters. type: string policyAssignmentScope: description: Policy assignment scope. type: string policyDefinitionName: description: Policy definition name. type: string policyDefinitionAction: description: Policy definition action, i.e. effect. type: string policyDefinitionCategory: description: Policy definition category. type: string policySetDefinitionId: description: Policy set definition ID, if the policy assignment is for a policy set. type: string policySetDefinitionName: description: Policy set definition name, if the policy assignment is for a policy set. type: string policySetDefinitionOwner: description: Policy set definition owner, if the policy assignment is for a policy set. type: string policySetDefinitionCategory: description: Policy set definition category, if the policy assignment is for a policy set. type: string policySetDefinitionParameters: description: Policy set definition parameters, if the policy assignment is for a policy set. type: string managementGroupIds: description: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under. type: string policyDefinitionReferenceId: description: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set. type: string tenantId: description: Tenant ID for the policy event record. type: string principalOid: description: Principal object ID for the user who initiated the resource operation that triggered the policy event. type: string additionalProperties: description: The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated listApprovedSchemasRequest: type: object properties: pipeline: type: string description: The name of the pipeline to filter approved schemas. direction: description: The direction pipeline to filter approved schemas. enum: - Send - Receive type: string x-ms-enum: name: listApprovedSchemasDirection modelAsString: true TenantActionGroupList: description: A list of tenant action groups. type: object properties: value: type: array items: $ref: '#/definitions/TenantActionGroupResource' description: The list of tenant action groups. nextLink: type: string description: Provides the link to retrieve the next set of elements. MergedExportErrors: description: The list of export errors. type: object properties: value: description: The value returned by the operation. type: array items: $ref: '#/definitions/MergedExportError' operationsList_2: description: Lists the operations available. type: object properties: nextLink: description: Url to follow for getting next page of operations. type: string value: description: Array of operations uniqueItems: false type: array items: $ref: '#/definitions/operation_2' x-ms-identifiers: [] required: - value SlimPolicyMetadata: description: Slim version of policy metadata resource definition, excluding properties with large strings properties: properties: x-ms-client-flatten: true $ref: '#/definitions/PolicyMetadataSlimProperties' description: Properties of the policy metadata. id: type: string description: The ID of the policy metadata. readOnly: true type: type: string description: The type of the policy metadata. readOnly: true name: type: string description: The name of the policy metadata. readOnly: true alertModificationItem: type: object description: Alert modification item. properties: modificationEvent: type: string description: Reason for the modification enum: - AlertCreated - StateChange - MonitorConditionChange - SeverityChange - ActionRuleTriggered - ActionRuleSuppressed - ActionsTriggered - ActionsSuppressed - ActionsFailed x-ms-enum: name: AlertModificationEvent oldValue: type: string description: Old value newValue: type: string description: New value modifiedAt: type: string description: Modified date and time modifiedBy: type: string description: Modified user details (Principal client name) comments: type: string description: Modification comments description: type: string description: Description of the modification Remediation: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/RemediationProperties' description: Properties for the remediation. id: type: string description: The ID of the remediation. readOnly: true type: type: string description: The type of the remediation. readOnly: true name: type: string description: The name of the remediation. readOnly: true description: The remediation definition. x-ms-azure-resource: true CloudError_3: x-ms-external: true properties: error: $ref: ../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse description: An error response for a resource management request. AndroidMAMPolicyProperties: allOf: - $ref: '#/definitions/MAMPolicyProperties' properties: screenCapture: type: string default: allow enum: - allow - block fileEncryption: type: string default: required enum: - required - notRequired description: Intune MAM iOS Policy Properties. alertModification: type: object description: Alert Modification details allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/alertModificationProperties' ZoneMapping: type: object properties: location: type: string description: The location of the zone mapping. zones: type: array items: type: string ExportStatuses: description: The list of export statuses. type: object properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The value returned by the operation. type: array items: $ref: '#/definitions/ExportStatus' totalCount: description: The total count of service elements. type: integer continuationToken: description: The continuation token for paginated calls. type: string Alias: properties: name: type: string description: The alias name. paths: type: array items: $ref: '#/definitions/AliasPath' x-ms-identifiers: [] description: The paths for an alias. type: type: string description: The type of the alias. enum: - NotSpecified - PlainText - Mask x-ms-enum: name: AliasType modelAsString: false values: - value: NotSpecified description: Alias type is unknown (same as not providing alias type). - value: PlainText description: Alias value is not secret. - value: Mask description: Alias value is secret. defaultPath: type: string description: The default path for an alias. defaultPattern: $ref: '#/definitions/AliasPattern' description: The default pattern for an alias. defaultMetadata: readOnly: true $ref: '#/definitions/AliasPathMetadata' description: The default alias path metadata. Applies to the default path and to any alias path that doesn't have metadata description: 'The alias type. ' SecretStore: type: object description: An option to store secret value in secure place properties: keyVaultId: x-nullable: true type: string description: The key vault id to store secret keyVaultSecretName: x-nullable: true type: string description: The key vault secret name to store secret, only valid when storing one secret GuestDiagnosticSettingsAssociationResourcePatch: description: Guest diagnostic setting resource for patch operations properties: tags: additionalProperties: type: string description: Resource tags properties: x-ms-client-flatten: true $ref: '#/definitions/GuestDiagnosticSettingsAssociation' description: The service diagnostics settings for an update operation. PolicyAssignmentSummary: description: Policy assignment summary. properties: policyAssignmentId: description: Policy assignment ID. type: string policySetDefinitionId: description: Policy set definition ID, if the policy assignment is for a policy set. type: string results: description: Non-compliance summary for the policy assignment. $ref: '#/definitions/SummaryResults' policyDefinitions: description: Policy definitions summary. type: array items: $ref: '#/definitions/PolicyDefinitionSummary' DaprProperties: type: object description: Indicates some additional properties for dapr client type properties: version: x-nullable: true type: string description: The dapr component version componentType: x-nullable: true type: string description: The dapr component type secretStoreComponent: x-nullable: true type: string description: The name of a secret store dapr to retrieve secret metadata: description: Additional dapr metadata type: array items: $ref: '#/definitions/DaprMetadata' x-ms-identifiers: - name scopes: description: The dapr component scopes type: array items: type: string runtimeVersion: x-nullable: true type: string readOnly: true description: The runtime version supported by the properties bindingComponentDirection: x-nullable: true type: string enum: - input - output x-ms-enum: name: DaprBindingComponentDirection modelAsString: true readOnly: true description: The direction supported by the dapr binding component TenantNotificationRequestBody: description: The request body which contain contact detail metadata type: object properties: alertType: type: string maxLength: 30 description: 'The value of the supported alert type. Supported alert type value is: servicehealth' emailReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/EmailReceiver' description: The list of email receivers that are part of this action group. smsReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/SmsReceiver' description: The list of SMS receivers that are part of this action group. webhookReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/WebhookReceiver' description: The list of webhook receivers that are part of this action group. azureAppPushReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/AzureAppPushReceiver' description: The list of AzureAppPush receivers that are part of this action group. voiceReceivers: x-ms-identifiers: [] type: array items: $ref: '#/definitions/VoiceReceiver' description: The list of voice receivers that are part of this action group. required: - alertType ProviderPermissionListResult: properties: value: type: array items: $ref: '#/definitions/ProviderPermission' x-ms-identifiers: [] description: An array of provider permissions. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of provider permissions. ClientType: description: The application client type type: string enum: - none - dotnet - java - python - go - php - ruby - django - nodejs - springBoot - kafka-springBoot - jms-springBoot - dapr x-ms-enum: name: clientType modelAsString: true Resource: type: object x-ms-azure-resource: true description: An azure resource object properties: id: type: string readOnly: true description: Azure resource Id type: type: string readOnly: true description: Azure resource type name: type: string readOnly: true description: Azure resource name ProviderResourceTypeListResult: properties: value: type: array items: $ref: '#/definitions/ProviderResourceType' x-ms-identifiers: - resourceType description: An array of resource types. nextLink: readOnly: true type: string description: The URL to use for getting the next set of results. description: List of resource types of a resource provider. Operation_10: description: Operation provided by provider properties: display: description: Properties of the operation properties: description: description: Description of the operation type: string operation: description: Operation name type: string provider: description: Provider name type: string resource: description: Resource name type: string type: object name: description: Name of the operation type: string origin: description: The origin of the operation type: string isDataAction: description: Indicates whether the operation is a data action type: boolean type: object Operation_11: title: Operation supported by the resource provider. type: object readOnly: true required: - name - display - origin properties: name: description: The name of the operation being performed on this particular object. type: string example: Microsoft.WorkloadMonitor/monitors/read display: description: The localized display information for this particular operation or action. type: object required: - provider - resource - operation - description properties: provider: description: Operation resource provider name. type: string example: Microsoft.WorkloadMonitor resource: description: Resource on which the operation is performed. type: string example: Monitors operation: description: Human-readable, friendly name for the operation. type: string example: Get monitors description: description: Operation description. type: string example: Gets monitors and their current health state origin: description: The intended executor of the operation. type: string example: user, system Services: description: The list of services for a given onboarded tenant. type: object properties: nextLink: description: The link used to get the next page of operations. type: string value: description: The value returned by the operation. type: array items: $ref: '#/definitions/ServiceProperties' totalCount: description: The total count of service elements. type: integer continuationToken: description: The continuation token for paginated calls. type: string ErrorCounts: description: The list of error counts. type: object properties: value: description: The value returned by the operation. type: array items: $ref: '#/definitions/ErrorCount' LocationProperties: required: - hostName properties: hostName: type: string StatusesDefault: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/StatusesProperties' allOf: - $ref: '#/definitions/Resource_4' description: Default Statuses entity for the given tenant. AliasPattern: properties: phrase: type: string description: The alias pattern phrase. variable: type: string description: The alias pattern variable. type: type: string enum: - NotSpecified - Extract x-ms-enum: name: AliasPatternType modelAsString: false values: - value: NotSpecified description: NotSpecified is not allowed. - value: Extract description: Extract is the only allowed value. description: The type of alias pattern description: The type of the pattern for an alias path. DeviceCollection: required: - value properties: value: type: array items: $ref: '#/definitions/Device' nextlink: readOnly: true type: string description: Gets the URL to get the next set of results. AlertRuleProperties: description: An Azure Activity Log Alert rule. type: object properties: tenantScope: description: The tenant GUID. Must be provided for tenant-level and management group events rules. type: string scopes: description: A list of resource IDs that will be used as prefixes. The alert will only apply to Activity Log events with resource IDs that fall under one of these prefixes. This list must include at least one item. type: array items: type: string condition: description: The condition that will cause this alert to activate. $ref: '#/definitions/AlertRuleAllOfCondition' actions: description: The actions that will activate when the condition is met. $ref: '#/definitions/ActionList' enabled: description: Indicates whether this Activity Log Alert rule is enabled. If an Activity Log Alert rule is not enabled, then none of its actions will be activated. type: boolean default: true description: description: A description of this Activity Log Alert rule. type: string required: - condition - actions GroupItem: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/GroupProperties' allOf: - $ref: '#/definitions/Resource_4' description: Group entity for Intune MAM. AuthType: description: The authentication type. type: string enum: - systemAssignedIdentity - userAssignedIdentity - servicePrincipalSecret - servicePrincipalCertificate - secret - accessKey - userAccount - easyAuthMicrosoftEntraID x-ms-enum: name: AuthType modelAsString: true RemediationProperties: properties: policyAssignmentId: type: string description: The resource ID of the policy assignment that should be remediated. policyDefinitionReferenceId: type: string description: The policy definition reference ID of the individual definition that should be remediated. Required when the policy assignment being remediated assigns a policy set definition. provisioningState: type: string description: The status of the remediation. readOnly: true createdOn: type: string format: date-time description: The time at which the remediation was created. readOnly: true lastUpdatedOn: type: string format: date-time description: The time at which the remediation was last updated. readOnly: true filters: $ref: '#/definitions/RemediationFilters' description: The filters that will be applied to determine which resources to remediate. deploymentStatus: $ref: '#/definitions/RemediationDeploymentSummary' description: The deployment status summary for all deployments created by the remediation. description: The remediation properties. PolicyMetadataSlimProperties: description: The properties of the policy metadata, excluding properties containing large strings properties: metadataId: description: The policy metadata identifier. type: string readOnly: true category: description: The category of the policy metadata. type: string readOnly: true title: description: The title of the policy metadata. type: string readOnly: true owner: description: The owner of the policy metadata. type: string readOnly: true additionalContentUrl: description: Url for getting additional content about the resource metadata. type: string readOnly: true metadata: description: Additional metadata. type: object readOnly: true Label: description: Microsoft information protection sensitivity label type: object properties: name: type: string description: The display name of the label id: type: string description: The ID of the label format: uuid order: type: number description: Labels are ordered by sensitivity level. The higher the order of the label, the more sensitive it is. ApplicationProperties: required: - friendlyName - platform properties: friendlyName: type: string platform: type: string default: ios enum: - ios - android - windows appId: type: string TagsPatchResource: type: object description: Wrapper resource for tags patch API request only. properties: operation: type: string description: The operation type for the patch API. enum: - Replace - Merge - Delete x-ms-enum: name: tagsPatchOperation modelAsString: true values: - value: Replace description: The 'replace' option replaces the entire set of existing tags with a new set. - value: Merge description: The 'merge' option allows adding tags with new names and updating the values of tags with existing names. - value: Delete description: The 'delete' option allows selectively deleting tags based on given names or name/value pairs. properties: $ref: '#/definitions/Tags' description: The set of tags. Application: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/ApplicationProperties' allOf: - $ref: '#/definitions/Resource_4' description: Application entity for Intune MAM. FlaggedEnrolledApp: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/FlaggedEnrolledAppProperties' allOf: - $ref: '#/definitions/Resource_4' description: Flagged Enrolled App for the given tenant. VoiceReceiver: description: A voice receiver. type: object properties: name: type: string description: The name of the voice receiver. Names must be unique across all receivers within a tenant action group. countryCode: type: string description: The country code of the voice receiver. phoneNumber: type: string description: The phone number of the voice receiver. required: - name - countryCode - phoneNumber FlaggedUserProperties: properties: errorCount: type: integer readOnly: true friendlyName: type: string readOnly: true operationsList: type: object description: Lists the operations available in the AlertsManagement RP. properties: nextLink: description: URL to fetch the next set of alerts. type: string value: description: Array of operations type: array items: $ref: '#/definitions/operation' x-ms-identifiers: [] required: - value Operation_6: title: Microsoft.ManagedIdentity Operation. description: Operation supported by the Microsoft.ManagedIdentity REST API. type: object properties: name: title: Operation Name. description: The name of the REST Operation. This is of the format {provider}/{resource}/{operation}. type: string display: title: Operation Display. description: The object that describes the operation. $ref: '#/definitions/OperationDisplay_5' PolicyEventsQueryResults: description: Query results. properties: '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string '@odata.count': description: OData entity count; represents the number of policy event records returned. type: integer format: int32 minimum: 0 '@odata.nextLink': description: Odata next link; URL to get the next set of results. type: string value: description: Query results. type: array items: $ref: '#/definitions/PolicyEvent' TenantActionGroup: description: A tenant action group. type: object properties: groupShortName: type: string maxLength: 12 description: The short name of the action group. This will be used in SMS messages. enabled: type: boolean default: true description: Indicates whether this tenant action group is enabled. If a tenant action group is not enabled, then none of its receivers will receive communications. emailReceivers: x-ms-identifiers: - emailAddress type: array items: $ref: '#/definitions/EmailReceiver' description: The list of email receivers that are part of this tenant action group. smsReceivers: x-ms-identifiers: - phoneNumber type: array items: $ref: '#/definitions/SmsReceiver' description: The list of SMS receivers that are part of this tenant action group. webhookReceivers: x-ms-identifiers: - name type: array items: $ref: '#/definitions/WebhookReceiver' description: The list of webhook receivers that are part of this tenant action group. azureAppPushReceivers: x-ms-identifiers: - emailAddress type: array items: $ref: '#/definitions/AzureAppPushReceiver' description: The list of AzureAppPush receivers that are part of this tenant action group. voiceReceivers: x-ms-identifiers: - phoneNumber type: array items: $ref: '#/definitions/VoiceReceiver' description: The list of voice receivers that are part of this tenant action group. required: - groupShortName - enabled Resource_4: x-ms-azure-resource: true properties: id: readOnly: true type: string description: Resource Id name: readOnly: true type: string description: Resource name type: readOnly: true type: string description: Resource type tags: type: object additionalProperties: type: string description: Resource Tags location: type: string description: Resource Location ServiceResourceListResult: type: object description: The response of a ServiceResource list operation. properties: value: type: array description: The ServiceResource items on this page items: $ref: '#/definitions/ServiceResource' nextLink: type: string format: uri description: The link to the next page of items required: - value PolicyDefinitionSummary: description: Policy definition summary. properties: policyDefinitionId: description: Policy definition ID. type: string policyDefinitionReferenceId: description: Policy definition reference ID. type: string effect: description: Policy effect, i.e. policy definition action. type: string results: description: Non-compliance summary for the policy definition. $ref: '#/definitions/SummaryResults' ErrorDetail: title: ErrorDetail type: object properties: code: description: The error's code. type: string message: description: A human readable error message. type: string required: - code - message essentials: type: object description: This object contains consistent fields across different monitor services. properties: severity: type: string description: Severity of alert Sev0 being highest and Sev4 being lowest. readOnly: true enum: - Sev0 - Sev1 - Sev2 - Sev3 - Sev4 x-ms-enum: name: Severity modelAsString: true signalType: type: string description: The type of signal the alert is based on, which could be metrics, logs or activity logs. readOnly: true enum: - Metric - Log - Unknown x-ms-enum: name: SignalType modelAsString: true alertState: type: string description: Alert object state, which can be modified by the user. readOnly: true enum: - New - Acknowledged - Closed x-ms-enum: name: AlertState modelAsString: true monitorCondition: type: string description: Condition of the rule at the monitor service. It represents whether the underlying conditions have crossed the defined alert rule thresholds. readOnly: true enum: - Fired - Resolved x-ms-enum: name: MonitorCondition modelAsString: true targetResource: type: string description: Target ARM resource, on which alert got created. targetResourceName: type: string description: Name of the target ARM resource name, on which alert got created. targetResourceGroup: type: string description: Resource group of target ARM resource, on which alert got created. targetResourceType: type: string description: Resource type of target ARM resource, on which alert got created. monitorService: type: string description: Monitor service on which the rule(monitor) is set. readOnly: true enum: - Application Insights - ActivityLog Administrative - ActivityLog Security - ActivityLog Recommendation - ActivityLog Policy - ActivityLog Autoscale - Log Analytics - Nagios - Platform - SCOM - ServiceHealth - SmartDetector - VM Insights - Zabbix - Resource Health x-ms-enum: name: MonitorService modelAsString: true alertRule: type: string description: Rule(monitor) which fired alert instance. Depending on the monitor service, this would be ARM id or name of the rule. readOnly: true sourceCreatedId: type: string description: Unique Id created by monitor service for each alert instance. This could be used to track the issue at the monitor service, in case of Nagios, Zabbix, SCOM etc. readOnly: true smartGroupId: type: string description: Unique Id of the smart group readOnly: true smartGroupingReason: type: string description: Verbose reason describing the reason why this alert instance is added to a smart group readOnly: true startDateTime: type: string format: date-time description: Creation time(ISO-8601 format) of alert instance. readOnly: true lastModifiedDateTime: type: string format: date-time description: Last modification time(ISO-8601 format) of alert instance. readOnly: true monitorConditionResolvedDateTime: type: string format: date-time description: Resolved time(ISO-8601 format) of alert instance. This will be updated when monitor service resolves the alert instance because the rule condition is no longer met. readOnly: true lastModifiedUserName: type: string description: User who last modified the alert, in case of monitor service updates user would be 'system', otherwise name of the user. readOnly: true actionStatus: $ref: '#/definitions/actionStatus' description: type: string description: Alert description. hasEnrichments: type: boolean description: Will be presented with the value true only if there are enrichments. readOnly: true isStatefulAlert: type: boolean description: True if the alert is stateful, and false if it isn't. readOnly: true correlationDetails: $ref: '#/definitions/correlationDetails' TenantActivityLogAlertResource: type: object description: A Tenant Activity Log Alert rule resource. required: - properties allOf: - $ref: '#/definitions/AzureResource_2' properties: properties: description: The Activity Log Alert rule properties of the resource. x-ms-client-flatten: true $ref: '#/definitions/AlertRuleProperties' PolicyEvaluationDetails: type: object description: Policy evaluation details. properties: evaluatedExpressions: description: Details of the evaluated expressions. type: array items: $ref: '#/definitions/ExpressionEvaluationDetails' ifNotExistsDetails: description: Evaluation details of IfNotExists effect. type: object $ref: '#/definitions/IfNotExistsEvaluationDetails' DeviceProperties: required: - userId - friendlyName - platform - platformVersion - deviceType properties: userId: type: string friendlyName: type: string platform: type: string platformVersion: type: string deviceType: type: string GetSensitivitySettingsListResponse: type: object description: A list with a single sensitivity settings resource properties: value: type: array items: $ref: '#/definitions/GetSensitivitySettingsResponse' ErrorCount: description: The error count details. type: object properties: errorBucket: description: The error bucket. type: string count: description: The error count. type: integer truncated: description: Indicates if the error count is truncated or not. type: boolean SourceControl: description: The source control OAuth token. type: object allOf: - $ref: ./CommonDefinitions.json#/definitions/ProxyOnlyResource properties: properties: description: SourceControl resource specific properties type: object properties: token: description: OAuth access token. type: string tokenSecret: description: OAuth access token secret. type: string refreshToken: description: OAuth refresh token. type: string expirationTime: format: date-time description: OAuth token expiration. type: string x-ms-client-flatten: true DaprMetadata: description: The dapr component metadata. type: object properties: name: description: Metadata property name. type: string value: description: Metadata property value. type: string secretRef: description: The secret name where dapr could get value type: string description: description: The description of the metadata, returned from configuration api type: string required: description: The value indicating whether the metadata is required or not type: string enum: - 'true' - 'false' x-ms-enum: name: DaprMetadataRequired modelAsString: true Device: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/DeviceProperties' allOf: - $ref: '#/definitions/Resource_4' description: Device entity for Intune. AlertRuleLeafCondition: description: 'An Activity Log Alert rule condition that is met by comparing the field and value of an Activity Log event. This condition must contain ''field'' and either ''equals'' or ''containsAny''.' type: object properties: field: description: 'The name of the Activity Log event''s field that this condition will examine. The possible values for this field are (case-insensitive): ''resourceId'', ''category'', ''caller'', ''level'', ''operationName'', ''resourceGroup'', ''resourceProvider'', ''status'', ''subStatus'', ''resourceType'', or anything beginning with ''properties''.' type: string equals: description: The value of the event's field will be compared to this value (case-insensitive) to determine if the condition is met. type: string containsAny: description: The value of the event's field will be compared to the values in this array (case-insensitive) to determine if the condition is met. type: array items: type: string QueryFilter: type: object description: Query filter parameter specified by users properties: reportType: type: string description: Report type dateRange: $ref: '#/definitions/DateRange' description: The start date and end date for carbon emissions data subscriptionList: type: array description: SubscriptionId list for carbon emissions data items: type: string x-ms-identifiers: [] resourceGroupUrlList: type: array description: resourceGroupUrl list for carbon emissions data items: type: string x-ms-identifiers: [] resourceTypeList: type: array description: resource type list for carbon emissions data items: type: string x-ms-identifiers: [] locationList: type: array description: Location list for carbon emissions data items: type: string x-ms-identifiers: [] carbonScopeList: type: array description: Carbon emission scope for carbon emissions data items: $ref: '#/definitions/EmissionScopeEnum' x-ms-identifiers: [] discriminator: reportType required: - reportType - dateRange - subscriptionList - carbonScopeList ActionGroup: type: object description: A pointer to an Azure Action Group. properties: actionGroupId: description: The resource ID of the Action Group. This cannot be null or empty. type: string webhookProperties: type: object description: the dictionary of custom properties to include with the post operation. These data are appended to the webhook payload. additionalProperties: type: string actionProperties: type: object additionalProperties: type: string description: Predefined list of properties and configuration items for the action group. required: - actionGroupId LocationCollection: required: - value properties: value: type: array items: $ref: '#/definitions/Location' nextlink: readOnly: true type: string description: Gets the URL to get the next set of results. WipeDeviceOperationResult: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/WipeDeviceOperationResultProperties' allOf: - $ref: '#/definitions/Resource_4' description: Device entity for Intune. MAMPolicyAppIdOrGroupIdPayload: properties: properties: $ref: '#/definitions/MAMPolicyAppOrGroupIdProperties' description: MAM Policy request body for properties Intune MAM. ProviderPermission: type: object description: The provider permission properties: applicationId: type: string description: The application id. roleDefinition: $ref: '#/definitions/RoleDefinition' description: Role definition properties. managedByRoleDefinition: $ref: '#/definitions/RoleDefinition' description: Role definition properties. providerAuthorizationConsentState: type: string enum: - NotSpecified - Required - NotRequired - Consented description: The provider authorization consent state. x-ms-enum: name: ProviderAuthorizationConsentState modelAsString: true CloudErrorBody: x-ms-external: true properties: code: type: string description: An identifier for the error. message: type: string description: A message describing the error, intended to be suitable for display in a user interface. target: type: string description: The target of the particular error. For example, the name of the property in error. details: type: array items: $ref: '#/definitions/CloudErrorBody' description: A list of additional details about the error. description: An error response from the ManagedServiceIdentity service. ApplicationCollection: required: - value properties: value: type: array items: $ref: '#/definitions/Application' nextlink: readOnly: true type: string description: Gets the URL to get the next set of results. alertEnrichmentItem: type: object description: Alert enrichment item. discriminator: type required: - title - description - status - type properties: title: type: string description: The enrichment title. description: type: string description: The enrichment description. status: type: string description: The status of the evaluation of the enrichment. enum: - Succeeded - Failed x-ms-enum: name: status modelAsString: true errorMessage: type: string description: The error message. Will be present only if the status is 'Failed'. type: type: string description: The enrichment type. enum: - PrometheusInstantQuery - PrometheusRangeQuery x-ms-enum: name: type modelAsString: true OperationList_2: title: List of available REST API operations type: object readOnly: true properties: value: description: Array of available REST API operations. type: array items: $ref: '#/definitions/Operation_11' x-ms-identifiers: - name nextLink: description: Link to next page if the list is too long. type: string ProviderExtendedLocation: properties: location: type: string description: The azure location. type: type: string description: The extended location type. extendedLocations: type: array items: type: string description: The extended locations for the azure location. description: 'The provider extended location. ' SubscriptionAccessDecision: type: object description: Access Decision for each Subscription properties: subscriptionId: type: string description: Id of Subscription decision: $ref: '#/definitions/AccessDecisionEnum' description: Access decision to subscription required: - subscriptionId - decision AuthInfoBase: description: The authentication info discriminator: authType type: object properties: authType: description: The authentication type. $ref: '#/definitions/AuthType' authMode: description: Optional. Indicates how to configure authentication. If optInAllAuth, service linker configures authentication such as enabling identity on source resource and granting RBAC roles. If optOutAllAuth, opt out authentication setup. Default is optInAllAuth. $ref: '#/definitions/AuthMode' required: - authType FirewallRules: type: object description: Target service's firewall rules. to allow connections from source service. properties: ipRanges: type: array items: type: string description: This value specifies the set of IP addresses or IP address ranges in CIDR form to be included as the allowed list of client IPs for a given database account. azureServices: description: Allow Azure services to access the target service if true. $ref: '#/definitions/AllowType' callerClientIP: description: Allow caller client IP to access the target service if true. the property is used when connecting local application to target service. $ref: '#/definitions/AllowType' AttestationEvidence: properties: description: type: string description: The description for this piece of evidence. sourceUri: type: string description: The URI location of the evidence. description: A piece of evidence supporting the compliance state set in the attestation. AndroidMAMPolicyCollection: required: - value properties: value: type: array items: $ref: '#/definitions/AndroidMAMPolicy' nextlink: readOnly: true type: string description: Gets the URL to get the next set of results. RemediationDeploymentSummary: properties: totalDeployments: type: integer description: The number of deployments required by the remediation. successfulDeployments: type: integer description: The number of deployments required by the remediation that have succeeded. failedDeployments: type: integer description: The number of deployments required by the remediation that have failed. description: The deployment status summary for all deployments created by the remediation. correlationDetails: type: object description: Correlation details properties: parentAlertId: type: string description: Unique Id (GUID) of the alert that this alert was correlated to. readOnly: true correlationDateTime: description: The alert's correlation date time in ISO-8601 format. type: string format: date-time readOnly: true alertProcessingRule: type: string description: The alert processing rule that was used to correlate this alert. This is an optional field, it will be presented only for a parent alert. readOnly: true egressConfig: type: object description: Config which would be used for displaying the data in portal. readOnly: true alertsMetaDataProperties: type: object description: alert meta data property bag discriminator: metadataIdentifier required: - metadataIdentifier properties: metadataIdentifier: type: string description: Identification of the information to be retrieved by API call enum: - MonitorServiceList x-ms-enum: name: metadataIdentifier modelAsString: true GetSensitivitySettingsResponse: x-ms-azure-resource: true type: object description: Data sensitivity settings for sensitive data discovery properties: id: type: string description: The ID of the sensitivity settings readOnly: true type: type: string description: The type of the sensitivity settings readOnly: true name: type: string description: The name of the sensitivity settings readOnly: true properties: type: object description: The sensitivity settings properties properties: sensitiveInfoTypesIds: $ref: '#/definitions/SensitiveInfoTypesIds' sensitivityThresholdLabelOrder: type: number description: The order of the sensitivity threshold label. Any label at or above this order will be considered sensitive. If set to -1, sensitivity by labels is turned off sensitivityThresholdLabelId: type: string description: The id of the sensitivity threshold label. Any label at or above this rank will be considered sensitive. format: uuid mipInformation: description: Microsoft information protection built-in and custom information types, labels, and integration status. type: object properties: mipIntegrationStatus: $ref: '#/definitions/MipIntegrationStatus' labels: $ref: '#/definitions/Labels' customInfoTypes: description: List of custom user-defined information types type: array items: $ref: '#/definitions/InfoType' builtInInfoTypes: description: List of pre-configured sensitive information types type: array items: $ref: '#/definitions/BuiltInInfoType' Resource_3: properties: id: type: string readOnly: true description: Azure resource Id name: type: string readOnly: true description: Azure resource name type: type: string readOnly: true description: Azure resource type location: type: string description: Resource location x-ms-mutability: - create - read tags: additionalProperties: type: string description: Resource tags required: - location x-ms-azure-resource: true description: An azure resource object EmissionScopeEnum: type: string description: Supported emission scopes to be used with QueryParameter enum: - Scope1 - Scope2 - Scope3 x-ms-enum: name: EmissionScopeEnum modelAsString: true values: - name: Scope1 value: Scope1 description: Scope1 carbon emission - name: Scope2 value: Scope2 description: Scope2 carbon emission - name: Scope3 value: Scope3 description: Scope3 carbon emission Service: description: Object that represents a Service resource. type: object properties: id: description: Id of the resource. type: string readOnly: true name: description: Name of the resource. type: string readOnly: true type: description: Type of the resource 'Microsoft.Support/services'. type: string readOnly: true properties: x-ms-client-flatten: true $ref: '#/definitions/ServiceProperties_3' description: Properties of the resource. ErrorResponse: description: Error response. properties: error: $ref: '#/definitions/ErrorDefinition' description: The error details. alertsMetaData: type: object description: alert meta data information. properties: properties: $ref: '#/definitions/alertsMetaDataProperties' OperationResult: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/OperationResultProperties' allOf: - $ref: '#/definitions/Resource_4' description: OperationResult entity for Intune. DeleteOrUpdateBehavior: description: The cleanup behavior to indicate whether clean up operation when resource is deleted or updated type: string enum: - Default - ForcedCleanup x-ms-enum: name: DeleteOrUpdateBehavior modelAsString: true ActionGroupPatchBody: description: A tenant action group object for the body of patch operations. type: object properties: tags: type: object additionalProperties: type: string description: Resource tags properties: x-ms-client-flatten: true $ref: '#/definitions/ActionGroupPatch' description: The action group settings for an update operation. LogSpecification: properties: name: type: string description: The diagnostic log category name. readOnly: true displayName: type: string description: The diagnostic log category display name. readOnly: true blobDuration: type: string description: The time range for requests in each blob. readOnly: true type: object description: A diagnostic log emitted by service. AssociatedObject: description: Object that hold sync object details. type: object properties: displayName: description: The display name of the object. type: string distinguishedName: description: The distinguished name of the object. type: string lastDirSyncTime: description: The last dirSync time. type: string format: date-time mail: description: The email of the object. type: string objectGuid: description: The object guid. type: string objectType: description: The object type. type: string onpremisesUserPrincipalName: description: The On-premises UPN. type: string proxyAddresses: description: The proxy addresses. type: string sourceAnchor: description: The source anchor. type: string sourceOfAuthority: description: The source of authority. type: string timeOccurred: description: ' The time of the error.' type: string format: date-time userPrincipalName: description: ' The UPN.' type: string TagsResult: description: A resource listing all tags. type: object allOf: - $ref: '#/definitions/ProxyResource' properties: properties: x-ms-client-flatten: true $ref: '#/definitions/TagProperties' title: Tag properties schemasListResult: type: object properties: value: description: Schemas array. $ref: '#/definitions/schemas' description: The schemas list result. OperationDisplay_2: type: object description: Displayable properties of the operation. readOnly: true properties: provider: type: string description: Provider of the operation. readOnly: true resource: type: string description: Resource operated on by the operation. readOnly: true operation: type: string description: Operation Type. readOnly: true description: type: string description: Description of the operation. readOnly: true ErrorResponse_6: title: Error response type: object properties: error: description: Error info. type: object properties: code: description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. type: string message: description: Human-readable representation of the error. type: string details: description: Error details. type: array items: $ref: '#/definitions/ErrorDetails_2' x-ms-identifiers: [] TenantActionGroupResource: description: A tenant action group resource. type: object allOf: - $ref: '#/definitions/AzureResource' properties: properties: x-ms-client-flatten: true $ref: '#/definitions/TenantActionGroup' description: The tenant action groups properties of the resource. AttestationListResult: description: List of attestations. properties: value: description: Array of attestation definitions. type: array items: $ref: '#/definitions/Attestation' readOnly: true nextLink: type: string description: The URL to get the next set of results. readOnly: true InfoType: type: object description: Custom user-defined information type properties: name: description: Display name of the info type type: string id: description: Id of the info type type: string format: uuid description: description: Description of the info type type: string Item: description: The key value pair for properties. type: object properties: key: description: The key for the property. type: string value: description: The value for the key. type: string SummaryResults: description: Non-compliance summary on a particular summary level. properties: queryResultsUri: description: HTTP POST URI for queryResults action on Microsoft.PolicyInsights to retrieve raw results for the non-compliance summary. type: string nonCompliantResources: description: Number of non-compliant resources. type: integer format: int32 minimum: 0 nonCompliantPolicies: description: Number of non-compliant policies. type: integer format: int32 minimum: 0 OperationDisplay_5: title: Operation Display. description: The object that describes the operation. properties: provider: title: Resource Provider Name. description: Friendly name of the resource provider. type: string operation: title: Operation Type. description: 'The type of operation. For example: read, write, delete.' type: string resource: title: Resource Type. description: The resource type on which the operation is performed. type: string description: title: Operation description description: A description of the operation. type: string ServiceResource: type: object description: A Service resource for an Arc connected cluster (Microsoft.Kubernetes/connectedClusters) properties: properties: $ref: '#/definitions/ServiceProperties_2' description: The resource-specific properties for this resource. x-ms-client-flatten: true x-ms-mutability: - read - create allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource ErrorResponse_4: description: Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. type: object properties: error: description: The details of the error. $ref: '#/definitions/ErrorDetails' PolicyTrackedResource: type: object description: Policy tracked resource record. properties: trackedResourceId: description: The ID of the policy tracked resource. type: string readOnly: true policyDetails: $ref: '#/definitions/PolicyDetails' description: The details of the policy that require the tracked resource. readOnly: true createdBy: $ref: '#/definitions/TrackedResourceModificationDetails' description: The details of the policy triggered deployment that created the tracked resource. readOnly: true lastModifiedBy: $ref: '#/definitions/TrackedResourceModificationDetails' description: The details of the policy triggered deployment that modified the tracked resource. readOnly: true lastUpdateUtc: description: Timestamp of the last update to the tracked resource. type: string format: date-time readOnly: true PolicyTrackedResourcesQueryResults: description: Query results. properties: value: description: Query results. type: array items: $ref: '#/definitions/PolicyTrackedResource' x-ms-identifiers: - trackedResourceId readOnly: true nextLink: type: string description: The URL to get the next set of results. readOnly: true ExpressionEvaluationDetails: type: object description: Evaluation details of policy language expressions. properties: result: description: Evaluation result. type: string expression: description: Expression evaluated. type: string path: description: Property path if the expression is a field or an alias. type: string expressionValue: description: Value of the expression. type: object targetValue: description: Target value to be compared with the expression value. type: object operator: description: Operator to compare the expression value and the target value. type: string UserProperties: description: The cloud shell user settings properties. type: object required: - preferredOsType - preferredLocation - storageProfile - terminalSettings - preferredShellType properties: preferredOsType: description: The operating system type of the cloud shell. Deprecated, use preferredShellType. type: string enum: - Windows - Linux x-ms-enum: name: osType modelAsString: true preferredLocation: description: The preferred location of the cloud shell. type: string storageProfile: $ref: '#/definitions/StorageProfile' terminalSettings: $ref: '#/definitions/TerminalSettings' preferredShellType: description: The shell type of the cloud shell. type: string enum: - bash - pwsh - powershell x-ms-enum: name: shellType modelAsString: true Operation: description: The definition of a Microsoft.Authorization operation. type: object properties: name: description: Name of the operation type: string isDataAction: description: Indicates whether the operation is a data action type: boolean display: $ref: '#/definitions/OperationDisplay' description: Display of the operation origin: description: Origin of the operation type: string SmsReceiver: description: An SMS receiver. type: object properties: name: type: string description: The name of the SMS receiver. Names must be unique across all receivers within a tenant action group. countryCode: type: string description: The country code of the SMS receiver. phoneNumber: type: string description: The phone number of the SMS receiver. status: readOnly: true $ref: '#/definitions/ReceiverStatus' description: The status of the receiver. required: - name - countryCode - phoneNumber OperationsListResults: description: List of available operations. type: object properties: '@odata.count': description: OData entity count; represents the number of operations returned. type: integer format: int32 minimum: 1 value: description: List of available operations. type: array items: $ref: '#/definitions/Operation_8' x-ms-identifiers: - name AzureResource: properties: id: type: string readOnly: true description: Azure resource Id name: type: string readOnly: true description: Azure resource name type: type: string readOnly: true description: Azure resource type location: type: string description: Resource location x-ms-mutability: - create - read tags: additionalProperties: type: string type: object description: Resource tags required: - location type: object x-ms-azure-resource: true description: An azure resource object RemediationDeployment: description: Details of a single deployment created by the remediation. properties: remediatedResourceId: type: string description: Resource ID of the resource that is being remediated by the deployment. readOnly: true deploymentId: type: string description: Resource ID of the template deployment that will remediate the resource. readOnly: true status: type: string description: Status of the remediation deployment. readOnly: true resourceLocation: type: string description: Location of the resource that is being remediated. readOnly: true error: $ref: '#/definitions/ErrorDefinition_3' description: Error encountered while remediated the resource. readOnly: true createdOn: type: string format: date-time description: The time at which the remediation was created. readOnly: true lastUpdatedOn: type: string format: date-time description: The time at which the remediation deployment was last updated. readOnly: true ReceiverStatus: type: string enum: - NotSpecified - Enabled - Disabled x-ms-enum: name: ReceiverStatus modelAsString: false description: Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications. EmailReceiver: description: An email receiver. type: object properties: name: type: string description: The name of the email receiver. Names must be unique across all receivers within a tenant action group. emailAddress: type: string description: The email address of this receiver. useCommonAlertSchema: type: boolean default: false description: Indicates whether to use common alert schema. status: readOnly: true $ref: '#/definitions/ReceiverStatus' description: The receiver status of the e-mail. required: - name - emailAddress OperationResultList: type: object description: List of API operations. properties: value: type: array description: List of operations. items: $ref: '#/definitions/Operation_2' x-ms-identifiers: - name validateSchemaResult: type: object description: Result of the schema validation. properties: status: enum: - Succeeded - Failed type: string x-ms-enum: name: validateSchemaStatus modelAsString: true description: Validation status of the schema message: type: string description: Message describing the schema validation ProvisioningState: type: string description: The status of the current operation. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted x-ms-enum: name: ProvisioningState modelAsString: true values: - name: Succeeded value: Succeeded description: Resource has been created. - name: Failed value: Failed description: Resource creation failed. - name: Canceled value: Canceled description: Resource creation was canceled. - name: Provisioning value: Provisioning description: Initial provisioning in progress - name: Updating value: Updating description: Update in progress - name: Deleting value: Deleting description: Deletion in progress - name: Accepted value: Accepted description: Change accepted for processing readOnly: true alertsSummaryGroup: type: object description: Group the result set. properties: total: type: integer format: int64 description: Total count of the result set. smartGroupsCount: type: integer format: int64 description: Total count of the smart groups. groupedby: type: string description: Name of the field aggregated values: type: array description: List of the items items: $ref: '#/definitions/alertsSummaryGroupItem' x-ms-identifiers: [] QueryFailure: description: Error response. properties: error: description: Error definition. properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: Description of the error. type: string readOnly: true SourceControlCollection: description: Collection of source controls. required: - value type: object properties: value: description: Collection of resources. type: array items: $ref: '#/definitions/SourceControl' nextLink: description: Link to next page of resources. type: string readOnly: true IfNotExistsEvaluationDetails: type: object description: Evaluation details of IfNotExists effect. properties: resourceId: description: ID of the last evaluated resource for IfNotExists effect. type: string totalResources: description: Total number of resources to which the existence condition is applicable. type: integer ActionList: type: object description: A list of Activity Log Alert rule actions. properties: actionGroups: description: The list of the Action Groups. type: array items: $ref: '#/definitions/ActionGroup' x-ms-identifiers: - actionGroupId ErrorDetails_2: title: Error details type: object properties: code: description: Error code identifying the specific error. type: string message: description: A human-readable error message. type: string ProviderResourceType: properties: resourceType: type: string description: The resource type. locations: type: array items: type: string description: The collection of locations where this resource type can be created. locationMappings: type: array items: $ref: '#/definitions/ProviderExtendedLocation' x-ms-identifiers: - location - type description: The location mappings that are supported by this resource type. aliases: type: array items: $ref: '#/definitions/Alias' x-ms-identifiers: - name description: The aliases that are supported by this resource type. apiVersions: type: array items: type: string description: The API version. defaultApiVersion: type: string readOnly: true description: The default API version. zoneMappings: type: array items: $ref: '#/definitions/ZoneMapping' x-ms-identifiers: - location apiProfiles: type: array readOnly: true items: $ref: '#/definitions/ApiProfile' x-ms-identifiers: - apiVersion - profileVersion description: The API profiles for the resource provider. capabilities: type: string description: The additional capabilities offered by this resource type. properties: type: object additionalProperties: type: string description: 'The additional properties. ' description: The properties. description: Resource type managed by the resource provider. alertEnrichmentResponse: description: The alert's enrichments. type: object allOf: - $ref: ../../../../../common-types/resource-management/v5/types.json#/definitions/Resource properties: properties: $ref: '#/definitions/alertEnrichmentProperties' CloudShellConsole: description: Cloud shell console type: object required: - properties properties: properties: $ref: '#/definitions/ConsoleProperties' allOf: - $ref: '#/definitions/Resource_2' OperationList: type: object description: The paginated list of connected cluster API operations. properties: value: readOnly: true type: array items: $ref: '#/definitions/Operation_5' x-ms-identifiers: - name description: The list of connected cluster API operations. nextLink: type: string description: The link to fetch the next page of connected cluster API operations. TargetServiceType: description: The target service type. type: string enum: - AzureResource - ConfluentBootstrapServer - ConfluentSchemaRegistry - SelfHostedServer x-ms-enum: name: targetServiceType modelAsString: true WipeDeviceOperationResultProperties: required: - value properties: value: type: string iOSMAMPolicy: properties: properties: x-ms-client-flatten: true $ref: '#/definitions/iOSMAMPolicyProperties' allOf: - $ref: '#/definitions/Resource_4' description: iOS Policy entity for Intune MAM. TenantAlertRulePatchObject: type: object description: An Activity Log Alert rule object for the body of patch operations. properties: tags: type: object description: The resource tags additionalProperties: type: string properties: x-ms-client-flatten: true $ref: '#/definitions/TenantAlertRulePatchProperties' description: The activity log alert settings for an update operation. alert: type: object description: An alert created in alert management service. allOf: - $ref: '#/definitions/Resource' properties: properties: $ref: '#/definitions/alertProperties' OperationResultProperties: required: - userId - friendlyName - platform - operationMetadata properties: friendlyName: type: string category: type: string lastModifiedTime: type: string state: type: string operationMetadata: type: array items: $ref: '#/definitions/operationMetadataProperties' alertsSummaryGroupItem: type: object description: Alerts summary group item properties: name: type: string description: Value of the aggregated field count: type: integer format: int64 description: Count of the aggregated field groupedby: type: string description: Name of the field aggregated values: type: array description: List of the items items: $ref: '#/definitions/alertsSummaryGroupItem' x-ms-identifiers: [] OperationDisplay: description: The display information for a Microsoft.Authorization operation. type: object properties: provider: description: 'The resource provider name: Microsoft.Authorization.' type: string readOnly: true resource: description: The resource on which the operation is performed. type: string readOnly: true operation: description: The operation that users can perform. type: string readOnly: true description: description: The description for the operation. type: string readOnly: true TestNotificationDetailsResponse: description: The details of the test notification results. type: object properties: context: type: object $ref: '#/definitions/Context' state: type: string description: The overall state completedTime: type: string description: The completed time createdTime: type: string description: The created time actionDetails: x-ms-identifiers: [] type: array items: $ref: '#/definitions/ActionDetail' description: The list of action detail required: - state TypedErrorInfo: description: Scenario specific error details. properties: type: description: The type of included error details. type: string readOnly: true info: description: The scenario specific error details. readOnly: true MetricSpecification: properties: name: type: string description: The metric name. readOnly: true displayName: type: string description: The metric display name. readOnly: true displayDescription: type: string description: The metric display description. readOnly: true unit: type: string enum: - Bytes - Count - Milliseconds x-ms-enum: name: MetricUnit values: - value: Bytes description: The number of bytes. - value: Count description: The count. - value: Milliseconds description: The number of milliseconds. modelAsString: true description: The metric unit readOnly: true x-nullable: false aggregationType: type: string enum: - Average - Count - Total x-ms-enum: name: MetricAggregationType values: - value: Average description: The average. - value: Count description: The count of a number of items, usually requests. - value: Total description: The sum. modelAsString: true description: The metric aggregation type readOnly: true x-nullable: false lockAggregationType: type: string enum: - Average - Count - Total x-ms-enum: name: MetricAggregationType values: - value: Average description: The average. - value: Count description: The count of a number of items, usually requests. - value: Total description: The sum. modelAsString: true description: The metric lock aggregation type readOnly: true x-nullable: true supportedAggregationTypes: type: array items: type: string description: Supported aggregation types. dimensions: type: array items: $ref: '#/definitions/MetricDimension' x-ms-identifiers: - name description: The metric dimensions. readOnly: true enableRegionalMdmAccount: type: boolean description: Indicates whether regional MDM account is enabled. readOnly: true x-nullable: false sourceMdmAccount: type: string description: The source MDM account. readOnly: true sourceMdmNamespace: type: string description: The source MDM namespace. readOnly: true supportedTimeGrainTypes: type: array items: type: string description: The supported time grain types. readOnly: true type: object description: A metric emitted by service. PolicyDetails: type: object description: The policy details. properties: policyDefinitionId: description: The ID of the policy definition. type: string readOnly: true policyAssignmentId: description: The ID of the policy assignment. type: string readOnly: true policyAssignmentDisplayName: description: The display name of the policy assignment. type: string readOnly: true policyAssignmentScope: description: The scope of the policy assignment. type: string readOnly: true policySetDefinitionId: description: The ID of the policy set definition. type: string readOnly: true policyDefinitionReferenceId: description: The policy definition reference ID within the policy set definition. type: string readOnly: true ApiProfile: properties: profileVersion: type: string readOnly: true description: The profile version. apiVersion: type: string readOnly: true description: The API version. PolicyState: type: object description: Policy state record. properties: '@odata.id': description: OData entity ID; always set to null since policy state records do not have an entity ID. type: string '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string timestamp: description: Timestamp for the policy state record. type: string format: date-time resourceId: description: Resource ID. type: string policyAssignmentId: description: Policy assignment ID. type: string policyDefinitionId: description: Policy definition ID. type: string effectiveParameters: description: Effective parameters for the policy assignment. type: string isCompliant: description: Flag which states whether the resource is compliant against the policy assignment it was evaluated against. type: boolean subscriptionId: description: Subscription ID. type: string resourceType: description: Resource type. type: string resourceLocation: description: Resource location. type: string resourceGroup: description: Resource group name. type: string resourceTags: description: List of resource tags. type: string policyAssignmentName: description: Policy assignment name. type: string policyAssignmentOwner: description: Policy assignment owner. type: string policyAssignmentParameters: description: Policy assignment parameters. type: string policyAssignmentScope: description: Policy assignment scope. type: string policyDefinitionName: description: Policy definition name. type: string policyDefinitionAction: description: Policy definition action, i.e. effect. type: string policyDefinitionCategory: description: Policy definition category. type: string policySetDefinitionId: description: Policy set definition ID, if the policy assignment is for a policy set. type: string policySetDefinitionName: description: Policy set definition name, if the policy assignment is for a policy set. type: string policySetDefinitionOwner: description: Policy set definition owner, if the policy assignment is for a policy set. type: string policySetDefinitionCategory: description: Policy set definition category, if the policy assignment is for a policy set. type: string policySetDefinitionParameters: description: Policy set definition parameters, if the policy assignment is for a policy set. type: string managementGroupIds: description: Comma separated list of management group IDs, which represent the hierarchy of the management groups the resource is under. type: string policyDefinitionReferenceId: description: Reference ID for the policy definition inside the policy set, if the policy assignment is for a policy set. type: string complianceState: description: Compliance state of the resource. type: string policyEvaluationDetails: description: Policy evaluation details. type: object $ref: '#/definitions/PolicyEvaluationDetails' additionalProperties: description: The list of key/value pairs for the additional properties, in the format 'key':'value' where key = the field name, and value = the field value. By default this is not populated ErrorDetails: description: The details of the error. properties: code: description: Error code. type: string readOnly: true message: description: Error message indicating why the operation failed. type: string readOnly: true iOSMAMPolicyProperties: allOf: - $ref: '#/definitions/MAMPolicyProperties' properties: fileEncryptionLevel: type: string default: deviceLocked enum: - deviceLocked - deviceLockedExceptFilesOpen - afterDeviceRestart - useDeviceSettings touchId: type: string default: enable enum: - enable - disable description: Intune MAM iOS Policy Properties. ProviderRegistrationRequest: type: object description: The provider registration definition. properties: thirdPartyProviderConsent: $ref: '#/definitions/ProviderConsentDefinition' description: The provider consent. Items: description: The list of key value properties. type: object properties: value: description: The value returned by the operation. type: array items: $ref: '#/definitions/Item' ServiceProperties: description: The service properties for a given service. type: object properties: id: description: The id of the service. type: string activeAlerts: description: The count of alerts that are currently active for the service. type: integer additionalInformation: description: The additional information related to the service. type: string createdDate: description: The date and time, in UTC, when the service was onboarded to Azure Active Directory Connect Health. type: string format: date-time customNotificationEmails: description: The list of additional emails that are configured to receive notifications about the service. type: array items: type: string disabled: description: Indicates if the service is disabled or not. type: boolean displayName: description: The display name of the service. type: string health: description: The health of the service. type: string lastDisabled: description: The date and time, in UTC, when the service was last disabled. type: string format: date-time lastUpdated: description: The date or time , in UTC, when the service properties were last updated. type: string format: date-time monitoringConfigurationsComputed: description: The monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. type: object items: $ref: '#/definitions/Items' monitoringConfigurationsCustomized: description: The customized monitoring configuration of the service which determines what activities are monitored by Azure Active Directory Connect Health. type: object items: $ref: '#/definitions/Items' notificationEmailEnabled: description: Indicates if email notification is enabled or not. type: boolean notificationEmailEnabledForGlobalAdmins: description: Indicates if email notification is enabled for global administrators of the tenant. type: boolean notificationEmailsEnabledForGlobalAdmins: description: Indicates if email notification is enabled for global administrators of the tenant. type: boolean notificationEmails: description: The list of emails to whom service notifications will be sent. type: array items: type: string originalDisabledState: description: Gets the original disable state. type: boolean resolvedAlerts: description: The total count of alerts that has been resolved for the service. type: integer serviceId: description: The id of the service. type: string serviceName: description: The name of the service. type: string signature: description: The signature of the service. type: string simpleProperties: description: List of service specific configuration properties. type: object items: $ref: '#/definitions/Items' tenantId: description: The id of the tenant to which the service is registered to. type: string type: description: The service type for the services onboarded to Azure Active Directory Connect Health. Depending on whether the service is monitoring, ADFS, Sync or ADDS roles, the service type can either be AdFederationService or AadSyncService or AdDomainService. type: string SensitiveInfoTypesIds: description: List of selected sensitive info types' IDs. type: array items: type: string format: uuid AlertRuleAllOfCondition: description: An Activity Log Alert rule condition that is met when all its member conditions are met. type: object properties: allOf: description: The list of Activity Log Alert rule conditions. type: array items: $ref: '#/definitions/AlertRuleAnyOfOrLeafCondition' x-ms-identifiers: [] required: - allOf Permission: type: object readOnly: true properties: actions: type: array items: type: string description: Allowed actions. notActions: type: array items: type: string description: Denied actions. dataActions: type: array items: type: string description: Allowed Data actions. notDataActions: type: array items: type: string description: Denied Data actions. description: Role definition permissions. SystemAssignedIdentityProperties: description: The properties associated with the system assigned identity. type: object title: System Assigned Identity properties. properties: tenantId: type: string readOnly: true format: uuid description: The id of the tenant which the identity belongs to. principalId: type: string readOnly: true format: uuid description: The id of the service principal object associated with the created identity. clientId: type: string readOnly: true format: uuid description: The id of the app associated with the identity. This is a random generated UUID by MSI. clientSecretUrl: type: string readOnly: true description: ' The ManagedServiceIdentity DataPlane URL that can be queried to obtain the identity credentials.' ComponentExpressionEvaluationDetails: type: object description: Evaluation details of policy language expressions. properties: result: description: Evaluation result. type: string expression: description: Expression evaluated. type: string readOnly: true expressionKind: description: The kind of expression that was evaluated. type: string readOnly: true path: description: Property path if the expression is a field or an alias. type: string readOnly: true expressionValue: description: Value of the expression. type: object readOnly: true targetValue: description: Target value to be compared with the expression value. type: object readOnly: true operator: description: Operator to compare the expression value and the target value. type: string readOnly: true ServiceProperties_2: type: object description: Properties for the service resource properties: rpObjectId: type: string description: The object id of the service principal of the RP provisioned in the tenant readOnly: true provisioningState: $ref: '#/definitions/ProvisioningState' description: Resource provision state readOnly: true errorResponseBody: type: object description: Details of error response. properties: code: type: string description: Error code, intended to be consumed programmatically. message: type: string description: Description of the error, intended for display in user interface. target: type: string description: Target of the particular error, for example name of the property. details: type: array description: A list of additional details about the error. items: $ref: '#/definitions/errorResponseBody' AccessDecisionEnum: type: string description: Enum for Access Decision enum: - Allowed - Denied x-ms-enum: name: AccessDecisionEnum modelAsString: true values: - name: Allowed value: Allowed description: Access allowed - name: Denied value: Denied description: Access denied SummarizeResults: description: Summarize action results. properties: '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string '@odata.count': description: OData entity count; represents the number of summaries returned; always set to 1. type: integer format: int32 minimum: 1 maximum: 1 value: description: Summarize action results. type: array items: $ref: '#/definitions/Summary' ProxyResource: description: The Resource model definition. properties: id: readOnly: true type: string description: Resource Id. name: readOnly: true type: string description: Resource name. type: readOnly: true type: string description: Resource type. eTag: type: string description: eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not. x-ms-azure-resource: true FlaggedUserCollection: required: - value properties: value: type: array items: $ref: '#/definitions/FlaggedUser' nextlink: readOnly: true type: string description: Gets the URL to get the next set of results. description: Flagged user collection for the given tenant. CarbonEmissionDataAvailableDateRange: type: object description: Response for available date range of carbon emission data properties: startDate: type: string description: Start date parameter, format is yyyy-MM-dd endDate: type: string description: End date parameter, format is yyyy-MM-dd required: - startDate - endDate Provider: properties: id: readOnly: true type: string description: The provider ID. namespace: type: string description: The namespace of the resource provider. registrationState: readOnly: true type: string description: The registration state of the resource provider. registrationPolicy: readOnly: true type: string description: The registration policy of the resource provider. resourceTypes: readOnly: true type: array items: $ref: '#/definitions/ProviderResourceType' x-ms-identifiers: - resourceType description: The collection of provider resource types. providerAuthorizationConsentState: type: string enum: - NotSpecified - Required - NotRequired - Consented description: The provider authorization consent state. x-ms-enum: name: ProviderAuthorizationConsentState modelAsString: true description: Resource provider information. TerminalSettings: description: Settings for terminal appearance. type: object properties: fontSize: type: string description: Size of terminal font. enum: - NotSpecified - Small - Medium - Large x-ms-enum: name: fontSize modelAsString: true fontStyle: type: string description: Style of terminal font. enum: - NotSpecified - Monospace - Courier x-ms-enum: name: fontStyle modelAsString: true VNetSolution: type: object description: The VNet solution for linker properties: type: x-nullable: true description: Type of VNet solution. type: string enum: - serviceEndpoint - privateLink x-ms-enum: name: vNetSolutionType modelAsString: true deleteOrUpdateBehavior: description: Indicates whether to clean up previous operation when Linker is updating or deleting $ref: '#/definitions/DeleteOrUpdateBehavior' operation_2: description: Operation provided by provider properties: name: type: string description: Name of the operation isDataAction: description: Indicates whether the operation is a data action type: boolean display: type: object description: Properties of the operation properties: provider: type: string description: Provider name resource: type: string description: Resource name operation: type: string description: Operation name description: type: string description: Description of the operation LinkerProperties: description: The properties of the Linker. type: object properties: targetService: $ref: '#/definitions/TargetServiceBase' description: The target service properties authInfo: description: The authentication type. $ref: '#/definitions/AuthInfoBase' clientType: description: The application client type $ref: '#/definitions/ClientType' provisioningState: readOnly: true type: string description: 'The provisioning state. ' vNetSolution: x-nullable: true description: The VNet solution. $ref: '#/definitions/VNetSolution' secretStore: x-nullable: true description: An option to store secret value in secure place $ref: '#/definitions/SecretStore' scope: x-nullable: true type: string description: connection scope in source service. publicNetworkSolution: x-nullable: true description: The network solution. $ref: '#/definitions/PublicNetworkSolution' configurationInfo: x-nullable: true description: The connection information consumed by applications, including secrets, connection strings. $ref: '#/definitions/ConfigurationInfo' Result: description: The result for an operation. type: object properties: value: description: The value. type: boolean Resource_2: description: The Resource model definition. x-ms-azure-resource: true MipIntegrationStatus: type: string description: Microsoft information protection integration status enum: - Ok - noConsent - noAutoLabelingRules - noMipLabels x-ms-enum: name: MipIntegrationStatus modelAsString: true TargetServiceBase: description: The target service properties discriminator: type type: object properties: type: description: The target service type. $ref: '#/definitions/TargetServiceType' required: - type AuthMode: description: Indicates how to apply the authentication configuration operations. type: string enum: - optInAllAuth - optOutAllAuth x-ms-enum: name: authMode modelAsString: true values: - value: optInAllAuth description: Default authentication configuration according to the authentication type. - value: optOutAllAuth description: Skip all authentication configuration such as enabling managed identity and granting RBAC roles AliasPath: properties: path: type: string description: The path of an alias. apiVersions: type: array items: type: string description: The API versions. pattern: $ref: '#/definitions/AliasPattern' description: The pattern for an alias path. metadata: readOnly: true $ref: '#/definitions/AliasPathMetadata' description: The metadata of the alias path. If missing, fall back to the default metadata of the alias. description: The type of the paths for alias. RoleDefinition: type: object properties: id: type: string description: The role definition ID. name: type: string description: The role definition name. isServiceRole: type: boolean description: If this is a service role. permissions: type: array items: $ref: '#/definitions/Permission' x-ms-identifiers: [] description: Role definition permissions. scopes: type: array items: type: string description: Role definition assignable scopes. description: Role definition properties. GroupsCollection: required: - value properties: value: type: array items: $ref: '#/definitions/GroupItem' nextlink: readOnly: true type: string description: Gets the URL to get the next set of results. PolicyMetadata: description: Policy metadata resource definition. properties: properties: x-ms-client-flatten: true $ref: '#/definitions/PolicyMetadataProperties' description: Properties of the policy metadata. id: type: string description: The ID of the policy metadata. readOnly: true type: type: string description: The type of the policy metadata. readOnly: true name: type: string description: The name of the policy metadata. readOnly: true FlaggedEnrolledAppError: properties: errorCode: type: string readOnly: true severity: type: string readOnly: true Operation_8: description: Operation definition. type: object properties: name: description: Operation name. type: string isDataAction: description: Indicates whether the operation is a data action type: boolean display: description: Display metadata associated with the operation. type: object properties: provider: description: Resource provider name. type: string resource: description: Resource name on which the operation is performed. type: string operation: description: Operation name. type: string description: description: Operation description. type: string ResourceList: description: The list of Linker. type: object properties: nextLink: x-nullable: true description: The Linker used to get the next page of Linker list. type: string value: description: The list of Linkers. type: array items: $ref: '#/definitions/LinkerResource' ServicesListResult: description: Collection of Service resources. type: object properties: value: description: List of Service resources. type: array items: $ref: '#/definitions/Service' ErrorDefinition: description: Error definition. properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: Description of the error. type: string readOnly: true target: description: The target of the error. type: string readOnly: true details: description: Internal error details. type: array items: $ref: '#/definitions/ErrorDefinition' x-ms-identifiers: [] readOnly: true additionalInfo: description: Additional scenario specific error details. type: array items: $ref: '#/definitions/TypedErrorInfo' x-ms-identifiers: [] readOnly: true Properties: properties: serviceSpecification: $ref: '#/definitions/ServiceSpecification' description: The service specifications. readOnly: true type: object description: Metric properties. ActionType: description: Indicates how to apply the connector operations, such as opt out network configuration, opt in configuration. type: string enum: - enable - optOut x-ms-enum: name: actionType modelAsString: true FlaggedEnrolledAppProperties: properties: deviceType: type: string readOnly: true friendlyName: type: string readOnly: true lastModifiedTime: type: string readOnly: true platform: type: string readOnly: true errors: type: array items: $ref: '#/definitions/FlaggedEnrolledAppError' GroupProperties: required: - friendlyName - platform properties: friendlyName: type: string TenantAlertRuleList: type: object description: A list of Tenant Activity Log Alert rules. properties: value: description: The list of Tenant Activity Log Alert rules. type: array items: $ref: '#/definitions/TenantActivityLogAlertResource' x-ms-identifiers: - id nextLink: description: Provides the link to retrieve the next set of elements. type: string PolicyStatesQueryResults: description: Query results. properties: '@odata.context': description: OData context string; used by OData clients to resolve type information based on metadata. type: string '@odata.count': description: OData entity count; represents the number of policy state records returned. type: integer format: int32 minimum: 0 '@odata.nextLink': description: Odata next link; URL to get the next set of results. type: string value: description: Query results. type: array items: $ref: '#/definitions/PolicyState' GuestDiagnosticSettingsAssociationResource: type: object allOf: - $ref: '#/definitions/Resource_3' required: - properties properties: properties: x-ms-client-flatten: true $ref: '#/definitions/GuestDiagnosticSettingsAssociation' description: The diagnostics settings associations of the resource. description: Virtual machine guest diagnostic settings resource. UserSettingsResponse: description: Response to get user settings type: object required: - properties properties: properties: $ref: '#/definitions/UserProperties' allOf: - $ref: '#/definitions/Resource_2' RemediationListResult: description: List of remediations. properties: value: description: Array of remediation definitions. type: array items: $ref: '#/definitions/Remediation' readOnly: true nextLink: type: string description: The URL to get the next set of results. readOnly: true DateRange: type: object description: Date range to be used with QueryParameter properties: start: type: string format: date description: Start date parameter, format is yyyy-MM-dd end: type: string format: date description: End date parameter, format is yyyy-MM-dd required: - start - end ErrorResponse_3: title: ErrorResponse description: Contains details when the response code indicates an error. type: object properties: error: $ref: '#/definitions/ErrorDetail' required: - error ActionGroupPatch: description: A tenant action group for patch operations. type: object properties: enabled: type: boolean default: true description: Indicates whether this tenant action group is enabled. If a tenant action group is not enabled, then none of its actions will be activated. parameters: ApiVersionParameter_5: name: api-version in: query required: true type: string description: Service Api Version. monitorService: description: Filter by monitor service which generates the alert instance. Default value is select all. name: monitorService type: string in: query required: false x-ms-parameter-location: method enum: - Application Insights - ActivityLog Administrative - ActivityLog Security - ActivityLog Recommendation - ActivityLog Policy - ActivityLog Autoscale - Log Analytics - Nagios - Platform - SCOM - ServiceHealth - SmartDetector - VM Insights - Zabbix - Resource Health x-ms-enum: name: MonitorService modelAsString: true ApiVersionParameter_4: name: api-version in: query required: true type: string description: ADU schema API version. TenantActivityLogAlertNameParameter: name: alertRuleName in: path required: true type: string pattern: ^[-\w\._\(\)]+$ description: The name of the Tenant Activity Log Alert rule. x-ms-parameter-location: method apiVersionParameter_2: name: api-version in: query description: API Version required: true type: string x-ms-parameter-location: client ScopeParameter: name: scope in: path required: true type: string description: The resource provider scope of the resource. Parent resource being extended by Managed Identities. x-ms-parameter-location: method x-ms-skip-url-encoding: true apiVersionParameter_10: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client targetResourceGroup: description: Filter by target resource group name. Default value is select all. name: targetResourceGroup type: string in: query required: false x-ms-parameter-location: method scopeParameter: name: scope in: path required: true type: string description: A valid scope, i.e. management group, subscription, resource group, or resource ID. Scope used has no effect on metadata returned. x-ms-parameter-location: method x-ms-skip-url-encoding: true ConsoleNameParameter: name: consoleName in: path required: true type: string description: The name of the console x-ms-parameter-location: client managementGroupsNamespaceParameter: name: managementGroupsNamespace in: path required: true type: string enum: - Microsoft.Management x-ms-enum: name: ManagementGroupsNamespaceType modelAsString: false description: The namespace for Microsoft Management RP; only "Microsoft.Management" is allowed. x-ms-parameter-location: method includeContext: description: Include context which has contextual data specific to the monitor service. Default value is false' name: includeContext type: boolean in: query required: false x-ms-parameter-location: method orderByParameter: name: $orderby in: query required: false type: string description: Ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: OrderBy severity: description: Filter by severity. Default value is select all. name: severity type: string in: query required: false x-ms-parameter-location: method enum: - Sev0 - Sev1 - Sev2 - Sev3 - Sev4 x-ms-enum: name: Severity modelAsString: true expandParameter: name: $expand in: query required: false type: string description: The $expand query parameter. For example, to expand policyEvaluationDetails, use $expand=policyEvaluationDetails x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Expand filterParameter: name: $filter in: query required: false type: string description: OData filter expression. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Filter scopeTagsParameter: name: scope in: path required: true type: string description: The scope associated with tags operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope and '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope.. x-ms-parameter-location: method x-ms-skip-url-encoding: true remediationNameParameter: name: remediationName in: path required: true type: string description: The name of the remediation. x-ms-parameter-location: method ApiVersionParameter: name: api-version in: query required: true type: string description: The API version to be used with the HTTP request. apply: name: $apply in: query required: false type: string description: OData apply expression for aggregations. x-ms-parameter-location: method x-ms-client-name: Apply apiVersionParameter_5: name: api-version in: query required: true type: string description: API version to use with the client requests. x-ms-parameter-location: client SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: The Microsoft Azure subscription ID. comment: description: reason of change alert state name: comment in: body required: false x-ms-parameter-location: method schema: $ref: '#/definitions/comments' smartGroupIdFilter: description: Filter the alerts list by the Smart Group Id. Default value is none. name: smartGroupId type: string in: query required: false x-ms-parameter-location: method to: name: $to in: query required: false type: string format: date-time description: ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. x-ms-parameter-location: method x-ms-client-name: To DiagnosticSettingsAssociationNameParameter: name: associationName in: path required: true type: string description: The name of the diagnostic settings association. x-ms-parameter-location: method ManagementGroupIdParameter: name: managementGroupId in: path required: true type: string description: The management group id. x-ms-parameter-location: method alertState: description: Filter by state of the alert instance. Default value is to select all. name: alertState type: string in: query required: false x-ms-parameter-location: method enum: - New - Acknowledged - Closed x-ms-enum: name: AlertState modelAsString: true ApiVersionParameter_6: name: api-version in: query description: Version of API to invoke. required: true type: string LinkerNameParameter: name: linkerName in: path required: true type: string description: The name Linker resource. x-ms-parameter-location: method ScopeParameter_2: name: scope in: path required: true type: string description: The resource scope. x-ms-parameter-location: method x-ms-skip-url-encoding: true componentPolicyStatesExpand: name: $expand in: query required: false type: string description: The $expand query parameter. x-ms-parameter-location: method x-ms-client-name: Expand top: name: $top in: query required: false type: integer format: int32 minimum: 0 description: Maximum number of records to return. x-ms-parameter-location: method x-ms-client-name: Top UserSettingsNameParameter: name: userSettingsName in: path required: true type: string description: The name of the user settings x-ms-parameter-location: client sortOrder: description: Sort the query results order in either ascending or descending. Default value is 'desc' for time fields and 'asc' for others. name: sortOrder type: string in: query required: false x-ms-parameter-location: method enum: - asc - desc x-ms-enum: name: SortOrder modelAsString: true policyEventsResourceParameter: name: policyEventsResource in: path required: true type: string enum: - default description: The name of the virtual resource under PolicyEvents resource type; only "default" is allowed. x-ms-parameter-location: method ApiVersionParameter_3: name: api-version in: query required: true type: string description: Client API version x-ms-parameter-location: client GroupIdParameter: name: groupId in: path required: true type: string description: The management group ID. x-ms-parameter-location: method minLength: 1 maxLength: 90 alertId: name: alertId description: Unique ID of an alert instance. type: string in: path required: true x-ms-parameter-location: method applyParameter: name: $apply in: query required: false type: string description: OData apply expression for aggregations. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Apply select_2: name: $select in: query required: false type: string description: Select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". x-ms-parameter-location: method x-ms-client-name: Select newState: description: New state of the alert. name: newState type: string in: query required: true x-ms-parameter-location: method enum: - New - Acknowledged - Closed x-ms-enum: name: AlertState modelAsString: true apiVersionParameter_8: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client api-version: name: api-version in: query description: The API version to use for the operation. required: true type: string enum: - 2020-01-13-preview policyStatesSummaryResourceParameter: name: policyStatesSummaryResource in: path required: true type: string enum: - latest description: The virtual resource under PolicyStates resource type for summarize action. In a given time range, 'latest' represents the latest policy state(s) and is the only allowed value. x-ms-parameter-location: method pageCount: description: Determines number of alerts returned per page in response. Permissible value is between 1 to 250. When the "includeContent" filter is selected, maximum value allowed is 25. Default value is 25. name: pageCount type: integer format: int64 in: query required: false x-ms-parameter-location: method toParameter: name: $to in: query required: false type: string format: date-time description: ISO 8601 formatted timestamp specifying the end time of the interval to query. When not specified, the service uses request time. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: To apiVersion: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client skipTokenParameter: name: $skiptoken in: query required: false type: string description: Skiptoken is only provided if a previous response returned a partial result as a part of nextLink element. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: SkipToken alertsSortBy: description: Sort the query results by input field, Default value is 'lastModifiedDateTime'. name: sortBy type: string in: query required: false x-ms-parameter-location: method enum: - name - severity - alertState - monitorCondition - targetResource - targetResourceName - targetResourceGroup - targetResourceType - startDateTime - lastModifiedDateTime x-ms-enum: name: AlertsSortByFields modelAsString: true apiVersionParameter_6: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client apiVersionParameter_3: name: api-version in: query required: true type: string description: Version of the API to be used with the client request. The current version is 2019-04-01-preview. attestationNameParameter: name: attestationName in: path required: true type: string description: The name of the attestation. x-ms-parameter-location: method identifier: name: identifier description: Identification of the information to be retrieved by API call. type: string in: query required: true enum: - MonitorServiceList x-ms-enum: name: identifier modelAsString: true x-ms-parameter-location: method managementGroupIdParameter: name: managementGroupId in: path required: true type: string description: Management group ID. x-ms-parameter-location: method resourceIdParameter: name: resourceId in: path required: true type: string description: Resource ID. x-ms-parameter-location: method x-ms-skip-url-encoding: true fromParameter: name: $from in: query required: false type: string format: date-time description: ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: From ResourceUriParameter: name: resourceUri in: path required: true type: string description: The fully qualified Azure Resource manager identifier of the resource to be connected. x-ms-skip-url-encoding: true x-ms-parameter-location: method policyTrackedResourcesResourceParameter: name: policyTrackedResourcesResource in: path required: true type: string enum: - default x-ms-enum: name: PolicyTrackedResourcesResourceType modelAsString: true description: The name of the virtual resource under PolicyTrackedResources resource type; only "default" is allowed. x-ms-parameter-location: method ApiVersionParameter_8: name: api-version in: query required: true type: string description: The API version to use for this operation. componentPolicyStatesResource: name: componentPolicyStatesResource in: path required: true type: string enum: - latest x-ms-enum: name: ComponentPolicyStatesResource modelAsString: true description: The virtual resource under ComponentPolicyStates resource type. In a given time range, 'latest' represents the latest component policy state(s). x-ms-parameter-location: method targetResource: description: Filter by target resource( which is full ARM ID) Default value is select all. name: targetResource type: string in: query required: false x-ms-parameter-location: method Azure.ResourceManager.ResourceUriParameter: name: resourceUri in: path description: The fully qualified Azure Resource manager identifier of the resource. required: true type: string x-ms-parameter-location: method x-ms-skip-url-encoding: true orderBy: name: $orderby in: query required: false type: string description: Ordering expression using OData notation. One or more comma-separated column names with an optional "desc" (the default) or "asc", e.g. "$orderby=PolicyAssignmentId, ResourceId asc". x-ms-parameter-location: method x-ms-client-name: OrderBy NotificationIdParameter: name: notificationId in: path required: true type: string description: The notification id x-ms-parameter-location: method managementGroupNameParameter: name: managementGroupName in: path required: true type: string description: Management group name. x-ms-parameter-location: method apiVersionParameter_9: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client targetResourceType: description: Filter by target resource type. Default value is select all. name: targetResourceType type: string in: query required: false x-ms-parameter-location: method ActionGroupNameParameter: name: tenantActionGroupName in: path required: true type: string pattern: ^[A-Za-z][A-Za-z0-9]*$ minLength: 1 maxLength: 260 description: The name of the action group. x-ms-parameter-location: method alertsSummaryGroupBy: description: This parameter allows the result set to be grouped by input fields (Maximum 2 comma separated fields supported). For example, groupby=severity or groupby=severity,alertstate. name: groupby type: string in: query required: true x-ms-parameter-location: method enum: - severity - alertState - monitorCondition - monitorService - signalType - alertRule x-ms-enum: name: AlertsSummaryGroupByFields modelAsString: true from: name: $from in: query required: false type: string format: date-time description: ISO 8601 formatted timestamp specifying the start time of the interval to query. When not specified, the service uses ($to - 1-day). x-ms-parameter-location: method x-ms-client-name: From select: description: This filter allows to selection of the fields(comma separated) which would be part of the essential section. This would allow to project only the required fields rather than getting entire content. Default is to fetch all the fields in the essentials section. name: select type: string in: query required: false x-ms-parameter-location: method apiVersionParameter_7: name: api-version in: query required: true type: string description: Client Api Version. x-ms-parameter-location: client TenantIdParameter: name: x-ms-client-tenant-id in: header description: The tenant ID of the client making the request. required: true type: string x-ms-parameter-location: method alertRule: description: Filter by specific alert rule. Default value is to select all. name: alertRule type: string in: query required: false x-ms-parameter-location: method resourceId: name: resourceId in: path required: true type: string description: Resource ID. x-ms-parameter-location: method x-ms-skip-url-encoding: true policyStatesResourceParameter: name: policyStatesResource in: path required: true type: string enum: - default - latest x-ms-enum: name: PolicyStatesResource modelAsString: true description: The virtual resource under PolicyStates resource type. In a given time range, 'latest' represents the latest policy state(s), whereas 'default' represents all policy state(s). x-ms-parameter-location: method timeRange: description: Filter by time range by below listed values. Default value is 1 day. name: timeRange type: string in: query required: false x-ms-parameter-location: method enum: - 1h - 1d - 7d - 30d x-ms-enum: name: TimeRange modelAsString: true topParameter: name: $top in: query required: false type: integer format: int32 minimum: 0 description: Maximum number of records to return. x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Top scope: name: scope description: scope here is resourceId for which alert is created. type: string in: path required: true x-ms-skip-url-encoding: true x-ms-parameter-location: method ApiVersionParameter_7: name: api-version in: query required: true type: string description: API version. customTimeRange: description: Filter by custom time range in the format / where time is in (ISO-8601 format)'. Permissible values is within 30 days from query time. Either timeRange or customTimeRange could be used but not both. Default is none. name: customTimeRange type: string in: query required: false x-ms-parameter-location: method LocationParameter: name: location in: path required: true type: string description: The provider location x-ms-parameter-location: method ApiVersionParameter_2: name: api-version in: query required: true type: string description: Client Api Version. selectParameter: name: $select in: query required: false type: string description: Select expression using OData notation. Limits the columns on each record to just those requested, e.g. "$select=PolicyAssignmentId, ResourceId". x-ms-parameter-location: method x-ms-parameter-grouping: name: QueryOptions x-ms-client-name: Select includeSmartGroupsCount: description: Include count of the SmartGroups as part of the summary. Default value is 'false'. name: includeSmartGroupsCount type: boolean in: query required: false x-ms-parameter-location: method filter: name: $filter in: query required: false type: string description: OData filter expression. x-ms-parameter-location: method x-ms-client-name: Filter resourceNameParameter: name: resourceName in: path required: true type: string description: The name of the policy metadata resource. x-ms-parameter-location: method x-ms-skip-url-encoding: true apiVersionParameter: name: api-version in: query description: The version of the API to be used with the client request. required: true type: string monitorCondition: description: Filter by monitor condition which is either 'Fired' or 'Resolved'. Default value is to select all. name: monitorCondition type: string in: query required: false x-ms-parameter-location: method enum: - Fired - Resolved x-ms-enum: name: MonitorCondition modelAsString: true includeEgressConfig: description: Include egress config which would be used for displaying the content in portal. Default value is 'false'. name: includeEgressConfig type: boolean in: query required: false x-ms-parameter-location: method x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'